Skip to content

Commit f803561

Browse files
committed
doc: add Flatcar instructions
Signed-off-by: Mathieu Tortuyaux <[email protected]>
1 parent 6973487 commit f803561

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/book/src/topics/flatcar.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use Flatcar images
2+
3+
[Flatcar](https://flatcar.org) is a Linux based OS designed to run containers.
4+
5+
## How do I use Flatcar ?
6+
7+
Flatcar uses [Ignition](https://coreos.github.io/ignition/) for initial provisioning instead of cloud-init. It is first required to enable this feature gate before initializing the management cluster:
8+
```bash
9+
export EXP_KUBEADM_BOOTSTRAP_FORMAT_IGNITION=true
10+
```
11+
12+
Once done, proceed as documented to setup GCP variables. To set the `IMAGE_ID`, use this snippet to get the latest stable Flatcar image:
13+
```
14+
VERSION=$(curl -fsSL https://stable.release.flatcar-linux.net/amd64-usr/current/version.txt | grep --max-count=1 FLATCAR_VERSION | cut -d = -f 2- | tr '.' '-')
15+
export IMAGE_ID="projects/kinvolk-public/global/images/flatcar-stable-${VERSION}"
16+
```
17+
18+
## Generate the workload cluster configuration
19+
20+
Proceed as usual except for the flavor:
21+
```
22+
clusterctl generate cluster capi-gcp-quickstart --flavor flatcar > capi-gcp-quickstart.yaml
23+
```
24+
25+
## Updates configuration
26+
27+
Flatcar auto-update and Kubernetes patch updates are disabled by default. Set `export FLATCAR_DISABLE_AUTO_UPDATE=false` to enable it. This will pull latest Flatcar update and latest Kubernetes patch release. Note that this will reboot your nodes: [`kured`](https://kured.dev/) is recommended to coordinate the nodes reboot.

0 commit comments

Comments
 (0)