docs: enterprise docs (#23)

* enterprise docs * update enterprise docs * doc updates * more updates * doc polishes * doc polishes * update chart readmes * update chart readmes * bump charts * bump charts
kubeshop · Jun 22, 2023 · 03a92a1 · 03a92a1
1 parent 2b928b2
commit 03a92a1
Show file tree

Hide file tree

Showing 19 changed files with 489 additions and 54 deletions.
diff --git a/.github/workflows/release-main.yaml b/.github/workflows/release-main.yaml
@@ -33,11 +33,17 @@ jobs:
 
       - name: Sync & Update Testkube Enterprise Helm chart
         run: |
+          bump_strategy="patch"
+          changed=$(git status --porcelain charts/testkube-enterprise | wc -l)
+          if [ $changed -gt 0 ]; then
+            bump_strategy="none"
+          fi
+          
           echo "Syncing subchart versions in testkube-enterprise Helm chart"
           ./scripts/sync.sh
           
-          echo "Updating testkube-enterprise Helm chart version"
-          ./scripts/update.sh -c testkube-enterprise -s minor --verbose
+          echo "Updating testkube-enterprise Helm chart version with bump strategy: $bump_strategy"
+          ./scripts/update.sh -c testkube-enterprise -s $bump_strategy --verbose
           
           enterprise_chart_version=$(./scripts/update.sh -c testkube-enterprise --print-chart-version)
           echo "ENTERPRISE_CHART_VERSION=$enterprise_chart_version" >> $GITHUB_ENV

diff --git a/charts/testkube-cloud-api/Chart.yaml b/charts/testkube-cloud-api/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: testkube-cloud-api
 description: A Helm chart for Testkube Cloud API
 type: application
-version: 1.6.8
+version: 1.7.0
 appVersion: 1.2.0-dev-39ae202
 maintainers:
   - name: testkube

diff --git a/charts/testkube-cloud-api/README.md b/charts/testkube-cloud-api/README.md
@@ -1,6 +1,6 @@
 # testkube-cloud-api
 
-![Version: 1.6.3](https://img.shields.io/badge/Version-1.6.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.2.0-dev-ba71c83](https://img.shields.io/badge/AppVersion-1.2.0--dev--ba71c83-informational?style=flat-square)
+![Version: 1.7.0](https://img.shields.io/badge/Version-1.7.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.2.0-dev-39ae202](https://img.shields.io/badge/AppVersion-1.2.0--dev--39ae202-informational?style=flat-square)
 
 A Helm chart for Testkube Cloud API
 
@@ -30,6 +30,7 @@ A Helm chart for Testkube Cloud API
 | api.agent.port | string | `"443"` | Agent port |
 | api.apiAddress | string | `""` | API address (used in invitation emails) (example `https://api.testkube.xyz`) |
 | api.dashboardAddress | string | `""` | Dashboard address (used in invitation emails) (example `https://cloud.testkube.xyz`) |
+| api.inviteMode | string | `"email"` | Configure which invitation mode to use (email|auto-accept): email uses SMTP protocol to send email invites and auto-accept immediately adds them |
 | api.migrations.enabled | bool | `false` | Toggle whether to apply migrations for MongoDB |
 | api.migrations.image.repository | string | `"kubeshop/testkube-cloud-api-migrations"` |  |
 | api.migrations.useHelmHooks | bool | `true` | Toggle whether to enable pre-install & pre-upgrade hooks |
@@ -55,6 +56,11 @@ A Helm chart for Testkube Cloud API
 | api.outputsBucket | string | `"testkube-cloud-outputs"` | S3 bucket in which outputs are stored |
 | api.sendgrid.apiKey | string | `""` | Sendgrid API key |
 | api.sendgrid.secretRef | string | `""` | Secret API key secret ref (secret must contain key SENDGRID_API_KEY) (default is `sendgrid-api-key`) |
+| api.smtp.host | string | `"smtp.sendgrid.net"` | SMTP host |
+| api.smtp.password | string | `""` | SMTP password |
+| api.smtp.passwordSecretRef | string | `""` | SMTP secret ref (secret must contain key SMTP_PASSWORD), overrides password field if defined |
+| api.smtp.port | int | `587` | SMTP port |
+| api.smtp.username | string | `""` | SMTP username |
 | api.tls.agentPort | int | `8443` | Agent gRPCS port |
 | api.tls.apiPort | int | `9443` | API HTTPS port |
 | api.tls.certManager.issuerGroup | string | `"cert-manager.io"` | Certificate Issuer group (only used if `provider` is set to `cert-manager`) |
@@ -71,14 +77,16 @@ A Helm chart for Testkube Cloud API
 | fullnameOverride | string | `""` |  |
 | global.certManager.issuerRef | string | `""` | Certificate Issuer ref (only used if `provider` is set to `cert-manager`) |
 | global.certificateProvider | string | `""` | TLS provider (possible values: "", "cert-manager") |
+| global.dex.issuerUrl | string | `""` | Global Dex issuer url |
 | global.domain | string | `""` | Domain under which to create Ingress rules |
 | global.enterpriseLicenseFile | string | `""` | Base64-encoded Enterprise License file |
-| global.enterpriseLicenseFileSecretRef | string | `""` | Enterprise License file secret ref (secret should contain a file called 'license.lic') |
 | global.enterpriseLicenseKey | string | `""` | Enterprise License key |
+| global.enterpriseLicenseSecretRef | string | `""` | Enterprise License file secret ref (secret should contain a file called 'license.lic') |
 | global.enterpriseMode | bool | `false` | Toggle whether UI is installed in Enterprise mode |
 | global.enterpriseOfflineAccess | bool | `false` | Toggle whether to enable offline license activation in Enterprise mode |
 | global.grpcApiSubdomain | string | `"agent"` | gRPC API subdomain which get prepended to the domain |
 | global.imagePullSecrets | list | `[]` | Global image pull secrets (provided usually by a parent chart like testkube-enterprise) |
+| global.ingress.enabled | bool | `true` | Toggle whether to enable or disable all Ingress resources (if false, all Ingress resources will be disabled and cannot be overriden) |
 | global.restApiSubdomain | string | `"api"` | REST API subdomain which get prepended to the domain |
 | global.uiSubdomain | string | `"cloud"` | UI subdomain which get prepended to the domain |
 | global.websocketApiSubdomain | string | `"websockets"` | Websocket API subdomain which get prepended to the domain |

diff --git a/charts/testkube-cloud-api/templates/deployment.yaml b/charts/testkube-cloud-api/templates/deployment.yaml
@@ -43,13 +43,39 @@ spec:
             - name: ENTERPRISE_OFFLINE_ACTIVATION
               value: "{{ .Values.global.enterpriseOfflineAccess }}"
             {{- end }}
-            {{- if .Values.global.enterpriseLicenseKey }}
+            {{- if .Values.global.enterpriseMode }}
             - name: ENTERPRISE_LICENSE_KEY
+              {{- if .Values.global.enterpriseLicenseSecretRef }}
+              valueFrom:
+                secretKeyRef:
+                  key: LICENSE_KEY
+                  name: {{ .Values.global.enterpriseLicenseSecretRef }}
+              {{- else }}
               value: "{{ .Values.global.enterpriseLicenseKey }}"
+              {{- end }}
             {{- end }}
             {{- if .Values.global.enterpriseLicenseFile }}
-            - name: ENTERPRISE_LICENSE_KEY
-              value: "{{ .Values.global.enterpriseLicenseKey }}"
+            - name: ENTERPRISE_LICENSE_FILE
+              value: "{{ .Values.global.enterpriseLicenseFile }}"
+            {{- end }}
+            - name: INVITE_MODE
+              value: "{{ .Values.api.inviteMode }}"
+            {{- if eq .Values.api.inviteMode "email" }}
+            - name: SMTP_HOST
+              value: "{{ .Values.api.smtp.host }}"
+            - name: SMTP_PORT
+              value: "{{ .Values.api.smtp.port }}"
+            - name: SMTP_USER
+              value: "{{ .Values.api.smtp.username }}"
+            - name: SMTP_PASSWORD
+              {{- if .Values.api.smtp.passwordSecretRef }}
+              valueFrom:
+                secretKeyRef:
+                  key: SMTP_PASSWORD
+                  name: {{ .Values.api.smtp.passwordSecretRef }}
+              {{- else }}
+              value: {{ .Values.api.smtp.password }}
+              {{- end }}
             {{- end }}
             - name: ROOT_DOMAIN
               value: "{{ .Values.global.domain }}"
@@ -149,7 +175,7 @@ spec:
                   key: OAUTH_ISSUER_URL
                   name: {{ .Values.api.oauth.secretRef }}
               {{- else }}
-              value: {{ if .Values.api.oauth.issuerUrl }}{{ .Values.api.oauth.issuerUrl }}{{ else }}https://{{ .Values.global.restApiSubdomain }}.{{ .Values.global.domain }}/idp{{ end }}
+              value: {{ if .Values.global.dex.issuerUrl}}{{ .Values.global.dex.issuerUrl }}{{ else if .Values.api.oauth.issuerUrl }}{{ .Values.api.oauth.issuerUrl }}{{ else }}https://{{ .Values.global.restApiSubdomain }}.{{ .Values.global.domain }}/idp{{ end }}
               {{- end }}
             - name: OAUTH_REDIRECT_URI
               {{- if .Values.api.oauth.secretRef }}
@@ -255,7 +281,7 @@ spec:
               port: {{ if .Values.api.tls.serveHTTPS }}https{{ else }}http{{ end }}
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
-          {{- if or .Values.api.tls.serveHTTPS .Values.global.enterpriseLicenseFileSecretRef }}
+          {{- if or .Values.api.tls.serveHTTPS .Values.global.enterpriseLicenseSecretRef }}
           volumeMounts:
             {{- if .Values.api.tls.serveHTTPS }}
             - mountPath: /tmp/serving-cert/crt.pem
@@ -267,7 +293,7 @@ spec:
               name: serving-cert
               subPath: tls.key
             {{- end }}
-            {{- if .Values.global.enterpriseLicenseFileSecretRef }}
+            {{- if and .Values.global.enterpriseLicenseSecretRef .Values.global.enterpriseOfflineAccess }}
             - mountPath: /testkube/license.lic
               readOnly: true
               name: license-file
@@ -286,16 +312,16 @@ spec:
       tolerations:
         {{- toYaml . | nindent 8 }}
       {{- end }}
-      {{- if or .Values.api.tls.serveHTTPS .Values.global.enterpriseLicenseFileSecretRef }}
+      {{- if or .Values.api.tls.serveHTTPS .Values.global.enterpriseLicenseSecretRef }}
       volumes:
         {{- if .Values.api.tls.serveHTTPS }}
         - name: serving-cert
           secret:
             secretName: {{ .Values.api.tls.tlsSecret }}
         {{- end }}
-        {{- if .Values.global.enterpriseLicenseFileSecretRef }}
+        {{- if and .Values.global.enterpriseLicenseSecretRef .Values.global.enterpriseOfflineAccess }}
         - name: license-file
           secret:
-            secretName: {{ .Values.global.enterpriseLicenseFileSecretRef }}
+            secretName: {{ .Values.global.enterpriseLicenseSecretRef }}
         {{- end }}
       {{- end }}
diff --git a/charts/testkube-cloud-api/templates/ingress-grpc.yaml b/charts/testkube-cloud-api/templates/ingress-grpc.yaml
@@ -1,4 +1,4 @@
-{{- if .Values.grpcIngress.enabled -}}
+{{- if and .Values.global.ingress.enabled .Values.grpcIngress.enabled -}}
 {{- $fullName := include "testkube-cloud-api.fullname" . -}}
 {{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
   {{- if not (hasKey .Values.grpcIngress.annotations "kubernetes.io/ingress.class") }}

diff --git a/charts/testkube-cloud-api/templates/ingress-rest.yaml b/charts/testkube-cloud-api/templates/ingress-rest.yaml
@@ -1,4 +1,4 @@
-{{- if .Values.restIngress.enabled  -}}
+{{- if and .Values.global.ingress.enabled .Values.restIngress.enabled -}}
 {{- $fullName := include "testkube-cloud-api.fullname" . -}}
 {{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
   {{- if not (hasKey .Values.restIngress.annotations "kubernetes.io/ingress.class") }}

diff --git a/charts/testkube-cloud-api/templates/ingress-ws.yaml b/charts/testkube-cloud-api/templates/ingress-ws.yaml
@@ -1,4 +1,4 @@
-{{- if .Values.websocketsIngress.enabled -}}
+{{- if and .Values.global.ingress.enabled .Values.websocketsIngress.enabled -}}
 {{- $fullName := include "testkube-cloud-api.fullname" . -}}
 {{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
   {{- if not (hasKey .Values.websocketsIngress.annotations "kubernetes.io/ingress.class") }}

diff --git a/charts/testkube-cloud-api/values.yaml b/charts/testkube-cloud-api/values.yaml
@@ -12,7 +12,7 @@ global:
   # -- Base64-encoded Enterprise License file
   enterpriseLicenseFile: ""
   # -- Enterprise License file secret ref (secret should contain a file called 'license.lic')
-  enterpriseLicenseFileSecretRef: ""
+  enterpriseLicenseSecretRef: ""
   # -- Domain under which to create Ingress rules
   domain: ""
   # -- UI subdomain which get prepended to the domain
@@ -30,6 +30,12 @@ global:
     issuerRef: ""
   # -- Global image pull secrets (provided usually by a parent chart like testkube-enterprise)
   imagePullSecrets: []
+  ingress:
+    # -- Toggle whether to enable or disable all Ingress resources (if false, all Ingress resources will be disabled and cannot be overriden)
+    enabled: true
+  dex:
+    # -- Global Dex issuer url
+    issuerUrl: ""
 
 replicaCount: 1
 
@@ -75,6 +81,19 @@ api:
     useHelmHooks: true
     image:
       repository: kubeshop/testkube-cloud-api-migrations
+  # -- Configure which invitation mode to use (email|auto-accept): email uses SMTP protocol to send email invites and auto-accept immediately adds them
+  inviteMode: email
+  smtp:
+    # -- SMTP host
+    host: smtp.sendgrid.net
+    # -- SMTP port
+    port: 587
+    # -- SMTP username
+    username: ""
+    # -- SMTP password
+    password: ""
+    # -- SMTP secret ref (secret must contain key SMTP_PASSWORD), overrides password field if defined
+    passwordSecretRef: ""
   tls:
     # -- Toggle should the Application terminate TLS instead of the Ingress
     serveHTTPS: true

diff --git a/charts/testkube-cloud-ui/Chart.yaml b/charts/testkube-cloud-ui/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: testkube-cloud-ui
 description: A Helm chart for Testkube Cloud UI
 type: application
-version: 1.2.0
+version: 1.3.0
 appVersion: 1.0.2
 maintainers:
   - name: testkube

diff --git a/charts/testkube-cloud-ui/README.md b/charts/testkube-cloud-ui/README.md
@@ -1,6 +1,6 @@
 # testkube-cloud-ui
 
-![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.2](https://img.shields.io/badge/AppVersion-1.0.2-informational?style=flat-square)
+![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.2](https://img.shields.io/badge/AppVersion-1.0.2-informational?style=flat-square)
 
 A Helm chart for Testkube Cloud UI
 
@@ -32,6 +32,7 @@ A Helm chart for Testkube Cloud UI
 | global.domain | string | `""` | Domain under which to create Ingress rules |
 | global.enterpriseMode | bool | `false` | Toggle whether UI is installed in Enterprise mode |
 | global.imagePullSecrets | list | `[]` | Global image pull secrets (provided usually by a parent chart like testkube-enterprise) |
+| global.ingress.enabled | bool | `true` | Global toggle whether to create Ingress resources |
 | global.uiSubdomain | string | `"cloud"` | UI subdomain which get prepended to the domain |
 | image.pullPolicy | string | `"IfNotPresent"` |  |
 | image.repository | string | `"kubeshop/testkube-cloud-ui"` |  |

diff --git a/charts/testkube-cloud-ui/templates/ingress.yaml b/charts/testkube-cloud-ui/templates/ingress.yaml
@@ -1,4 +1,4 @@
-{{- if .Values.ingress.enabled -}}
+{{- if and .Values.global.ingress .Values.ingress.enabled -}}
 {{- $fullName := include "testkube-cloud-ui.fullname" . -}}
 {{- $svcPort := .Values.service.port -}}
 {{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}

diff --git a/charts/testkube-cloud-ui/values.yaml b/charts/testkube-cloud-ui/values.yaml
@@ -16,6 +16,9 @@ global:
     issuerRef: ""
   # -- Global image pull secrets (provided usually by a parent chart like testkube-enterprise)
   imagePullSecrets: []
+  ingress:
+    # -- Global toggle whether to create Ingress resources
+    enabled: true
 
 replicaCount: 1
 

diff --git a/charts/testkube-enterprise/Chart.lock b/charts/testkube-enterprise/Chart.lock
@@ -4,10 +4,10 @@ dependencies:
   version: 2.2.5
 - name: testkube-cloud-api
   repository: file://../testkube-cloud-api
-  version: 1.6.8
+  version: 1.7.0
 - name: testkube-cloud-ui
   repository: file://../testkube-cloud-ui
-  version: 1.2.0
+  version: 1.3.0
 - name: dex
   repository: https://charts.dexidp.io
   version: 0.14.1
@@ -17,5 +17,5 @@ dependencies:
 - name: nats
   repository: https://nats-io.github.io/k8s/helm/charts/
   version: 0.14.2
-digest: sha256:6266d3cb6811d51b5e930b52fb9a95b12b0c25259c928d9bac24a78989c03500
-generated: "2023-06-22T11:13:12.925628573Z"
+digest: sha256:366778e3225e2130e970874f4a95ce884252adc04e0f18905e0d9ebc64b6960c
+generated: "2023-06-22T14:03:53.41021+02:00"
diff --git a/charts/testkube-enterprise/Chart.yaml b/charts/testkube-enterprise/Chart.yaml
@@ -2,16 +2,16 @@ apiVersion: v2
 name: testkube-enterprise
 description: A Helm chart for Testkube Enterprise
 type: application
-version: 1.6.0
+version: 1.7.0
 dependencies:
   - name: common
     version: 2.2.5
     repository: https://charts.bitnami.com/bitnami
   - name: testkube-cloud-api
-    version: 1.6.8
+    version: 1.7.0
     repository: file://../testkube-cloud-api
   - name: testkube-cloud-ui
-    version: 1.2.0
+    version: 1.3.0
     repository: file://../testkube-cloud-ui
   - name: dex
     version: 0.14.1