Skip to content

Commit

Permalink
DOC: Update Cloud Onboarding pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Derek Noble authored and Derek Noble committed Sep 5, 2024
1 parent f0720b6 commit 3eddea8
Show file tree
Hide file tree
Showing 8 changed files with 107 additions and 89 deletions.
58 changes: 29 additions & 29 deletions docs/openstack-floating-ips.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ To read more about Openstack Floating Ips using the [upstream docs](https://docs
#### List and view floating ips

``` shell
openstack floating ip list
openstack --os-cloud={cloud name} floating ip list
[--network <network>]
[--port <port>]
[--fixed-ip-address <ip-address>]
Expand All @@ -18,7 +18,7 @@ openstack floating ip list
#### Create a floating ip
``` shell
openstack floating ip create
openstack --os-cloud={cloud name} floating ip create
[--subnet <subnet>]
[--port <port>]
[--floating-ip-address <ip-address>]
Expand All @@ -36,15 +36,15 @@ openstack floating ip create
``` shell
openstack floating ip delete <floating-ip> [<floating-ip> ...]
openstack --os-cloud={cloud name} floating ip delete <floating-ip> [<floating-ip> ...]
```
#### Floating ip set
Set floating IP properties
``` shell
openstack floating ip set
openstack --os-cloud={cloud name} floating ip set
--port <port>
[--fixed-ip-address <ip-address>]
<floating-ip>
Expand All @@ -53,13 +53,13 @@ openstack floating ip set
#### Display floating ip details
``` shell
openstack floating ip show $VIP
openstack --os-cloud={cloud name} floating ip show $VIP
```
#### Unset floating IP Properties
``` shell
openstack floating ip unset --port $VIP
openstack --os-cloud={cloud name} floating ip unset --port $VIP
```
#### Associate floating IP addresses
Expand All @@ -69,21 +69,21 @@ You can assign a floating IP address to a project and to an instance.
Associate an IP address with an instance in the project, as follows:
``` shell
openstack server add floating ip $INSTANCE_UUID $VIP
openstack --os-cloud={cloud name} server add floating ip $INSTANCE_UUID $VIP
```
#### Disassociate floating IP addresses
To disassociate a floating IP address from an instance:
``` shell
openstack server remove floating ip $INSTANCE_UUID $VIP
openstack --os-cloud={cloud name} server remove floating ip $INSTANCE_UUID $VIP
```
To remove the floating IP address from a project:
``` shell
openstack floating ip delete $VIP
openstack --os-cloud={cloud name} floating ip delete $VIP
```
#### Floating Ip Example
Expand All @@ -95,19 +95,19 @@ You will need to get your cloud name from your `clouds.yaml`. More information o
First create a floating ip either from PUBLICNET or the public ip pool.
``` shell
openstack --os-cloud $CLOUD floating ip create PUBLICNET
openstack --os-cloud={cloud name} floating ip create PUBLICNET
```
Second get the cloud server UUID.
``` shell
openstack --os-cloud $CLOUD server list
openstack --os-cloud={cloud name} server list
```
Third add the floating ip to the server
``` shell
openstack --os-cloud $CLOUD server add floating ip $UUID $VIP
openstack --os-cloud={cloud name} server add floating ip $UUID $VIP
```
#### Shared floating IP and virtual IP
Expand All @@ -133,13 +133,13 @@ With that caveat, you can set up a shared floating IP like this:
1. Create a Neutron network
``` shell
openstack network create tester-network
openstack --os-cloud={cloud name} network create tester-network
```
2. Create a subnet for the network
``` shell
openstack subnet create --network tester-network \
openstack --os-cloud={cloud name} subnet create --network tester-network \
--subnet-range $CIDR \
tester-subnet
```
Expand All @@ -149,7 +149,7 @@ With that caveat, you can set up a shared floating IP like this:
Create `tester1` server.
``` shell
openstack server create tester1 --flavor m1.tiny \
openstack --os-cloud={cloud name} server create tester1 --flavor m1.tiny \
--key-name keypair \
--network tester-network \
--image $IMAGE_UUID
Expand All @@ -158,7 +158,7 @@ With that caveat, you can set up a shared floating IP like this:
Create `tester2` server.
``` shell
openstack server create tester2 --flavor m1.tiny \
openstack --os-cloud={cloud name} server create tester2 --flavor m1.tiny \
--key-name keypair \
--network tester-network \
--image $IMAGE_UUID
Expand All @@ -167,7 +167,7 @@ With that caveat, you can set up a shared floating IP like this:
4. Create a port with a fixed IP for the VIP.
``` shell
openstack port create --fixed-ip subnet=tester-subnet \
openstack --os-cloud={cloud name} port create --fixed-ip subnet=tester-subnet \
--network tester-network \
--no-security-group tester-vip-port
```
Expand All @@ -180,7 +180,7 @@ With that caveat, you can set up a shared floating IP like this:
public IP, depending on your configuration.
``` shell
openstack router create tester-router
openstack --os-cloud={cloud name} router create tester-router
```
6. Add at external Internet gateway to the router
Expand All @@ -190,13 +190,13 @@ With that caveat, you can set up a shared floating IP like this:
for your own installation.
``` shell
openstack router set --external-gateway PUBLICNET tester-router
openstack --os-cloud={cloud name} router set --external-gateway PUBLICNET tester-router
```
7. Add the subnet to the router
``` shell
openstack router add subnet tester-router tester-subnet
openstack --os-cloud={cloud name} router add subnet tester-router tester-subnet
```
8. Create a floating IP for the port
Expand All @@ -207,7 +207,7 @@ With that caveat, you can set up a shared floating IP like this:
here.
``` shell
openstack floating ip create --port tester-vip-port PUBLICNET
openstack --os-cloud={cloud name} floating ip create --port tester-vip-port PUBLICNET
```
Note and retain the ID and/or IP returned, since you will need it for the
Expand All @@ -225,13 +225,13 @@ With that caveat, you can set up a shared floating IP like this:
instances.
``` shell
openstack port list server tester1 # retrieve port UUID
openstack port set --allowed-address ip-address=<VIP> <port1UUID>
openstack --os-cloud={cloud name} port list server tester1 # retrieve port UUID
openstack --os-cloud={cloud name} port set --allowed-address ip-address=<VIP> <port1UUID>
```
``` shell
openstack port list server tester2 # retrieve port UUID
openstack port set --allowed-address ip-address=<VIP> <port2UUID>
openstack --os-cloud={cloud name} port list server tester2 # retrieve port UUID
openstack --os-cloud={cloud name} port set --allowed-address ip-address=<VIP> <port2UUID>
```
The steps above complete creating the shared floating IP and VIP. The following
Expand All @@ -246,7 +246,7 @@ steps allow you to test it.
shows only a test.
``` shell
openstack server create tester-bastion --flavor m1.tiny \
openstack --os-cloud={cloud name} server create tester-bastion --flavor m1.tiny \
--key-name keypair \
--network tester-network \
--image $IMAGE_UUID
Expand All @@ -257,7 +257,7 @@ steps allow you to test it.
You can specify the UUID or IP of the floating IP.
``` shell
openstack server add floating ip tester-bastion $UUID
openstack --os-cloud={cloud name} server add floating ip tester-bastion $UUID
```
3. Alter security group rules to allow SSH and ICMP:
Expand All @@ -267,15 +267,15 @@ steps allow you to test it.
steps because the default security group will prevent all ingress traffic.
``` shell
openstack security group rule create --proto tcp \
openstack --os-cloud={cloud name} security group rule create --proto tcp \
--dst-port 22 \
--remote-ip 0.0.0.0/0 default
```
Now enable ICMP.
``` shell
openstack security group rule create --proto icmp \
openstack --os-cloud={cloud name} security group rule create --proto icmp \
--dst-port -1 default
```
Expand Down
10 changes: 5 additions & 5 deletions docs/openstack-images.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ To read more about Openstack images please visit the [upstream docs](https://doc
#### List and view images

``` shell
openstack image list
openstack --os-cloud={cloud name} image list
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--public | --private]
Expand All @@ -17,13 +17,13 @@ openstack image list
#### View image details
``` shell
openstack image show <imageName>
openstack --os-cloud={cloud name} image show <imageName>
```
#### Create a image
``` shell
openstack image create
openstack --os-cloud={cloud name} image create
[--id <id>]
[--store <store>]
[--container-format <container-format>]
Expand All @@ -46,7 +46,7 @@ openstack image create
#### Delete a image
``` shell
openstack image delete <image> [<image> ...]
openstack --os-cloud={cloud name} image delete <image> [<image> ...]
```
#### Retrieving Images
Expand All @@ -58,7 +58,7 @@ Please visit this page for examples of retrieving images [here](https://docs.ope
Specify the server name, flavor ID, and image ID.
``` shell
openstack server create --flavor FLAVOR_ID --image IMAGE_ID --key-name KEY_NAME \
openstack --os-cloud={cloud name} server create --flavor FLAVOR_ID --image IMAGE_ID --key-name KEY_NAME \
--user-data USER_DATA_FILE --security-group SEC_GROUP_NAME --property KEY=VALUE \
INSTANCE_NAME
```
10 changes: 5 additions & 5 deletions docs/openstack-keypairs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Read more about Openstack keypairs using the [upstream docs](https://docs.openst
#### List and view Keypairs

``` shell
openstack keypair list
openstack --os-cloud={cloud name} keypair list
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--user <user>]
Expand All @@ -21,7 +21,7 @@ openstack keypair list
Before launching an instance, you must add a public key to the Compute service.

``` shell
openstack keypair create
openstack --os-cloud={cloud name} keypair create
[--public-key <file> | --private-key <file>]
[--type <type>]
[--user <user>]
Expand All @@ -40,15 +40,15 @@ This command generates a key pair with the name that you specify for KEY_NAME, w
If you have already generated a key pair and the public key is located at ~/.ssh/id_rsa.pub, run the following command to upload the public key.

``` shell
openstack keypair create --public-key ~/.ssh/id_rsa.pub KEY_NAME
openstack --os-cloud={cloud name} keypair create --public-key ~/.ssh/id_rsa.pub KEY_NAME
```

This command registers the public key at the Nova database and names the key pair the name that you specify for KEY_NAME

#### Delete a Keypair

``` shell
openstack keypair delete
openstack --os-cloud={cloud name} keypair delete
[--user <user>]
[--user-domain <user-domain>]
<key>
Expand All @@ -58,7 +58,7 @@ openstack keypair delete
#### Show Keypair Details

``` shell
openstack keypair show
openstack --os-cloud={cloud name} keypair show
[--public-key]
[--user <user>]
[--user-domain <user-domain>]
Expand Down
Loading

0 comments on commit 3eddea8

Please sign in to comment.