From e40f354a7d53b0a4fc99e6293e4aac4d38a4fa13 Mon Sep 17 00:00:00 2001 From: Ori Shoshan Date: Fri, 3 May 2024 10:20:06 +0300 Subject: [PATCH] Fix clientSecretKeyRef docs --- .../credentials-operator/helm-chart.mdx | 30 +++++++++---------- .../intents-operator/helm-chart.mdx | 16 +++++----- .../configuration/otterize-chart/README.mdx | 16 +++++----- 3 files changed, 30 insertions(+), 32 deletions(-) diff --git a/docs/reference/configuration/credentials-operator/helm-chart.mdx b/docs/reference/configuration/credentials-operator/helm-chart.mdx index ec1f09231..302941c75 100644 --- a/docs/reference/configuration/credentials-operator/helm-chart.mdx +++ b/docs/reference/configuration/credentials-operator/helm-chart.mdx @@ -37,25 +37,23 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor ## Operator parameters -| Key | Description | Default | -|-----------------------|----------------------------|------------------------| -| `operator.repository` | Operator image repository. | `otterize` | -| `operator.image` | Operator image. | `credentials-operator` | -| `operator.tag` | Operator image tag. | `(pinned to latest version as of this Helm chart version's publish)` | -| `operator.pullPolicy` | Operator pull policy. | `(none)` | +| Key | Description | Default | +|-----------------------|----------------------------|----------------------------------------------------------------------| +| `operator.repository` | Operator image repository. | `otterize` | +| `operator.image` | Operator image. | `credentials-operator` | +| `operator.tag` | Operator image tag. | `(pinned to latest version as of this Helm chart version's publish)` | +| `operator.pullPolicy` | Operator pull policy. | `(none)` | ## Cloud parameters -| Key | Description | Default | -|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| -| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` | -| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` | -| `global.otterizeCloud.credentials.secretKeyRef.secretName` | If specified, the name of a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | -| `global.otterizeCloud.credentials.secretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | -| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` | -| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` | -| `global.aws.enabled` | Enable or disable AWS integration | `false` | -| `global.aws.eksClusterNameOverride` | EKS cluster name (overrides auto-detection) | `(none)` | +| Key | Description | Default | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` | +| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` | +| `global.otterizeCloud.credentials.clientSecretKeyRef.secretName` | If specified, the name of a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | +| `global.otterizeCloud.credentials.clientSecretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | +| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` | +| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` | ## SPIRE parameters diff --git a/docs/reference/configuration/intents-operator/helm-chart.mdx b/docs/reference/configuration/intents-operator/helm-chart.mdx index 1e6faf410..61d4c578e 100644 --- a/docs/reference/configuration/intents-operator/helm-chart.mdx +++ b/docs/reference/configuration/intents-operator/helm-chart.mdx @@ -52,14 +52,14 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor ## Cloud parameters -| Key | Description | Default | -|:-----------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------| -| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` | -| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` | -| `global.otterizeCloud.credentials.secretKeyRef.secretName` | If specified, the name of a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | -| `global.otterizeCloud.credentials.secretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | -| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` | -| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` | +| Key | Description | Default | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` | +| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` | +| `global.otterizeCloud.credentials.clientSecretKeyRef.secretName` | If specified, the name of a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | +| `global.otterizeCloud.credentials.clientSecretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | +| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` | +| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` | ## Common parameters | Key | Description | Default | diff --git a/docs/reference/configuration/otterize-chart/README.mdx b/docs/reference/configuration/otterize-chart/README.mdx index 2854c9d60..aeabec0dd 100644 --- a/docs/reference/configuration/otterize-chart/README.mdx +++ b/docs/reference/configuration/otterize-chart/README.mdx @@ -38,14 +38,14 @@ These parameters are used by multiple charts, and must be kept the same for the ## Cloud parameters -| Key | Description | Default | -|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| -| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` | -| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` | -| `global.otterizeCloud.credentials.secretKeyRef.secretName` | If specified, the name of a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | -| `global.otterizeCloud.credentials.secretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | -| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` | -| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` | +| Key | Description | Default | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` | +| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` | +| `global.otterizeCloud.credentials.clientSecretKeyRef.secretName` | If specified, the name of a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | +| `global.otterizeCloud.credentials.clientSecretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` | +| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` | +| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` | ## AWS Integration parameters | Key | Description | Default |