Correct docs with latest secrets behavior (#313)

netbox-community · Aug 21, 2024 · 7e8a26a · 7e8a26a
1 parent b141561
commit 7e8a26a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -427,9 +427,9 @@ worker:
 
 Rather than specifying passwords and secrets as part of the Helm release values,
 you may pass these to NetBox using pre-existing `Secret` resources. When using
-this, the `Secret` must contain the following keys:
+this, the respective `Secret`s must contain the following keys.
 
-### Superuser secret
+### Superuser secret (`superuser.existingSecret`)
 
 Type: `kubernetes.io/basic-auth`
 
@@ -440,26 +440,25 @@ Type: `kubernetes.io/basic-auth`
 | `email`                | Email address for the initial super-user account              | Yes                                                                                               |
 | `api_token`            | API token created for the initial super-user account          | Yes                                                                                               |
 
-### Config secret
+### Config secret (`existingSecret`)
 
 | Key                    | Description                                                   | Required?                                                                                         |
 | -----------------------|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
 | `email_password`       | SMTP user password                                            | Yes, but the value may be left blank if not required                                              |
 | `ldap_bind_password`   | Password for LDAP bind DN                                     | If `remoteAuth.enabled` is `true` and `remoteAuth.backend` is `netbox.authentication.LDAPBackend` |
 | `secret_key`           | Django secret key used for sessions and password reset tokens | Yes                                                                                               |
 
-### PostgreSQL secret
+### PostgreSQL secret (`externalDatabase.existingSecretName`)
 
 | Key                    | Description                                                   | Required?                                                                                         |
 | -----------------------|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
-| `db_password`          | The password for the external PostgreSQL database             | If `postgresql.enabled` is `false` and `externalDatabase.existingSecretName` is unset             |
+| `postgresql-password`  | The password for the external PostgreSQL database             | If `postgresql.enabled` is `false`                                                                |
 
-### Redis secret
+### Redis secrets (`tasksRedis.existingSecretName` & `cachingRedis.existingSecretName`)
 
 | Key                    | Description                                                   | Required?                                                                                         |
 | -----------------------|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
-| `redis_tasks_password` | Password for the external Redis tasks database                | If `redis.enabled` is `false` and `tasksRedis.existingSecretName` is unset                        |
-| `redis_cache_password` | Password for the external Redis cache database                | If `redis.enabled` is `false` and `cachingRedis.existingSecretName` is unset                      |
+| `redis-password`       | Password for the external Redis database (tasks and/or cache) | If `redis.enabled` is `false`                                                                     |
 
 ## Authentication
 * [Single Sign On](docs/auth.md#configuring-sso)

diff --git a/charts/netbox/Chart.yaml b/charts/netbox/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: netbox
-version: 5.0.0-beta.78
+version: 5.0.0-beta.79
 appVersion: "v4.0.9"
 type: application
 kubeVersion: ^1.25.0-0

diff --git a/charts/netbox/values.yaml b/charts/netbox/values.yaml
@@ -441,17 +441,9 @@ secretKey: ""
 
 ## Provide passwords using existing secret
 # If set, this Secret must contain the following keys:
-# - db_password: database password (if postgresql.enabled is false and
-#     externalDatabase.existingSecretName is blank)
 # - email_password: SMTP user password
 # - ldap_bind_password: Password for LDAP bind DN
-# - redis_tasks_password: Redis password for tasks Redis instance (if
-#     redis.enabled is false and tasksRedis.existingSecretName is blank)
-# - redis_cache_password: Redis password for caching Redis instance (if
-#     redis.enabled is false and cachingRedis.existingSecretName is blank)
 # - secret_key: session encryption token (50+ random characters)
-# - superuser_password: Password for the initial super-user account
-# - superuser_api_token: API token created for the initial super-user account
 existingSecret: ""
 
 # Override the NGINX Unit configuration inside the container. When enabled, this