Skip to content

Commit f541e1d

Browse files
committed
📖 Update quick start about OpenStack
1 parent bfb2a3b commit f541e1d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/book/src/user/quick-start.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,27 @@ wget https://raw.githubusercontent.com/kubernetes-sigs/cluster-api-provider-open
412412
source /tmp/env.rc <path/to/clouds.yaml> <cloud>
413413
```
414414

415+
Apart from the script, the following OpenStack environment variables are required.
416+
```bash
417+
# The IP address on which the API server is serving.
418+
export OPENSTACK_CONTROLPLANE_IP=<control plane ip>
419+
# The ID of an external OpenStack Network. This is necessary to get public internet to the VMs.
420+
export OPENSTACK_EXTERNAL_NETWORK_ID=<external network id>
421+
# The list of nameservers for OpenStack Subnet being created.
422+
# Set this value when you need create a new network/subnet while the access through DNS is required.
423+
export OPENSTACK_DNS_NAMESERVERS=<dns nameserver>
424+
# FailureDomain is the failure domain the machine will be created in.
425+
export OPENSTACK_FAILURE_DOMAIN=<availability zone name>
426+
# The flavor reference for the flavor for your server instance.
427+
export OPENSTACK_CONTROL_PLANE_MACHINE_FLAVOR=<flavor>
428+
# The flavor reference for the flavor for your server instance.
429+
export OPENSTACK_NODE_MACHINE_FLAVOR=<flavor>
430+
# The name of the image to use for your server instance. If the RootVolume is specified, this will be ignored and use rootVolume directly.
431+
export OPENSTACK_IMAGE_NAME=<image name>
432+
# SSHAuthorizedKeys specifies a list of ssh authorized keys for the user
433+
export OPENSTACK_SSH_AUTHORIZED_KEY=<ssh key>
434+
```
435+
415436
A full configuration reference can be found in [configuration.md](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/docs/configuration.md).
416437

417438
{{#/tab }}

0 commit comments

Comments
 (0)