docs: updated docs and references

nautobot · Mar 22, 2024 · 9ecc513 · 9ecc513
1 parent a1a83e7
commit 9ecc513
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/charts/nautobot/values.yaml b/charts/nautobot/values.yaml
@@ -394,13 +394,19 @@ nautobot:
   secretKey: ""
 
   django:
+    # -- Name of existing secret to use for NAUTOBOT_SECRET_KEY<sup>[1](#notes)</sup>
     existingSecret: ""
+    # -- SecretKey key to be retrieved from existing secret<sup>[1](#notes)</sup>
     existingSecretSecretKeyKey: ""
+    # -- [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY), takes priority over nautobot.secretKey<sup>[1](#notes)</sup>
     secretKey: ""
 
   superUser:
+    # -- Name of existing secret to use for superuser password and API token<sup>[1](#notes)</sup>
     existingSecret: ""
+    # -- Password key to be retrieved from existing secret<sup>[1](#notes)</sup>
     existingSecretPasswordKey: ""
+    # -- API Token key to be retrieved from existing secret<sup>[1](#notes)</sup>
     existingSecretApiTokenKey: ""
     # -- [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_create_superuser)] Create a new super user account in Nautobot once deployed (NAUTOBOT_CREATE_SUPERUSER)<sup>[1](#notes)</sup>
     enabled: true

diff --git a/docs/advanced-features/existing-secrets.md b/docs/advanced-features/existing-secrets.md
@@ -1,6 +1,15 @@
 # Existing Secrets
 
-If you don't want to pass values through helm for either Redis or PostgreSQL there are a few options.  If you want to deploy PostgreSQL and Redis with this chart:
+If you don't want to pass values through helm for...
+- Redis
+- PostgreSQL
+- MariaDB
+- Nautobot Secret Key
+- Superuser password and API token
+
+...there's the option of creating these secrets manually and referencing them in the configuration.  
+
+For example, if you want to deploy PostgreSQL and Redis with this chart:
 
 1. Create a secret with both PostgreSQL and Redis passwords:
 
@@ -23,6 +32,7 @@ If you don't want to pass values through helm for either Redis or PostgreSQL the
         existingSecretPasswordKey: "NAUTOBOT_REDIS_PASSWORD"
     ```
 
+
 If you are using external PostgreSQL and Redis servers you can use the following values:
 
 ```yaml
@@ -39,4 +49,23 @@ redis:
   enabled: false
 ```
 
-You can use various combinations of `existingSecret` and `existingSecretPasswordKey` options depending on the existing secrets you have deployed.  (NOTE: The Bitnami PostgreSQL chart does require the key name to be "postgresql-password")
+To reference an existing NAUTOBOT_SECRET_KEY you can use the following values:
+
+```yaml
+nautobot:
+  django:
+    existingSecret: "my-secret"
+    existingSecretSecretKeyKey: "NAUTOBOT_SECRET_KEY"
+```
+
+And/or for the superuser credentials you can use this configuration:
+
+```yaml
+nautobot:
+  superUser:
+    existingSecret: "my-secret"
+    existingSecretPasswordKey: "NAUTOBOT_SUPERUSER_PASSWORD"
+    existingSecretApiTokenKey: "NAUTOBOT_SUPERUSER_API_TOKEN"
+```
+
+You can use various combinations of `existingSecret` and `*Key` options depending on the existing secrets you have deployed.