Adding reference for new secret rotation interval entry in credential…

…s operator (#245)
otterize · Jun 23, 2024 · ad0a646 · ad0a646
1 parent bd80ca9
commit ad0a646
Show file tree

Hide file tree

Showing 4 changed files with 124 additions and 106 deletions.
diff --git a/docs/reference/configuration/credentials-operator/helm-chart.mdx b/docs/reference/configuration/credentials-operator/helm-chart.mdx
@@ -37,12 +37,13 @@ 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)`                                                             |
+| `operator.extraEnvVars` | Extra environment variables to pass to the credentials operator pod. To set an environment variable: `"operator.extraEnvVars[0].name=MY_ENV_VAR"`, to set its value: `"operator.extraEnvVars[0].value=someValue"` |
 
 ## Cloud parameters
 
@@ -62,6 +63,7 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor
 |-----------------------|----------------------------------------------------------------------------------------------------------------|------------------------|
 | `spire.serverAddress` | Specify the SPIRE-server's address. You should use either this OR `global.spire.serverServiceName` (not both). |                        |
 | `spire.socketsPath`   | SPIRE sockets path. The operator will expect to find agent.sock in the host-mounted folder                     | `"/run/spire/sockets"` |
+
 ## Common parameters
 | Key                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Default |
 |------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
@@ -71,4 +73,9 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor
 ## AWS integration parameters
 | Key           | Description                                              | Default  |
 |---------------|----------------------------------------------------------|----------|
-| `aws.roleARN` | ARN of the AWS role the operator will use to access AWS. | `(none)` |
+| `aws.roleARN` | ARN of the AWS role the operator will use to access AWS. | `(none)` |
+
+## Credentials operator parameters
+| Key                              | Description                                                                                                                   | Default |
+|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------|
+| `databaseSecretRotationInterval` | Interval in which secrets created by the credentials operator will be rotated. Valid time units are "ns", "ms", "s", "m", "h" | `8h`    |