Merge pull request #291 from sandesvitor/feat/include_api_client_services

Allow "external" st2api, st2auth, and st2stream Services (LoadBalancer type with hostname)

Author: cognifloyd

CHANGELOG.md

@@ -6,6 +6,7 @@
 * New feature: Add `extra_volumes` to all python-based st2 deployments. This can facilitate changing log levels by loading logging conf file(s) from a custom ConfigMap. (#276) (by @cognifloyd)
 * Initialize basic unittest infrastructure using `helm-unittest`. Added tests for labels, custom annotations, SecurityContext, pullSecrets, pullPolicy, Resources, nodeSelector, tolerations, affinity, dnsPolicy, dnsConfig, ServiceAccount attach, postStartScript, and both sensor-modes. (#284, #288)
 * Allow partitioning sensors using the hash_range strategy instead of one sensor per pod. (#218) (by @cognifloyd)
+* New feature to include possibility for external services in st2api, st2stream and st2auth, setting default value for this services as `ClusterIP` and `hostname: ""`. Also, added new entry for custom_annotations_test.yaml and created new unit test services_test.yaml. (by @sandesvitor)
 
 ## v0.80.0
 * Switch st2 to `v3.6` as a new default stable version (#274)

templates/services.yaml

@@ -5,6 +5,12 @@ metadata:
   name: {{ .Release.Name }}-st2auth
   annotations:
     description: StackStorm st2auth - all authentication is managed by this service.
+    {{- if .Values.st2auth.service.hostname }}
+    external-dns.alpha.kubernetes.io/hostname: {{ .Values.st2auth.service.hostname | quote }}
+    {{- end }}
+    {{- if .Values.st2auth.service.annotations }}
+      {{- toYaml .Values.st2auth.service.annotations | nindent 4 }}
+    {{- end }}
   labels:
     app: st2auth
     tier: backend
@@ -16,7 +22,12 @@ spec:
   selector:
     app: st2auth
     release: {{ .Release.Name }}
-  type: ClusterIP
+  type: {{ .Values.st2auth.service.type }}
+  {{- if contains "ExternalName" .Values.st2auth.service.type }}
+  {{- if .Values.st2auth.service.hostname }}
+  externalName: {{ .Values.st2auth.service.hostname }}
+  {{- end }}
+  {{- end }}
   ports:
   - protocol: TCP
     port: 9100
@@ -28,6 +39,12 @@ metadata:
   name: {{ .Release.Name }}-st2api
   annotations:
     description: StackStorm st2api - service hosts the REST API endpoints that serve requests from WebUI, CLI, ChatOps and other st2 services.
+    {{- if .Values.st2api.service.hostname }}
+    external-dns.alpha.kubernetes.io/hostname: {{ .Values.st2api.service.hostname | quote }}
+    {{- end }}
+    {{- if .Values.st2api.service.annotations }}
+      {{- toYaml .Values.st2api.service.annotations | nindent 4 }}
+    {{- end }}
   labels:
     app: st2api
     tier: backend
@@ -39,7 +56,12 @@ spec:
   selector:
     app: st2api
     release: {{ .Release.Name }}
-  type: ClusterIP
+  type: {{ .Values.st2api.service.type }}
+  {{- if contains "ExternalName" .Values.st2api.service.type }}
+  {{- if .Values.st2api.service.hostname }}
+  externalName: {{ .Values.st2api.service.hostname }}
+  {{- end }}
+  {{- end }}
   ports:
   - protocol: TCP
     port: 9101
@@ -51,6 +73,12 @@ metadata:
   name: {{ .Release.Name }}-st2stream
   annotations:
     description: StackStorm st2stream - exposes a server-sent event stream, used by the clients like WebUI and ChatOps to receive update from the st2stream server.
+    {{- if .Values.st2stream.service.hostname }}
+    external-dns.alpha.kubernetes.io/hostname: {{ .Values.st2stream.service.hostname | quote }}
+    {{- end }}
+    {{- if .Values.st2stream.service.annotations }}
+      {{- toYaml .Values.st2stream.service.annotations | nindent 4 }}
+    {{- end }}
   labels:
     app: st2stream
     tier: backend
@@ -62,7 +90,12 @@ spec:
   selector:
     app: st2stream
     release: {{ .Release.Name }}
-  type: ClusterIP
+  type: {{ .Values.st2stream.service.type }}
+  {{- if contains "ExternalName" .Values.st2stream.service.type }}
+  {{- if .Values.st2stream.service.hostname }}
+  externalName: {{ .Values.st2stream.service.hostname }}
+  {{- end }}
+  {{- end }}
   ports:
   - protocol: TCP
     port: 9102

tests/unit/custom_annotations_test.yaml

@@ -52,14 +52,27 @@ tests:
 
   # st2auth, st2api, st2stream services do not accept custom annotations
 
-  - it: st2web Service accepts custom annotations
+  - it: st2web, st2auth, st2api and st2stream Services accept custom annotations
     template: services.yaml
-    documentIndex: 3
     set:
       st2web:
         service:
           hostname: some-host-name
           annotations: *annotations
+      st2api:
+        service:
+          hostname: some-host-name
+          annotations: *annotations
+      st2auth:
+        service:
+          hostname: some-host-name
+          annotations: *annotations
+      st2stream:
+        service:
+          hostname: some-host-name
+          annotations: *annotations
+      st2chatops:
+        enabled: false # exclude st2chatops to only test other services
     asserts: *annotations_asserts
 
   # st2chatops service does not accept custom annotations

tests/unit/services_test.yaml

@@ -0,0 +1,47 @@
+---
+suite: Services
+templates:
+  # primary template files
+  - services.yaml
+
+tests:
+  - it: st2web, st2auth, st2api, st2stream should work without externalName
+    set:
+      st2chatops:
+        enabled: false 
+    asserts:
+      - hasDocuments:
+          count: 4
+      - isNull:
+          path: spec.externalName
+  
+  - it: st2web, st2auth, st2api, st2stream should work with externalName if type is ExternalName
+    set:
+      st2web:
+        service:
+          hostname: some-host-name
+          type: ExternalName
+      st2auth:
+        service:
+          hostname: some-host-name
+          type: ExternalName
+      st2api:
+        service:
+          hostname: some-host-name
+          type: ExternalName
+      st2stream:
+        service:
+          hostname: some-host-name
+          type: ExternalName
+      st2chatops:
+        enabled: false 
+    asserts:
+      - hasDocuments:
+          count: 4
+      - equal:
+          path: spec.type
+          value: ExternalName
+      - equal:
+          path: spec.externalName
+          value: some-host-name
+

values.yaml

@@ -348,6 +348,14 @@ st2auth:
   affinity: {}
   env: {}
   # HTTP_PROXY: http://proxy:1234
+  service:
+    # type can be one of "ClusterIP", "NodePort", "LoadBalancer" or "ExternalName"
+    type: "ClusterIP"
+    # The hostname associated with st2auth service (externalName, added to external DNS, etc.)
+    hostname: ""
+    # For more information regarding annotations, see
+    # https://kubernetes.io/docs/concepts/services-networking/service/#ssl-support-on-aws
+    annotations: {}
   serviceAccount:
     attach: false
   # postStartScript is optional. It has the contents of a bash script.
@@ -378,6 +386,14 @@ st2api:
   tolerations: []
   affinity: {}
   env: {}
+  service:
+    # type can be one of "ClusterIP", "NodePort", "LoadBalancer" or "ExternalName"
+    type: "ClusterIP"
+    # The hostname associated with st2api service (externalName, added to external DNS, etc.)
+    hostname: ""
+    # For more information regarding annotations, see
+    # https://kubernetes.io/docs/concepts/services-networking/service/#ssl-support-on-aws
+    annotations: {}
   # HTTP_PROXY: http://proxy:1234
   serviceAccount:
     attach: false
@@ -410,6 +426,14 @@ st2stream:
   affinity: {}
   env: {}
   # HTTP_PROXY: http://proxy:1234
+  service:
+    # type can be one of "ClusterIP", "NodePort", "LoadBalancer" or "ExternalName"
+    type: "ClusterIP"
+    # The hostname associated with st2api service (externalName, added to external DNS, etc.)
+    hostname: ""
+    # For more information regarding annotations, see
+    # https://kubernetes.io/docs/concepts/services-networking/service/#ssl-support-on-aws
+    annotations: {}
   serviceAccount:
     attach: false
   # postStartScript is optional. It has the contents of a bash script.