refactor: Rework object names and working ws connections

Author: Alan Christie

README.md

@@ -85,15 +85,21 @@ accidental commits as it's in the project's `.gitignore` file: -
 Then, when you have set your variables, identify your **KUBECONFIG** file,
 and run the playbook: -
 
-    export KUBECONFIG=<path-to-your-kubeconfig>
+    export KUBECONFIG=~/k8s-config/nw-xch-dev.yaml
     ansible-playbook site.yaml -e @parameters.yaml
 
 Once deployed the application's internal API will be behind the service
-`ess-internal-api` on port `8001`. The Account Server will be able to
-manage event streams via the URL `http://ess-internal-api:8001/event-stream/`.
+`ess-internal-api` on port `8081`, and available to any application running in the
+cluster. The Account Server will be able to manage event streams via the URL
+`http://ess-internal-api:8081/event-stream/`.
+
+The external web-socket service will be available on the ingress host you've specified,
+as either a `ws://` or `wss://` service, depending on the ingress configuration. If
+the host is `example.com` you should be able to connect to unsecure web sockets using
+the URL `ws://example.com/event-stream/{uuid}`.
 
 To update the running image (to deploy a new tagged version) just re-run the
-playbook with the a suitable value for `ess_image_tag`.
+playbook with a suitable value for `ess_image_tag`.
 
 To remove the application run the playbook again, but set the `ess_state` variable
 to `absent`: -

ansible/roles/app/defaults/main.yaml

@@ -38,7 +38,7 @@ ess_pull_policy_always: IfNotPresent
 ess_shared_volume_volume_storageclass: ' '
 
 # Pod resource requests and limits
-ess_api_cpu_request: 500m
-ess_api_cpu_limit: 1
-ess_api_mem_request: 1G
-ess_api_mem_limit: 1Gi
+ess_api_cpu_request: 100m
+ess_api_cpu_limit:
+ess_api_mem_request: 256Mi
+ess_api_mem_limit: 256Mi

ansible/roles/app/tasks/deploy.yaml

@@ -53,7 +53,7 @@
   loop:
   - deployment
   - service-internal
-  - service-public
+  - service-ws
 
 - name: Deploy ingress ({{ ess_namespace }})
   kubernetes.core.k8s:

ansible/roles/app/tasks/undeploy.yaml

@@ -7,7 +7,7 @@
     state: absent
   loop:
   - ingress
-  - service-public
+  - service-ws
   - service-internal
   - deployment
   - pvc

ansible/roles/app/templates/deployment.yaml.j2

@@ -7,10 +7,7 @@ metadata:
 spec:
   replicas: 1
   strategy:
-    type: RollingUpdate
-    rollingUpdate:
-      maxSurge: 1
-      maxUnavailable: 0
+    type: Recreate
   selector:
     matchLabels:
       name: ess
@@ -81,22 +78,24 @@ spec:
         # a roll-out will not occur if the tag has not changed.
         - name: CICD_TRIGGER_ID
           value: '{{ ansible_date_time.iso8601_micro }}'
+        startupProbe:
+          httpGet:
+            path: /event-stream
+            port: internal
+          failureThreshold: 60
+          periodSeconds: 5
         readinessProbe:
-          tcpSocket:
-            port: 8081
-          initialDelaySeconds: 10
-          timeoutSeconds: 3
-          periodSeconds: 10
-          successThreshold: 1
-          failureThreshold: 10
+          httpGet:
+            path: /event-stream
+            port: internal
+          initialDelaySeconds: 5
+          periodSeconds: 5
         livenessProbe:
-          tcpSocket:
-            port: 8081
-          initialDelaySeconds: 20
-          timeoutSeconds: 3
-          periodSeconds: 10
-          successThreshold: 1
-          failureThreshold: 3
+          httpGet:
+            path: /event-stream
+            port: internal
+          initialDelaySeconds: 5
+          periodSeconds: 5
         resources:
           requests:
             cpu: {{ ess_api_cpu_request }}

ansible/roles/app/templates/ingress.yaml.j2

@@ -2,9 +2,12 @@
 kind: Ingress
 apiVersion: networking.k8s.io/v1
 metadata:
-  name: ess
+  name: ess-ws
   namespace: {{ ess_namespace }}
   annotations:
+    nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600"
+    nginx.ingress.kubernetes.io/proxy-send-timeout: "3600"
+    nginx.ingress.kubernetes.io/proxy-read-timeout: "3600"
 {% if ess_cert_issuer %}
     cert-manager.io/cluster-issuer: "{{ ess_cert_manager_issuer_base|lower }}-{{ ess_cert_issuer|lower }}"
 {% endif %}
@@ -24,6 +27,6 @@ spec:
         pathType: Prefix
         backend:
           service:
-            name: ess-public
+            name: ess-ws
             port:
               name: ws

…les/app/templates/service-public.yaml.j2 …e/roles/app/templates/service-ws.yaml.j2ansible/roles/app/templates/service-public.yaml.j2 renamed to ansible/roles/app/templates/service-ws.yaml.j2 ansible/roles/app/templates/service-public.yaml.j2 renamed to ansible/roles/app/templates/service-ws.yaml.j2

@@ -2,10 +2,10 @@
 kind: Service
 apiVersion: v1
 metadata:
-  name: ess-public
+  name: ess-ws
   namespace: {{ ess_namespace }}
   labels:
-    name: ess-public
+    name: ess-ws
 spec:
   selector:
     name: ess

ansible/roles/app/vars/main.yaml

@@ -8,7 +8,8 @@ ess_ingress_class: nginx
 # and 'letsencrypt-nginx-production'
 ess_cert_manager_issuer_base: letsencrypt-{{ ess_ingress_class }}
 # SSL certificate issuer?
-ess_cert_issuer: ''
+# One of 'production', 'staging' or blank (for no SSL).
+ess_cert_issuer:
 
-ess_priority_class: ''
+ess_priority_class:
 ess_api_termination_grace_period_seconds: 30

simple_es_publisher.py

@@ -16,6 +16,10 @@
     OperationEnum,
 )
 
+if len(sys.argv) != 2:
+    print("Usage: simple_es_publisher.py <routing-key>")
+    sys.exit(1)
+
 _ROUTING_KEY: str = sys.argv[1]
 
 _AMPQ_EXCHANGE: str = "event-streams"

simple_es_subscriber.py

@@ -8,6 +8,10 @@
 
 from simple_websocket import AioClient, ConnectionClosed
 
+if len(sys.argv) != 2:
+    print("Usage: simple_es_subscriber.py <location>")
+    sys.exit(1)
+
 _LOCATION: str = sys.argv[1]