Skip to content

Commit

Permalink
doc: add Flatcar instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Mathieu Tortuyaux <[email protected]>
  • Loading branch information
tormath1 committed Feb 4, 2025
1 parent 58b0101 commit cdb325b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- [Self-managed clusters](./self-managed/index.md)
- [Provisioning a Cluster](./self-managed/provision.md)
- [CNI](./self-managed/cni.md)
- [Flatcar provisioned cluster](./self-managed/flatcar.md)
- [Managed clusters - GKE](./managed/index.md)
- [Provisioning a Cluster](./managed/provision.md)
- [Cluster Upgrades](./managed/upgrades.md)
Expand Down
27 changes: 27 additions & 0 deletions docs/book/src/self-managed/flatcar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use Flatcar images

[Flatcar](https://flatcar.org) is a Linux based OS designed to run containers.

## How do I use Flatcar ?

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:
```bash
export EXP_KUBEADM_BOOTSTRAP_FORMAT_IGNITION=true
```

Once done, proceed as documented to setup GCP variables. To set the `IMAGE_ID`, use this snippet to get the latest stable Flatcar image:
```
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 '.' '-')
export IMAGE_ID="projects/kinvolk-public/global/images/flatcar-stable-${VERSION}"
```

## Generate the workload cluster configuration

Proceed as usual except for the flavor:
```
clusterctl generate cluster capi-gcp-quickstart --flavor flatcar > capi-gcp-quickstart.yaml
```

## Updates configuration

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 comments on commit cdb325b

Please sign in to comment.