Restapi 956 add docs to kong yml k8s and demo for api spec

Author: aledabin

.gitlab-ci.yml

@@ -28,7 +28,7 @@ build_images:
     - unzip vault_1.11.0_linux_amd64.zip
     - export PATH=$PATH:$(pwd)
     - export VAULT_ADDR="$CI_VAULT_ADDR"
-    
+
     - mkdir -p /kaniko/.docker
     - echo '{"auths":{"'$CI_REGISTRY'":{"username":"'$CI_REGISTRY_USER'","password":"'$CI_REGISTRY_PASSWORD'"}}}' > /kaniko/.docker/config.json
     - |
@@ -85,19 +85,22 @@ deploy_dev:
     - helm list -n ${CI_NAMESPACE_DEV} --kube-token=${CI_K8S_TOKEN}
 
     - cd deploy/k8s
-    
+
     - |
       ## adding at the end of values-dev.yaml on global section
       echo -e "\n  registry: ${CI_REGISTRY_PREFIX}\n  tag: '${CI_COMMIT_SHORT_SHA}' \n  namespace: ${CI_NAMESPACE_DEV}\n" >> values-dev.yaml
-      
+
+      # link API specification inside chart
+      ln -s ../../../../doc/openapi/firecrest-api.yaml openapi/files/firecrest-api.yaml
+
       for app in config certificator compute jaeger keycloak kong minio openapi reservations status storage tasks utilities; do
         helm uninstall -n ${CI_NAMESPACE_DEV} --kube-token=${CI_K8S_TOKEN} "$app" || true
         helm install --wait --wait-for-jobs --timeout 240s -n ${CI_NAMESPACE_DEV} -f values-dev.yaml --kube-token=${CI_K8S_TOKEN} "$app" $app;
       done
     # Cluster is deployed separatelly ALWAYS with tag = latest
     - |
       echo -e "global:\n  registry: ${CI_REGISTRY_PREFIX}\n  tag: latest\n  namespace: ${CI_NAMESPACE_DEV}\n" > values-cluster-dev.yaml;
-      
+
       helm uninstall -n ${CI_NAMESPACE_DEV} --kube-token=${CI_K8S_TOKEN} cluster || true;
       helm install --wait --wait-for-jobs --timeout 180s -n ${CI_NAMESPACE_DEV} -f values-cluster-dev.yaml --kube-token=${CI_K8S_TOKEN} cluster cluster;
 
@@ -125,11 +128,8 @@ deploy_dev:
         while :
         do
             sleep 20s;
-
             tester_pod=$(kubectl get pods --selector=job-name=job-tester -n ${CI_NAMESPACE_DEV} --token="${CI_K8S_TOKEN}" --output=jsonpath='{.items[*].metadata.name}');
-
             echo "Tester pod is: $tester_pod";
-
             pdstatus=$(kubectl get pods -n ${CI_NAMESPACE_DEV} --token="${CI_K8S_TOKEN}" $tester_pod -o jsonpath="{.status.phase}");
 
             if [ "$pdstatus" = "Running" ] || [ "$pdstatus" = "Pending" ]; then
@@ -272,12 +272,12 @@ tag_release:
 
               echo "Tagging image ${CI_REGISTRY_GROUP}/$img/$tag"
               jfrog rt copy --flat=true --url="https://${CI_REGISTRY}/artifactory" --user="${CI_REGISTRY_USER}" --password="${CI_REGISTRY_PASSWORD}" "${CI_REGISTRY_GROUP}/$img/${CI_COMMIT_SHORT_SHA}/" "${CI_REGISTRY_GROUP}/$img/$tag/";
-              
+
               if [ "$code_tag" == "prod" && "$tag" != "prod" && "$img" != "reservations" ]; then
                 # if code_tag indicates prod and tag is 'v1...', also publish to GitHub
                 crane copy ${CI_REGISTRY_PREFIX}/${img}:${tag} ghcr.io/eth-cscs/firecrest/f7t-${img}:${tag}
               fi
-                
+
             done
           done
 
@@ -288,7 +288,7 @@ tag_release:
               helm package --version=$CI_COMMIT_TAG --app-version=$CI_COMMIT_TAG deploy/k8s/$img
 
               file=$(find . -iname "$img-*.tgz" -print -maxdepth 1)
