diff --git a/charts/console/Chart.yaml b/charts/console/Chart.yaml index b98c037..bc8f6a6 100644 --- a/charts/console/Chart.yaml +++ b/charts/console/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: console appVersion: 1.17.3 -version: 1.1.0 +version: 1.1.1 description: Helm chart to deploy Conduktor Platform on Kubernetes icon: https://www.conduktor.io/svgs/logo/symbol.svg home: https://www.conduktor.io diff --git a/charts/console/README.md b/charts/console/README.md index 928aab9..40bf5ef 100644 --- a/charts/console/README.md +++ b/charts/console/README.md @@ -204,7 +204,6 @@ console, we recommend you to look at our ### Kubernetes configuration - [Install with a PodAffinity](#install-with-a-podaffinity) -- [Install with a PodAntiAffinity](#install-with-a-podantiaffinity) - [Install with a Toleration](#install-with-a-toleration) - [Install with a Self-Signed Certificate](#install-with-self-signed-tls-certificate) - [Install with a custom service account](#install-with-a-custom-service-account) @@ -212,7 +211,9 @@ console, we recommend you to look at our - [Provide credentials as a Kubernetes Secret](#provide-credentials-configuration-as-a-kubernetes-secret) - [Provide the license as a Kubernetes Secret](#provide-the-license-as-a-kubernetes-secret) -- [Provide the license as a Kubernetes ConfigMap](#provide-the-platform-config-as-a-kubernetes-configmap) +- [Provide the license as a Kubernetes ConfigMap](#provide-console-configuration-as-a-kubernetes-configmap) + +- [Provide additional credentials as a Kubernetes Secret](#provide-additional-credentials-as-a-kubernetes-secret) ### Install with an enterprise license @@ -294,10 +295,11 @@ config: ### Provide the license as a Kubernetes Secret -We expect the secret to contain a key named `license` which contains your -license key. +This snippet expects that a *Kubernetes Secret Resource* already exists inside +your cluster with a key named `license` containing your license key. + -```shell +```yaml # values.yaml config: organization: @@ -384,6 +386,37 @@ platform: existingConfigMap: "" ``` +### Provide additional credentials as a Kubernetes Secret + +In case our helm chart doesn't protect all the credentials you need, you can +use this method to provide additional credentials through a Kubernetes +Secret Resource you previously created. You can have this case for LDAP +credentials, or for SSO credentials for example. + +The keys of your secret will be used as environment variables in the +console pod. Be sure to check available [environment variables](https://docs.conduktor.io/platform/configuration/env-variables/) +in our documentation. + +```yaml +config: + organization: + name: "my-org" + + admin: + email: "admin@my-org.com" + password: "admin" + + database: + host: '' + port: 5432 + name: 'postgres' + username: '' + password: '' + +platform: + extraEnvVarsSecret: "" +``` + ### Install with a toleration ```yaml diff --git a/charts/console/templates/NOTES.txt b/charts/console/templates/NOTES.txt index 63a6b67..74a3955 100644 --- a/charts/console/templates/NOTES.txt +++ b/charts/console/templates/NOTES.txt @@ -35,7 +35,7 @@ Conduktor Platform will be accessible at : http://127.0.0.1:8080 To connect use following admin account ADMIN_LOGIN and ADMIN_PASSWORD -ADMIN_LOGIN="{{ .Values.config.admin.email }}" +ADMIN_LOGIN="{{ include "common.secrets.lookup" (dict "secret" (include "conduktor.platform.secretName" .) "key" "CDK_ADMIN_EMAIL" "defaultValue" .Values.config.admin.email "context" $) | b64dec }}" ADMIN_PASSWORD="$(kubectl get secret {{ include "conduktor.platform.secretName" . }} -n {{ .Release.Namespace }} -o jsonpath="{.data.CDK_ADMIN_PASSWORD}" | base64 --decode)" More details on Platform configuration are available at https://docs.conduktor.io/platform/ diff --git a/charts/console/templates/platform/deployment.yaml b/charts/console/templates/platform/deployment.yaml index 2ec5e79..b25e769 100644 --- a/charts/console/templates/platform/deployment.yaml +++ b/charts/console/templates/platform/deployment.yaml @@ -28,6 +28,12 @@ spec: {{- include "common.tplvalues.render" (dict "value" .Values.platform.podAnnotations "context" $) | nindent 8 }} {{- end }} checksum/config: {{ include (print $.Template.BasePath "/platform/configmap.yaml") . | sha256sum }} + {{- if not .Values.config.existingSecret }} + checksum/credentials: {{ include (print $.Template.BasePath "/platform/secret-credentials.yaml") . | sha256sum }} + {{- end }} + {{- if and .Values.config.license (not .Values.config.existingLicenseSecret) }} + checksum/license: {{ include (print $.Template.BasePath "/platform/secret-license.yaml") . | sha256sum }} + {{- end }} labels: {{- include "common.labels.standard" . | nindent 8 }} app.kubernetes.io/component: conduktor-platform {{- if .Values.platform.podLabels }} diff --git a/charts/console/values.yaml b/charts/console/values.yaml index 17c77ab..1bb5e87 100644 --- a/charts/console/values.yaml +++ b/charts/console/values.yaml @@ -1,5 +1,5 @@ ## @section Global parameters -## @descriptionStart +## @descriptionStart ## Global Docker image parameters ## Please, note that this will override the image parameters, including dependencies, configured to use the global value ## Current available global Docker image parameters: imageRegistry, imagePullSecrets and storageClass @@ -59,7 +59,7 @@ diagnosticMode: - infinity ## @section Platform product Parameters -## @descriptionStart +## @descriptionStart ## You can paste here your Conduktor Platform Configuration ## ## Refer to our [documentation](https://docs.conduktor.io/platform/configuration/env-variables/) for the full list of product configuration properties. @@ -85,15 +85,15 @@ config: host: '' port: 5432 name: 'postgres' - username: '' password: '' + username: '' ## @param config.license Conduktor Platform Enterprise license, if none given, the product will run in free tier license: "" ## @param config.existingLicenseSecret Name of an existing secret containing the license ## - ## Secret should just contain key "license" with the license as value + ## Secret should just contain key "CDK_LICENSE" with the license as value ## NOTE: 'config.license' will be ignored existingLicenseSecret: "" @@ -341,6 +341,7 @@ platform: ## lifecycleHooks: {} ## @param platform.extraEnvVars Array with extra environment variables to add to Conduktor Platform nodes + ## ref: https://docs.conduktor.io/platform/configuration/env-variables/ ## e.g: ## extraEnvVars: ## - name: FOO @@ -348,9 +349,11 @@ platform: ## extraEnvVars: [] ## @param platform.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Conduktor Platform nodes + ## ref: https://docs.conduktor.io/platform/configuration/env-variables/ ## extraEnvVarsCM: "" ## @param platform.extraEnvVarsSecret Name of existing Secret containing extra env vars for Conduktor Platform nodes + ## ref: https://docs.conduktor.io/platform/configuration/env-variables/ ## extraEnvVarsSecret: "" ## @param platform.extraVolumes Optionally specify extra list of additional volumes for the Conduktor Platform pod(s)