Updated os-cloud to be consistent

rackerlabs · Sep 11, 2024 · 32a8130 · 32a8130
1 parent 9dfb04f
commit 32a8130
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 20 deletions.
diff --git a/docs/openstack-router.md b/docs/openstack-router.md
@@ -5,7 +5,7 @@ Read more about Openstack Routers using the [upstream docs](https://docs.opensta
 #### Get List of Routers
 
 ``` shell
-openstack --os-cloud={user cloud name router list
+openstack --os-cloud={cloud name} router list
     [--sort-column SORT_COLUMN]
     [--sort-ascending | --sort-descending]
     [--name <name>]
@@ -23,7 +23,7 @@ openstack --os-cloud={user cloud name router list
 #### Create a Router
 
 ``` shell
-openstack --os-cloud={user cloud name router create
+openstack --os-cloud={cloud name} router create
     [--extra-property type=<property_type>,name=<property_name>,value=<property_value>]
     [--enable | --disable]
     [--distributed | --centralized]
@@ -48,7 +48,7 @@ openstack --os-cloud={user cloud name router create
 #### Add a Gateway to Router
 
 ``` shell
-openstack --os-cloud={user cloud name router add gateway
+openstack --os-cloud={cloud name} router add gateway
     [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
     <router>
     <network>
@@ -57,19 +57,19 @@ openstack --os-cloud={user cloud name router add gateway
 #### Add a Subnet to Router
 
 ``` shell
-openstack --os-cloud={user cloud name router add subnet <router> <subnet>
+openstack --os-cloud={cloud name} router add subnet <router> <subnet>
 ```
 
 #### Add a Port to Router
 
 ``` shell
-openstack --os-cloud={user cloud name router add port <router> <port>
+openstack --os-cloud={cloud name} router add port <router> <port>
 ```
 
 #### Set Router Properties
 
 ``` shell
-openstack --os-cloud={user cloud name router set
+openstack --os-cloud={cloud name} router set
     [--extra-property type=<property_type>,name=<property_name>,value=<property_value>]
     [--name <name>]
     [--description <description>]
@@ -95,14 +95,14 @@ openstack --os-cloud={user cloud name router set
 #### Delete Router
 
 ``` shell
-openstack --os-cloud={user cloud name router add subnet <router> <subnet>
+openstack --os-cloud={cloud name} router add subnet <router> <subnet>
 ```
 
 #### Create Router Port
 
 
 ``` shell
-openstack --os-cloud={user cloud name port create [-h] [-f {json,shell,table,value,yaml}]
+openstack --os-cloud={cloud name} port create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] --network <network>
@@ -130,17 +130,17 @@ openstack --os-cloud={user cloud name port create [-h] [-f {json,shell,table,val
 #### Creating a Router with Subnets Example
 
 ``` shell
-openstack --os-cloud=$CLOUD router create {router_name}
+openstack --os-cloud={cloud name} router create {router_name}
 ```
 
 Add subnet to the router and set the router's external gateway using PUBLICNET to allow outbound network access.
 
 ``` shell
-openstack --os-cloud=$CLOUD router add subnet {router_name} {subnet_name}
+openstack --os-cloud={cloud name} router add subnet {router_name} {subnet_name}
 ```
 
 Set the external gateway
 
 ``` shell
-openstack --os-cloud=$CLOUD router set --external-gateway PUBLICNET {router_name}
+openstack --os-cloud={cloud name} router set --external-gateway PUBLICNET {router_name}
 ```
diff --git a/docs/openstack-servers.md b/docs/openstack-servers.md
@@ -108,13 +108,13 @@ You will need to get your cloud name from your `clouds.yaml`. More information o
 First we are going to create our network "my_network"
 
 ``` shell
-openstack --os-cloud=$CLOUD network create my_network
+openstack --os-cloud={cloud name} network create my_network
 ```
 
 Second create the subnet "my_subnet"
 
 ``` shell
-openstack --os-cloud=$CLOUD subnet create --ip-version 4 \
+openstack --os-cloud={cloud name} subnet create --ip-version 4 \
                                           --subnet-range $CIDR \
                                           --network $NETWORK_NAME \
                                           $CIDR
@@ -123,33 +123,33 @@ openstack --os-cloud=$CLOUD subnet create --ip-version 4 \
 Third create the router "my_router"
 
 ``` shell
-openstack --os-cloud=$CLOUD router create my_router
+openstack --os-cloud={cloud name} router create my_router
 ```
 
 Fourth add "my_subnet" to "my_router" and set the router's external gateway using PUBLICNET to allow outbound network access.
 
 ``` shell
-openstack --os-cloud=$CLOUD router add subnet my_router my_dmz_subnet
+openstack --os-cloud={cloud name} router add subnet my_router my_dmz_subnet
 ```
 
 Set the external gateway
 
 ``` shell
-openstack --os-cloud=$CLOUD router set --external-gateway PUBLICNET my_router
+openstack --os-cloud={cloud name} router set --external-gateway PUBLICNET my_router
 ```
 
 Fifth gather the UUIDS for our image, flavor and network to create our server.
 
 ``` shell
-openstack --os-cloud=$CLOUD image list
-openstack --os-cloud=$CLOUD flavor list
-openstack --os-cloud=$CLOUD network list
+openstack --os-cloud={cloud name} image list
+openstack --os-cloud={cloud name} flavor list
+openstack --os-cloud={cloud name} network list
 ```
 
 Lastly create your server!
 
 ``` shell
-openstack --os-cloud=$CLOUD server create --flavor $FLAVOR_NAME \
+openstack --os-cloud={cloud name} server create --flavor $FLAVOR_NAME \
                                           --image $IMAGE_NAME \
                                           --boot-from-volume 25 \
                                           --network $NETWORK_NAME \