-              
+
               sha1=`sha1sum $file | awk '{print $1}'`
               sha256=`sha256sum $file | awk '{print $1}'`
               md5=`md5sum $file | awk '{print $1}'`

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - CI/CD pipeline is now adapted to create helm charts images and push to a repository when TDS or Prod are tagged
   - Also secrets now can be managed from ExternalSecrets on K8s deployment
   - Deployment on TDS triggers ArgoCD deployment
+- Demo and k8s deployments have the Swagger UI API specification at unauthenticated `/docs` endpoint
 
 ## [1.13.1]
 

deploy/demo/README.md

@@ -1,6 +1,6 @@
 # FirecREST demo
 
-This demo uses [Docker Compose](https://docs.docker.com/compose/install/) to setup containers for FirecREST microservices, a template client, Keycloak, Kong, Redis, Minio and a dummy cluster with Slurm.
+This demo uses [Docker Compose](https://docs.docker.com/compose/install/) to setup containers for FirecREST microservices, a template client, Keycloak, Kong, Redis, Minio and a dummy cluster with Slurm. It should also work with Podman and [Podman Compose](https://github.com/containers/podman-compose) for a rootless setup.
 
 ## Quick start
 
@@ -19,7 +19,9 @@ To start containers:
 
 `docker-compose up`
 
-Then, go to `http://localhost:7000`  User is `test1` and password is `test11`
+The web client is available at `http://localhost:7000`  User is `test1` and password is `test11`
+
+The API is at `http://localhost:8000` and the specification is at `http://localhost:8000/docs`
 
 
 To stop all containers:

deploy/demo/docker-compose.yml

@@ -103,7 +103,6 @@ services:
       F7T_S3_REGION: us-east-1
       F7T_STORAGE_POLLING_INTERVAL: 60
       F7T_CERT_CIPHER_KEY: 'Df6UZuoPoJ2u5yRwxNfFQ46Nwy8eW1OGTcuhlqn4ONo='
-      #debug: "True"
     networks:
       firecrest-internal:
         ipv4_address: 192.168.220.5
@@ -124,7 +123,6 @@ services:
     environment:
       - F7T_PERSIST_PORT=6379
       - F7T_PERSIST_PWD=rediS2200
-      - F7T_DEBUG_MODE=True
       - F7T_COMPUTE_TASK_EXP_TIME=86400
       - F7T_STORAGE_TASK_EXP_TIME=2678400
     depends_on:
@@ -226,7 +224,7 @@ services:
       - ./logs/keycloak:/opt/jboss/keycloak/standalone/log/:delegated
 
   kong:
-    image: kong:2.5.0
+    image: kong:2.8.4
     container_name: kong
     environment:
       - KONG_DATABASE=off
@@ -281,12 +279,14 @@ services:
       - ./ssl:/ssl
 
   openapi:
-    image: swaggerapi/swagger-ui:v3.47.1
+    image: swaggerapi/swagger-ui:v4.19.1
     container_name: openapi
-    ports:
-      - "9090:8080"
+    networks:
+      firecrest-internal:
+        ipv4_address: 192.168.220.41
     environment:
       SWAGGER_JSON: /tmp/firecrest-api.yaml
+      BASE_URL: /docs
     volumes:
       - ../../doc/openapi/:/tmp/
 

deploy/demo/kong/kong.yml

@@ -47,6 +47,8 @@ plugins:
 consumers:
 - username: firecrest
   custom_id: firecrest
+- username: docs
+  custom_id: docs
 
 jwt_secrets:
 - consumer: firecrest
@@ -69,6 +71,18 @@ services:
     methods: [DELETE,GET,POST]
     paths:
     - /compute/
+- name: docs
+  url: http://192.168.220.41:8080
+  routes:
+  - name: docs
+    methods: [GET]
+    paths:
+      - /docs
+    strip_path: false
+    plugins:
+    - name: jwt
+      config:
+        anonymous: docs
 - name: status
   url: https://192.168.220.4:5001
   routes:

deploy/k8s/README.md

@@ -0,0 +1,6 @@
+# Kubernetes deployment with Helm
+
+## Before deploying
+Helm only allows to include files inside the chart directory. To install the 'openapi' chart (SwaggerUI) it is required to make symlink to the OpenAPI specification
+
+`ln -s ../../../../doc/openapi/firecrest-api.yaml openapi/files/firecrest-api.yaml`