Update kubernetes templates and README instructions

Signed-off-by: Andres Tobon <andrest2455@gmail.com>

Author: andrest50

charts/lfx-v2-project-service/templates/deployment.yaml

@@ -21,7 +21,7 @@ spec:
           image: linuxfoundation/lfx-v2-project-service:0.1.0
           securityContext:
             allowPrivilegeEscalation: false
-          imagePullPolicy: Never  # todo: fix this
+          imagePullPolicy: Never  # The image is expected to exist locally with the same name and tag. It is not deployed to a registry.
           env:
             - name: NATS_URL
               value: {{.Values.nats.url}}

charts/lfx-v2-project-service/templates/ingressroute.yaml

@@ -13,10 +13,11 @@ spec:
   routes:
     - kind: Rule
       match: >-
-        Host(`lfx-api.k8s.orb.local`) && PathPrefix(`/query/`)
+        Host(`lfx-api.k8s.orb.local`)
       priority: 10
-      middlewares:
-        - name: heimdall
+      # TODO: add heimdall middleware once it is working - currently it causes a 403
+      # middlewares:
+      #   - name: heimdall
       services:
         - kind: Service
           name: lfx-v2-project-service

charts/lfx-v2-project-service/templates/nats-kv-bucket.yaml

@@ -0,0 +1,14 @@
+# Copyright The Linux Foundation and each contributor to LFX.
+# SPDX-License-Identifier: MIT
+---
+apiVersion: jetstream.nats.io/v1beta2
+kind: KeyValue
+metadata:
+  name: projects
+  namespace: lfx
+spec:
+  bucket: projects
+  history: 20
+  storage: file
+  maxBytes: 2048
+  compression: true

charts/lfx-v2-project-service/templates/ruleset.yaml

@@ -18,9 +18,6 @@ spec:
         routes:
           - path: /projects
           - path: /projects/:id
-            path_params:
-              - name: id
-                type: string
       execute:
         - authenticator: authelia
         - authenticator: anonymous_authenticator

charts/lfx-v2-project-service/values.yaml

@@ -5,3 +5,4 @@
 nats:
   # url is the URL of the NATS server
   url: nats://nats.lfx.svc.cluster.local:4222
+  projects_kv_bucket_name: projects

cmd/project-api/README.md

@@ -43,9 +43,13 @@ This service handles the following NATS subjects:
 
 ### Prerequisites
 
-This service uses the [GOA Framework](https://goa.design/) for API generation. You'll need to install GOA before building the service.
+- [**Go**](https://go.dev/): the service is built with the Go programming language [[Install](https://go.dev/doc/install)]
+- [**Kubernetes**](https://kubernetes.io/): used for deployment of resources [[Install](https://kubernetes.io/releases/download/)]
+- [**Helm**](https://helm.sh/): used to manage kubernetes applications [[Install](https://helm.sh/docs/intro/install/)]
+- [**NATS**](https://docs.nats.io/): used to communicate with other LFX V2 services [[Install](https://docs.nats.io/running-a-nats-service/introduction/installation)]
+- [**GOA Framework**](https://goa.design/): used for API code generation
 
-#### Installing GOA Framework
+#### GOA Framework
 
 Follow the [GOA installation guide](https://goa.design/docs/2-getting-started/1-installation/) to install GOA:
 
@@ -77,31 +81,88 @@ This command generates:
 - Service interfaces and types
 - Transport layer implementations
 
-#### 2. Development Workflow
+#### 2. Set up resources and external services
+
+The service relies on some resources and external services being spun up prior to running this service.
+
+- [NATS service](https://docs.nats.io/): ensure you have a NATS server instance running and set the `NATS_URL` environment variable with the URL of the server
+
+    ```bash
+    export NATS_URL=nats://nats.lfx.svc.cluster.local:4222
+    ```
+
+- [NATS key-value bucket](https://docs.nats.io/nats-concepts/jetstream/key-value-store): once you have a NATS service running, you need to create a bucket used by the project service.
+
+    ```bash
+    # if using the nats cli tool
+    nats kv add projects
+    ```
+
+#### 3. Export environment variables
+
+|Environment Variable Name|Description|Default|Required|
+|-----------------------|--------------------|-----------|-----|
+|PORT|the port for http requests to the project service API|8080|false|
+|NATS_URL|the URL of the nats server instance|nats://localhost:4222|false|
+|LFX_ENVIRONMENT|the LFX environment (enum: prod, stg, dev)|dev|false|
+|LOG_LEVEL|the log level for outputted logs|info|false|
+|LOG_ADD_SOURCE|whether to add the source field to outputted logs|false|false|
+
+#### 4. Development Workflow
 
 1. **Make design or implementation changes**: Edit files in the `design/` directory for design changes, and edit the other files for implementation changes.
+
 2. **Regenerate code**: Run `make apigen` after design changes
+
 3. **Build the service**:
    ```bash
    make build
    ```
-4. **Run the service** (for development):
+4. **Run the service**:
    ```bash
    make run
 
-   # enable debug logging
+   # or run with debug logs enabled
    make debug
+
+   # or run with the go command to set custom flags
+   # -bind string   interface to bind on (default "*")
+   # -d	         enable debug logging (default false)
+   # -p    string   listen port (default "8080")
+   go run
    ```
 5. **Run tests**:
    ```bash
    make test
+
+   # or run go test to set custom flags
+   go test . -v
    ```
 
+6. **Docker build + K8**
+
+    ```bash
+    # Build the dockerfile (from the root of the repo)
+    docker build -t lfx-v2-project-service:<release_number> .
+
+    # Install the helm chart for the service into the lfx namespace (from the root of the repo)
+    helm install lfx-v2-project-service ./charts/lfx-v2-project-service/ -n lfx
+
+    # Once you have already installed the helm chart and need to just update it, use the following command (from the root of the repo):
+    helm upgrade lfx-v2-project-service ./charts/lfx-v2-project-service/ -n lfx
+
+    # Check that the REST API is accessible by hitting the `/livez` endpoint (you should get a response of OK if it is working):
+    #
+    # Note: replace the hostname with the host from ./charts/lfx-v2-project-service/ingressroute.yaml
+    curl http://lfx-api.k8s.orb.local/livez
+    ```
+
 ### Add new API endpoints
 Note: follow the [Development Workflow](#2-development-workflow) section on how to run the service code
 1. **Update design files**: Edit project file in `design/` to include specicification of the new endpoint with all of its supported parameters, responses, and errors, etc.
 2. **Regenerate code**: Run `make apigen` after design changes
 3. **Implement code**: Implement the new endpoint in `service_endpoint.go`. Follow similar standards of the other endpoint methods. Include tests for the new endpoint in `service_endpoint_test.go`.
+4. **Update heimdall ruleset**: Ensure that `/charts/lfx-v2-project-service/templates/ruleset.yaml` has the route and method for the endpoint set so that authentication is configured when deployed
 
 ### Add new message handlers
 Note: follow the [Development Workflow](#2-development-workflow) section on how to run the service code