Merge pull request #577 from rackerlabs/variable-auth-url

docs: variable auth_url for keystone auth
rackerlabs · Jan 6, 2025 · 31dfc87 · 31dfc87
2 parents 0c42e93 + 7caae4c
commit 31dfc87
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 1 deletion.
diff --git a/docs/deploy-guide/add-remove-app.md b/docs/deploy-guide/add-remove-app.md
@@ -40,6 +40,8 @@ Adding an application to be part of UnderStack involves modifying the
 
 The general form should be:
 
+{% raw %}
+
 ```yaml
 # list item per ArgoCD Application
 # the component value will appear as the ArgoCD Application name
@@ -78,6 +80,8 @@ The general form should be:
       path: '{{.name}}/manifests/dex'
 ```
 
+{% endraw %}
+
 ## Removing an application from UnderStack
 
 [argocd]: <https://argo-cd.readthedocs.io/en/stable/>

diff --git a/docs/user-guide/openstack-cli.md b/docs/user-guide/openstack-cli.md
@@ -59,7 +59,7 @@ clouds:
     identity_provider: sso
     protocol: openid
     auth:
-      auth_url: https://your.endpoint.url/v3
+      auth_url: {{ config.extra.auth_url }}
       project_domain_name: Default
       project_name: myproject
 ```

diff --git a/docs/user-guide/postgres-operator-cheat-sheet.md b/docs/user-guide/postgres-operator-cheat-sheet.md
@@ -30,6 +30,8 @@ kubectl -n nautobot describe cluster nautobot-cluster
 
 ## Connect to the Nautobot database with psql command line
 
+{% raw %}
+
 ```bash
 # This is the name of the secret with the nautobot postgres credentials
 PG_CLUSTER_SECRET=nautobot-cluster-app
@@ -38,6 +40,8 @@ PG_CLUSTER_SECRET=nautobot-cluster-app
 PGPASSWORD=$(kubectl get secret -n nautobot "${PG_CLUSTER_SECRET}" -o go-template='{{.data.password | base64decode}}') PGUSER=$(kubectl get secret -n nautobot "${PG_CLUSTER_SECRET}" -o go-template='{{.data.user | base64decode}}') PGDATABASE=$(kubectl get secret -n nautobot "${PG_CLUSTER_SECRET}" -o go-template='{{.data.dbname | base64decode}}') psql -h localhost
 ```
 
+{% endraw %}
+
 ## Create a local pg_dump backup of the Nautobot database
 
 First we need to create a kubernetes port forward for our local machine
@@ -53,7 +57,11 @@ kubectl -n nautobot port-forward "${PG_CLUSTER_PRIMARY_POD}" 5432:5432
 
 Once the port forward has been created, we can perform a `pg_dump` of the postgres database:
 
+{% raw %}
+
 ```bash
 PG_CLUSTER_SECRET=nautobot-cluster-app
 PGPASSWORD=$(kubectl get secret -n nautobot "${PG_CLUSTER_SECRET}" -o go-template='{{.data.password | base64decode}}') PGUSER=$(kubectl get secret -n nautobot "${PG_CLUSTER_SECRET}" -o go-template='{{.data.user | base64decode}}') PGDATABASE=$(kubectl get secret -n nautobot "${PG_CLUSTER_SECRET}" -o go-template='{{.data.dbname | base64decode}}') pg_dump -h localhost -f nautobot.postgres.sql
 ```
+
+{% endraw %}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -89,13 +89,17 @@ plugins:
   - include_dir_to_nav:
       sort_file: true
       sort_directory: true
+  - macros
 
 validation:
   omitted_files: warn
   absolute_links: warn
   unrecognized_links: warn
   anchors: warn
 
+extra:
+  auth_url: !ENV [OS_AUTH_URL, "https://your.endpoint.url/v3"]
+
 nav:
   - Home: index.md
   - Overview:

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -3,5 +3,6 @@ mkdocs-material
 mkdocs-swagger-ui-tag
 mkdocs-glightbox
 markdown-exec
+mkdocs-macros-plugin
 mkdocs-multirepo-plugin>=0.8.3
 mkdocs-include-dir-to-nav
diff --git a/scripts/argo-workflows-to-mkdocs.py b/scripts/argo-workflows-to-mkdocs.py
@@ -645,10 +645,12 @@ def generate_mermaid(workflows, nodes, output_name, output_file, workflow_readme
         f.write("\n")
         f.write("## Workflow Diagram\n")
         f.write("\n")
+        f.write("{% raw %}\n\n")
         f.write("```mermaid\n")
         f.write(mermaid_output)
         f.write("\n")
         f.write("```\n")
+        f.write("\n{% endraw %}\n")
         f.write("\n")