Skip to content

Commit b14d23f

Browse files
committed
docs/configuration: add Flatcar to OS section
Signed-off-by: Mathieu Tortuyaux <[email protected]>
1 parent 95ef1e3 commit b14d23f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/book/src/clusteropenstack/configuration.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,21 @@ We currently require at least OpenStack Pike.
6969

7070
## Operating system image
7171

72-
We currently depend on an up-to-date version of cloud-init otherwise the operating system choice is yours. The kubeadm bootstrap provider we're using also depends on some pre-installed software like a container runtime, kubelet, kubeadm, etc.. . For an examples how to build such an image take a look at [image-builder (openstack)](https://image-builder.sigs.k8s.io/capi/providers/openstack.html).
72+
### cloud-init based images
73+
74+
We currently depend on an up-to-date version of cloud-init, otherwise the operating system choice is yours. The kubeadm bootstrap provider we're using also depends on some pre-installed software like a container runtime, kubelet, kubeadm, etc.. . For examples of how to build such an image take a look at [image-builder (openstack)](https://image-builder.sigs.k8s.io/capi/providers/openstack.html).
7375

7476
The image can be referenced by exposing it as an environment variable `OPENSTACK_IMAGE_NAME`.
7577

78+
### Ignition based images
79+
80+
Some OS like [Fedora CoreOS](https://getfedora.org/en/coreos) or [Flatcar](https://www.flatcar.org/) do not use cloud-init but [Ignition](https://coreos.github.io/ignition/) to provision the instance. You need to enable the [Ignition experimental feature](https://cluster-api.sigs.k8s.io/tasks/experimental-features/ignition.html): `export EXP_KUBEADM_BOOTSTRAP_FORMAT_IGNITION=true`
81+
82+
To use Flatcar image:
83+
* Build the image with the [image-builder](https://image-builder.sigs.k8s.io/capi/providers/openstack.html): `make OEM_ID=openstack build-qemu-flatcar`
84+
* Export the name of the uploaded image: `export OPENSTACK_FLATCAR_IMAGE_NAME=flatcar-stable-3374.2.5-kube-v1.25.6`
85+
* When generating the cluster configuration, use one of the following Cluster API [flavor](https://cluster-api.sigs.k8s.io/clusterctl/commands/generate-cluster.html?#flavors): `--flavor flatcar` or `--flavor external-cloud-provider-flatcar` (_NOTE_: If you select `external-cloud-provider-flatcar`, don't forget to refer to the [external-cloud-provider](https://cluster-api-openstack.sigs.k8s.io/topics/external-cloud-provider.html) section)
86+
7687
## SSH key pair
7788

7889
The SSH key pair is required. You can create one using,

0 commit comments

Comments
 (0)