From dea203b883bca7c0dd533f0d0745380de011fdc5 Mon Sep 17 00:00:00 2001
From: Doug Goldstein <doug.goldstein@rackspace.com>
Date: Fri, 19 Sep 2025 13:08:54 -0500
Subject: [PATCH] docs: add region_name to the CLI config example

Added the region_name to the CLI config example and rename the config
key since folks were confused by it being the name of the project.
---
 docs/user-guide/openstack-cli.md | 12 +++++++-----
 mkdocs.yml                       |  1 +
 2 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/docs/user-guide/openstack-cli.md b/docs/user-guide/openstack-cli.md
index 0e18e8dc9..9bf094baf 100644
--- a/docs/user-guide/openstack-cli.md
+++ b/docs/user-guide/openstack-cli.md
@@ -54,7 +54,7 @@ The easiest way to configure your client is via `clouds.yaml`.
 
 ```yaml title="$HOME/.config/openstack/clouds.yaml"
 clouds:
-  understack:
+  my-site:
     auth_type: v3websso
     identity_provider: sso
     protocol: openid
@@ -62,6 +62,7 @@ clouds:
       auth_url: {{ config.extra.auth_url }}
       project_domain_name: Default
       project_name: myproject
+    region_name: {{ config.extra.region_name }}
 ```
 
 <!-- markdownlint-capture -->
@@ -75,14 +76,14 @@ With the above configuration in `$HOME/.config/openstack/clouds.yaml` you
 will be able to run the OpenStack CLI as follows:
 
 ```bash
-openstack --os-cloud understack <sub-command-here>
+openstack --os-cloud my-site <sub-command-here>
 ```
 
 Or you can set the `OS_CLOUD` environment variable once and shorten the
 command as follows:
 
 ```bash
-export OS_CLOUD=understack
+export OS_CLOUD=my-site
 openstack <sub-command-here>
 ```
 
@@ -115,19 +116,20 @@ Note the auth_type and auth options are slightly different than in the above SSO
 
 ```yaml title="$HOME/.config/openstack/clouds.yaml"
 clouds:
-  understack-application:
+  my-site-app:
     auth_type: v3applicationcredential
     auth:
       auth_url: {{ config.extra.auth_url }}
       application_credential_id: ${FROM_ABOVE}
       application_credential_secret: ${FROM_ABOVE}
+    region_name: {{ config.extra.region_name }}
 ```
 
 The `openstack` cli, `terraform` and `ansible` can all use application credentials and
 the `OS_CLOUD` environment variable:
 
 ```bash
-export OS_CLOUD=understack-application
+export OS_CLOUD=my-site-app
 ```
 
 There are a number of additional features and options available in the OpenStack documentation:
diff --git a/mkdocs.yml b/mkdocs.yml
index ac3357798..8f4e21f21 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -99,6 +99,7 @@ validation:
 
 extra:
   auth_url: !ENV [OS_AUTH_URL, "https://your.endpoint.url/v3"]
+  region_name: !ENV [OS_REGION_NAME, "my-site"]
 
 nav:
   - Home: index.md