Skip to content

Commit 4d2c5dc

Browse files
authored
Merge pull request #1255 from rackerlabs/update-doc-for-region
docs: add region_name to the CLI config example
2 parents c99cbda + dea203b commit 4d2c5dc

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

docs/user-guide/openstack-cli.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,15 @@ The easiest way to configure your client is via `clouds.yaml`.
5454

5555
```yaml title="$HOME/.config/openstack/clouds.yaml"
5656
clouds:
57-
understack:
57+
my-site:
5858
auth_type: v3websso
5959
identity_provider: sso
6060
protocol: openid
6161
auth:
6262
auth_url: {{ config.extra.auth_url }}
6363
project_domain_name: Default
6464
project_name: myproject
65+
region_name: {{ config.extra.region_name }}
6566
```
6667
6768
<!-- markdownlint-capture -->
@@ -75,14 +76,14 @@ With the above configuration in `$HOME/.config/openstack/clouds.yaml` you
7576
will be able to run the OpenStack CLI as follows:
7677

7778
```bash
78-
openstack --os-cloud understack <sub-command-here>
79+
openstack --os-cloud my-site <sub-command-here>
7980
```
8081

8182
Or you can set the `OS_CLOUD` environment variable once and shorten the
8283
command as follows:
8384

8485
```bash
85-
export OS_CLOUD=understack
86+
export OS_CLOUD=my-site
8687
openstack <sub-command-here>
8788
```
8889

@@ -115,19 +116,20 @@ Note the auth_type and auth options are slightly different than in the above SSO
115116

116117
```yaml title="$HOME/.config/openstack/clouds.yaml"
117118
clouds:
118-
understack-application:
119+
my-site-app:
119120
auth_type: v3applicationcredential
120121
auth:
121122
auth_url: {{ config.extra.auth_url }}
122123
application_credential_id: ${FROM_ABOVE}
123124
application_credential_secret: ${FROM_ABOVE}
125+
region_name: {{ config.extra.region_name }}
124126
```
125127

126128
The `openstack` cli, `terraform` and `ansible` can all use application credentials and
127129
the `OS_CLOUD` environment variable:
128130

129131
```bash
130-
export OS_CLOUD=understack-application
132+
export OS_CLOUD=my-site-app
131133
```
132134

133135
There are a number of additional features and options available in the OpenStack documentation:

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ validation:
9999

100100
extra:
101101
auth_url: !ENV [OS_AUTH_URL, "https://your.endpoint.url/v3"]
102+
region_name: !ENV [OS_REGION_NAME, "my-site"]
102103

103104
nav:
104105
- Home: index.md

0 commit comments

Comments
 (0)