Skip to content

Commit 0665613

Browse files
lentzi90k8s-infra-cherrypick-robot
authored and
k8s-infra-cherrypick-robot
committed
Update CAPO quick-start docs
Add information about dependence on ORC. Fix whitespace. Signed-off-by: Lennart Jern <[email protected]>
1 parent 6172dd9 commit 0665613

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

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

+13-4
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,11 @@ Please follow the Cluster API Provider for [Oracle Cloud Infrastructure (OCI) Ge
709709
{{#/tab }}
710710
{{#tab OpenStack}}
711711
712+
Cluster API Provider OpenStack depends on [openstack-resource-controller] since v0.12.
713+
712714
```bash
715+
# Install ORC (needed for CAPO >=v0.12)
716+
kubectl apply -f https://github.com/k-orc/openstack-resource-controller/releases/latest/download/install.yaml
713717
# Initialize the management cluster
714718
clusterctl init --infrastructure openstack
715719
```
@@ -1076,7 +1080,7 @@ export HARVESTER_ENDPOINT=""
10761080
export HARVESTER_KUBECONFIG_B64="<HARVESTER_KUBECONFIG_ENCODED_IN_BASE64>"
10771081
# Namespace for all resources in the Management Cluster
10781082
export NAMESPACE="test"
1079-
# Pod CIDR for the Workload Cluster, it should have the format: 192.168.0.0/16
1083+
# Pod CIDR for the Workload Cluster, it should have the format: 192.168.0.0/16
10801084
export POD_CIDR="10.42.0.0/16"
10811085
# Service CIDR for the Workload Cluster, it should have the format : 192.168.0.0/16 and be different from POD_CIDR
10821086
export SERVICE_CIDR="10.43.0.0/16"
@@ -1144,7 +1148,7 @@ export IONOSCLOUD_DATACENTER_ID="<your-datacenter-id>"
11441148
# The IP of the control plane endpoint
11451149
export CONTROL_PLANE_ENDPOINT_IP=10.10.10.4
11461150
# The location of the data center where the cluster will be deployed
1147-
export CONTROL_PLANE_ENDPOINT_LOCATION=de/txl
1151+
export CONTROL_PLANE_ENDPOINT_LOCATION=de/txl
11481152
# The image ID of the custom image that will be used for the VMs
11491153
export IONOSCLOUD_MACHINE_IMAGE_ID="<your-image-id>"
11501154
# The SSH key that will be used to access the VMs
@@ -1233,21 +1237,25 @@ clusterctl generate cluster --infrastructure nutanix --list-variables capi-quick
12331237
A ClusterAPI compatible image must be available in your OpenStack. For instructions on how to build a compatible image
12341238
see [image-builder](https://image-builder.sigs.k8s.io/capi/capi.html).
12351239
Depending on your OpenStack and underlying hypervisor the following options might be of interest:
1240+
12361241
* [image-builder (OpenStack)](https://image-builder.sigs.k8s.io/capi/providers/openstack.html)
12371242
* [image-builder (vSphere)](https://image-builder.sigs.k8s.io/capi/providers/vsphere.html)
12381243
12391244
To see all required OpenStack environment variables execute:
1245+
12401246
```bash
12411247
clusterctl generate cluster --infrastructure openstack --list-variables capi-quickstart
12421248
```
12431249
12441250
The following script can be used to export some of them:
1251+
12451252
```bash
12461253
wget https://raw.githubusercontent.com/kubernetes-sigs/cluster-api-provider-openstack/master/templates/env.rc -O /tmp/env.rc
12471254
source /tmp/env.rc <path/to/clouds.yaml> <cloud>
12481255
```
12491256
12501257
Apart from the script, the following OpenStack environment variables are required.
1258+
12511259
```bash
12521260
# The list of nameservers for OpenStack Subnet being created.
12531261
# Set this value when you need create a new network/subnet while the access through DNS is required.
@@ -1408,10 +1416,10 @@ export CONTROL_PLANE_MACHINE_COUNT=1
14081416
export CONTROL_PLANE_PLANID=<plan_id>
14091417
export WORKER_MACHINE_COUNT=1
14101418
export WORKER_PLANID=<plan_id>
1411-
export MACHINE_IMAGE=<snapshot_id>
1419+
export MACHINE_IMAGE=<snapshot_id>
14121420
export REGION=<region>
14131421
export PLANID=<plan_id>
1414-
export VPCID=<vpc_id>
1422+
export VPCID=<vpc_id>
14151423
export SSHKEY_ID=<sshKey_id>
14161424
```
14171425
@@ -1882,6 +1890,7 @@ kind delete cluster
18821890
[KubeVirt provider]: https://github.com/kubernetes-sigs/cluster-api-provider-kubevirt/
18831891
[KubeVirt]: https://kubevirt.io/
18841892
[oci-provider]: https://oracle.github.io/cluster-api-provider-oci/#getting-started
1893+
[openstack-resource-controller]: https://k-orc.cloud/
18851894
[Equinix Metal getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-packet#using
18861895
[provider]:../reference/providers.md
18871896
[provider components]: ../reference/glossary.md#provider-components

0 commit comments

Comments
 (0)