-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(console): improve documentation & values (#10)
* Fix license with secrets * Add additional snippet for configuration * Add annotations to put checksum on deployment --------- Signed-off-by: ConduktorBot <[email protected]> Co-authored-by: ConduktorBot <[email protected]>
- Loading branch information
1 parent
99e8407
commit b6f244b
Showing
5 changed files
with
53 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -204,15 +204,16 @@ 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) | ||
- [Install with a AWS EKS IAM Role](#install-with-a-aws-eks-iam-role) | ||
|
||
- [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: "<your_configmap_name>" | ||
``` | ||
|
||
### 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: "[email protected]" | ||
password: "admin" | ||
database: | ||
host: '' | ||
port: 5432 | ||
name: 'postgres' | ||
username: '' | ||
password: '' | ||
platform: | ||
extraEnvVarsSecret: "<your_secret_name>" | ||
``` | ||
|
||
### Install with a toleration | ||
|
||
```yaml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters