Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
683432c
Feat: restructure docs site using new info architecture
thisisobate Jun 3, 2026
cd000ab
fix: track _index.md section files (fix sidebar collapse on staging)
thisisobate Jun 3, 2026
1689f20
chore: nit fixes
thisisobate Jun 9, 2026
70af246
chore: fix relative linking in docs
thisisobate Jun 11, 2026
e27d671
docs: port main's OracleCloud/Rackspace updates to new virt-options i…
John15321 Jun 18, 2026
4fcb2f1
Add documentation for deploying Flatcar Container Linux on various vi…
John15321 Jun 19, 2026
8ef1eee
Merge pull request #601 from flatcar/reorg-deploy-cloud-virt-options
John15321 Jun 19, 2026
29068c6
move links to cloud providers
mcevoy-building7 Jun 30, 2026
a145a34
move links to virtualizatin options
mcevoy-building7 Jun 30, 2026
90be490
move links to bare metal
mcevoy-building7 Jun 30, 2026
228b44a
move links to image customization
mcevoy-building7 Jun 30, 2026
f3cee24
move links to updates and releases
mcevoy-building7 Jun 30, 2026
c386d8b
move links to managing clusters
mcevoy-building7 Jun 30, 2026
0baed67
move links to storage setup
mcevoy-building7 Jun 30, 2026
a309937
move links to security
mcevoy-building7 Jun 30, 2026
add2a71
move links to debugging
mcevoy-building7 Jun 30, 2026
cee2ed1
move links to container runtimes
mcevoy-building7 Jun 30, 2026
9b49c72
move links to dev guide
mcevoy-building7 Jun 30, 2026
2d9ea7f
move links to dev guides part two
mcevoy-building7 Jun 30, 2026
2921515
move links to developer guides mixed in
mcevoy-building7 Jun 30, 2026
74fdd7b
Update content/docs/latest/deploy/bare-metal/_index.md
John15321 Jun 30, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ themes/flatcar/yarn.lock
themes/flatcar/static/css/.sass-cache
external-docs/
resources/
.hvm

# Temporary lock file while building
/.hugo_build.lock
2 changes: 1 addition & 1 deletion content/docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
_index.md
/_index.md
184 changes: 92 additions & 92 deletions content/docs/latest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,96 +193,96 @@ APIs and troubleshooting guides for working with Flatcar Container Linux.
* [Migrating from cloud-config to Container Linux Config][migrating-from-cloud-config]
* [Flatcar Supply Chain Security (SLSA and SPDX SBOM)][supply-chain-security] detailing security mechanisms employed at build / release time as well as at run-time to ensure validity of inputs processed and outputs shipped.

[quick-start]: installing
[learning-series]: learning-series
[supply-chain-security]: reference/supply-chain
[ignition-what]: provisioning/ignition/
[ignition-boot]: provisioning/ignition/boot-process
[ignition-network]: provisioning/ignition/network-configuration
[ignition-metadata]: provisioning/ignition/dynamic-data
[container-linux-config]: provisioning/cl-config/
[config-transpiler]: provisioning/config-transpiler/
[config-intro]: provisioning/config-transpiler/getting-started
[config-dynamic-data]: provisioning/config-transpiler/dynamic-data
[config-examples]: provisioning/config-transpiler/examples
[quick-start]: ./getting-started
[learning-series]: ./getting-started/learning-series
[supply-chain-security]: ./security/supply-chain
[ignition-what]: ./fb-provision/ignition/
[ignition-boot]: ./fb-provision/ignition/boot-process
[ignition-network]: ./fb-provision/ignition/network-configuration
[ignition-metadata]: ./fb-provision/ignition/dynamic-data
[container-linux-config]: ./fb-provision/cl-config/
[config-transpiler]: ./fb-provision/butane/
[config-intro]: ./fb-provision/butane/getting-started
[config-dynamic-data]: ./fb-provision/butane/dynamic-data
[config-examples]: ./fb-provision/butane/examples
[matchbox]: https://matchbox.psdn.io/
[ipxe]: installing/bare-metal/booting-with-ipxe
[pxe]: installing/bare-metal/booting-with-pxe
[install-to-disk]: installing/bare-metal/installing-to-disk
[boot-iso]: installing/bare-metal/booting-with-iso
[filesystem-placement]: setup/storage/raid
[migrate-from-container-linux]: migrating-from-coreos/
[update-from-container-linux]: migrating-from-coreos/update-from-container-linux
[ec2]: installing/cloud/aws-ec2
[digital-ocean]: installing/cloud/digitalocean
[gce]: installing/cloud/gcp
[azure]: installing/cloud/azure
[qemu]: installing/vms/qemu
[libvirt]: installing/vms/libvirt
[virtualbox]: installing/vms/virtualbox
[vagrant]: installing/vms/vagrant
[hyper-v]: installing/vms/hyper-v
[kubevirt]: installing/vms/kubevirt
[proxmoxve]: installing/community-platforms/proxmoxve
[vmware]: installing/community-platforms/vmware
[cluster-architectures]: setup/clusters/architectures
[update-strategies]: setup/releases/update-strategies
[clustering-machines]: setup/clusters/discovery
[verify-container-linux]: setup/releases/verify-images
[networkd-customize]: setup/customization/network-config-with-networkd
[systemd-drop-in]: setup/systemd/drop-in-units
[environment-variables-systemd]: setup/systemd/environment-variables
[dns]: setup/customization/configuring-dns
[date-timezone]: setup/customization/configuring-date-and-timezone
[users]: setup/customization/adding-users
[parameters]: setup/customization/other-settings
[disk-space]: setup/storage/adding-disk-space
[mounting-storage]: setup/storage/mounting-storage
[power-management]: setup/customization/power-management
[registry-authentication]: container-runtimes/registry-authentication
[iscsi]: setup/storage/iscsi
[swap]: setup/storage/adding-swap
[zfsextension]: setup/storage/zfs
[ec2-container-service]: setup/clusters/booting-on-ecs/
[manage-docker-containers]: setup/systemd/getting-started
[udev-rules]: setup/systemd/udev-rules
[update-conf]: setup/releases/update-conf
[release-channels]: setup/releases/switching-channels
[tasks-with-systemd]: setup/systemd/timers
[luks-encryption]: setup/security/luks
[ssh-daemon]: setup/security/customizing-sshd
[sssd-container-linux]: setup/security/sssd
[hardening-container-linux]: setup/security/hardening-guide
[hardware-requirements]: setup/security/trusted-computing-hardware-requirements
[cert-authorities]: setup/security/adding-certificate-authorities
[selinux]: setup/security/selinux
[disabling-smt]: setup/security/disabling-smt
[enabling-fips]: setup/security/fips
[audit-system]: setup/security/audit
[debugging-tools]: setup/debug/install-debugging-tools
[btrfs]: setup/debug/btrfs-troubleshooting
[system-log]: setup/debug/reading-the-system-log
[crash-log]: setup/debug/collecting-crash-logs
[container-linux-rollbacks]: setup/debug/manual-rollbacks
[docker]: container-runtimes/getting-started-with-docker
[customizing-docker]: container-runtimes/customizing-docker
[use-a-custom-docker-or-containerd-version]: container-runtimes/use-a-custom-docker-or-containerd-version
[developer-guides]: reference/developer-guides/
[integrations]: reference/integrations/
[migrating-from-cloud-config]: provisioning/cl-config/from-cloud-config
[containerd-for-kubernetes]: container-runtimes/switching-from-docker-to-containerd-for-kubernetes
[terraform]: provisioning/terraform/
[hetzner]: installing/cloud/hetzner
[sysext]: provisioning/sysext/
[acpi]: setup/customization/ACPI
[openstack]: installing/cloud/openstack
[brightbox]: installing/cloud/brightbox
[kubernetes]: container-runtimes/getting-started-with-kubernetes
[ha-kubernetes]: container-runtimes/high-availability-kubernetes
[using-nvidia]: setup/customization/using-nvidia
[scaleway]: installing/community-platforms/scaleway
[oraclecloud]: installing/community-platforms/oraclecloud
[ovhcloud]: installing/community-platforms/ovhcloud
[akamai]: installing/cloud/akamai
[nebraska]: nebraska
[stackit]: installing/cloud/stackit
[ipxe]: ./deploy/bare-metal/booting-with-ipxe
[pxe]: ./deploy/bare-metal/booting-with-pxe
[install-to-disk]: ./deploy/bare-metal/installing-to-disk
[boot-iso]: ./deploy/bare-metal/booting-with-iso
[filesystem-placement]: ./os-config/storage/raid
[migrate-from-container-linux]: ./coreos-migration/
[update-from-container-linux]: ./coreos-migration/update-from-container-linux
[ec2]: ./deploy/cloud/aws-ec2
[digital-ocean]: ./deploy/cloud/digitalocean
[gce]: ./deploy/cloud/gcp
[azure]: ./deploy/cloud/azure
[qemu]: ./fb-provision/vms/qemu
[libvirt]: ./fb-provision/vms/libvirt
[virtualbox]: ./fb-provision/vms/virtualbox
[vagrant]: ./fb-provision/vms
[hyper-v]: ./fb-provision/vms/hyper-v
[kubevirt]: ./fb-provision/vms/kubevirt
[proxmoxve]: ./deploy/virt-options/proxmoxve
[vmware]: ./deploy/cloud/vmware
[cluster-architectures]: ./orchestrate/clusters/architectures
[update-strategies]: ./updates-releases/releases/update-strategies
[clustering-machines]: ./orchestrate/clusters/discovery
[verify-container-linux]: ./updates-releases/releases/verify-images
[networkd-customize]: ./os-config/network/network-config-with-networkd
[systemd-drop-in]: ./os-config/host-config/drop-in-units
[environment-variables-systemd]: ./os-config/host-config/environment-variables
[dns]: ./os-config/network/configuring-dns
[date-timezone]: ./os-config/host-config/configuring-date-and-timezone
[users]: ./os-config/host-config/adding-users
[parameters]: ./os-config/host-config/other-settings
[disk-space]: ./os-config/storage/adding-disk-space
[mounting-storage]: ./os-config/storage/mounting-storage
[power-management]: ./os-config/host-config/power-management
[registry-authentication]: ./orchestrate/containers/registry-authentication
[iscsi]: ./os-config/storage/iscsi
[swap]: ./os-config/storage/adding-swap
[zfsextension]: ./os-config/storage/zfs
[ec2-container-service]: ./orchestrate/clusters/booting-on-ecs/
[manage-docker-containers]: ./os-config/systemd/getting-started
[udev-rules]: ./os-config/systemd/udev-rules
[update-conf]: ./updates-releases/releases/update-conf
[release-channels]: ./updates-releases/releases/switching-channels
[tasks-with-systemd]: ./os-config/host-config/timers
[luks-encryption]: ./security/encryption/luks
[ssh-daemon]: ./security/cert-auth/customizing-sshd
[sssd-container-linux]: ./security/cert-auth/sssd
[hardening-container-linux]: ./security/hardening/hardening-guide
[hardware-requirements]: ./security/hardening/trusted-computing-hardware-requirements
[cert-authorities]: ./security/cert-auth/adding-certificate-authorities
[selinux]: ./security/encryption/selinux
[disabling-smt]: ./security/hardening/disabling-smt
[enabling-fips]: ./security/hardening/fips
[audit-system]: ./security/hardening/audit
[debugging-tools]: ./diagnostics/install-debugging-tools
[btrfs]: ./diagnostics/btrfs-troubleshooting
[system-log]: ./diagnostics/reading-the-system-log
[crash-log]: ./diagnostics/collecting-crash-logs
[container-linux-rollbacks]: ./diagnostics/manual-rollbacks
[docker]: ./orchestrate/containers/getting-started-with-docker
[customizing-docker]: ./orchestrate/containers/customizing-docker
[use-a-custom-docker-or-containerd-version]: ./orchestrate/containers/use-a-custom-docker-or-containerd-version
[developer-guides]: ./devguide/
[integrations]: ./devguide/integrations/
[migrating-from-cloud-config]: ./fb-provision/cl-config/from-cloud-config
[containerd-for-kubernetes]: ./orchestrate/containers/switching-from-docker-to-containerd-for-kubernetes
[terraform]: ./fb-provision/infrastructure/
[hetzner]: ./deploy/cloud/hetzner
[sysext]: ./sys-ext/
[acpi]: ./os-config/network/ACPI
[openstack]: ./deploy/cloud/openstack
[brightbox]: ./deploy/cloud/brightbox
[kubernetes]: ./orchestrate/kubernetes/getting-started-with-kubernetes
[ha-kubernetes]: ./orchestrate/kubernetes/high-availability-kubernetes
[using-nvidia]: ./os-config/host-config/using-nvidia
[scaleway]: ./deploy/virt-options/scaleway
[oraclecloud]: ./deploy/virt-options/oraclecloud
[ovhcloud]: ./deploy/virt-options/ovhcloud
[akamai]: ./deploy/cloud/akamai
[nebraska]: ./updates-releases/nebraska
[stackit]: ./deploy/cloud/stackit
5 changes: 2 additions & 3 deletions content/docs/latest/contribute/_index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: How to Contribute
content_type: contribute
weight: 130
weight: 120
---

Flatcar documentation is released under the [Apache 2.0 License][asl], and we welcome contributions. Check out the [help-wanted tag][help-wanted] in this project's Issues list for good places to start participating.

Submit fixes and additions in the form of [GitHub *Pull Requests* (PRs)][pull-requests]. The general process is the typical git fork-branch-PR-review-merge cycle:
Submit fixes and additions in the form of [GitHub _Pull Requests_ (PRs)][pull-requests]. The general process is the typical git fork-branch-PR-review-merge cycle:

1. Fork this repository into your GitHub account
2. Make changes in a topic branch or your fork's `master`
Expand Down Expand Up @@ -50,7 +50,6 @@ We happily accept accurate translations. Please send the documents as a pull req

2. Add an explanation about the translated document to the top of the file: "These documents were translated into Esperanto by Community Member <person@example.com> and last updated on 2015-12-01. If you find inaccuracies or problems please file an issue on GitHub."


[asl]: https://github.com/flatcar/flatcar-docs/blob/main/LICENSE
[flatcar-docs]: https://flatcar.org/docs/latest/
[help-wanted]: https://github.com/flatcar/Flatcar/labels/kind%2Fdocs
Expand Down
2 changes: 1 addition & 1 deletion content/docs/latest/contribute/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Some file types are commonly identified with more than one file name extension.


[command-line-grammar]: #command-line-grammar
[configuring-dns]: ../../setup/customization/configuring-dns
[configuring-dns]: ../os-config/network/configuring-dns
[flatcar-docs]: https://docs.flatcar-linux.org/
[economist-hyphens]: http://www.economist.com/news/books-and-arts/21723088-hyphens-can-be-tricky-they-need-not-drive-you-crazy-hysteria-over-hyphens
[eos]: https://faculty.washington.edu/heagerty/Courses/b572/public/StrunkWhite.pdf "The Elements of Style"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Migration from CoreOS Container Linux
linktitle: Migrating from CoreOS
weight: 110
weight: 100
aliases:
- os/migrate-from-container-linux
- /docs/latest/migrating-from-coreos/
- os/migrate-from-container-linux
---

While Flatcar is compatible with CoreOS Container Linux there are some naming differences you need to be aware of.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Updating from CoreOS Container Linux
linktitle: Updating from CoreOS
weight: 10
aliases:
- /docs/latest/migrating-from-coreos/update-from-container-linux/
- ../os/update-from-container-linux
---

Expand Down Expand Up @@ -109,4 +110,4 @@ sudo update_engine_client -update
```

[migrate-from-container-linux]: _index.md
[manual-rollback]: ../setup/debug/manual-rollbacks/#performing-a-manual-rollback
[manual-rollback]: ../diagnostics/manual-rollbacks#performing-a-manual-rollback
6 changes: 6 additions & 0 deletions content/docs/latest/deploy/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Deployments
weight: 50
description: >
Deploy Flatcar Container Linux to cloud providers, virtualization platforms, and bare metal.
---
20 changes: 20 additions & 0 deletions content/docs/latest/deploy/bare-metal/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Bare Metal
weight: 30
description: This section provides information and guidance on running Flatcar instances in bare-metal environments.
aliases:
- /docs/latest/installing/bare-metal/
- ../bare-metal
---

You can install Flatcar on bare metal machines in different ways: using ISO
images, booting from PXE or iPXE, and even by running an installation
script on an existing Linux system.

* [Installing from ISO images][boot-iso]
* [Booting with PXE][pxe]
* [Booting with iPXE][ipxe]
* [Installing with flatcar-install][install-to-disk]
* [Raspberry Pi 4][running-flatcar-container-linux-on-raspberry-Pi-4]


Comment on lines +10 to +20
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Booting Flatcar Container Linux via iPXE
linktitle: Booting via iPXE
weight: 30
aliases:
- /docs/latest/installing/bare-metal/booting-with-ipxe/
- ../../os/booting-with-ipxe
- ../../bare-metal/booting-with-ipxe
---
Expand Down Expand Up @@ -161,13 +162,13 @@ Similar to the [OEM partition][oem] in Flatcar Container Linux disk images, iPXE

Now that you have a machine booted it is time to play around. Check out the [Flatcar Container Linux Quickstart][quickstart] guide or dig into [more specific topics][doc-index].

[cl-configs]: ../../provisioning/cl-config
[butane-configs]: ../../provisioning/config-transpiler
[ignition]: ../../provisioning/ignition
[ignition-kargs-ip]: ../../provisioning/ignition/network-configuration/#using-static-ip-addresses-with-ignition
[cl-configs]: ../../fb-provision/cl-config
[butane-configs]: ../../fb-provision/butane
[ignition]: ../../fb-provision/ignition
[ignition-kargs-ip]: ../../fb-provision/ignition/network-configuration#using-static-ip-addresses-with-ignition
[oem]: ../community-platforms/notes-for-distributors#image-customization
[installing-to-disk]: installing-to-disk
[update-strategies]: ../../setup/releases/update-strategies
[update-strategies]: ../../updates-releases/releases/update-strategies
[release-notes]: https://flatcar-linux.org/releases
[pxe-installation]: booting-with-pxe#installation
[pxe-custom-oem]: booting-with-pxe#adding-a-custom-oem
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Booting Flatcar Container Linux from an ISO
linktitle: Booting from an ISO
weight: 10
aliases:
- /docs/latest/installing/bare-metal/booting-with-iso/
- ../../os/booting-with-iso
- ../../bare-metal/booting-with-iso
---
Expand Down Expand Up @@ -62,5 +63,5 @@ The most common use-case for this ISO is to install Flatcar Container Linux to d

The ISO is configured to start a shell on the console without prompting for a password. This is convenient for installation and troubleshooting, but use caution.

[cl-configs]: ../../provisioning/cl-config
[cl-configs]: ../../fb-provision/cl-config
[installing-to-disk]: installing-to-disk
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Booting Flatcar Container Linux via PXE
linktitle: Booting via PXE
weight: 20
aliases:
- /docs/latest/installing/bare-metal/booting-with-pxe/
- ../../os/booting-with-pxe
- ../../bare-metal/booting-with-pxe
---
Expand Down Expand Up @@ -249,12 +250,12 @@ Now that you have a machine booted it is time to play around. Check out the [Fla
[append-initrd]: http://www.syslinux.org/wiki/index.php?title=SYSLINUX#INITRD_initrd_file
[flatcar-user]: https://groups.google.com/forum/#!forum/flatcar-linux-user
[discord]: https://discord.gg/PMYjFUsJyq
[butane-configs]: ../../provisioning/config-transpiler
[ignition]: ../../provisioning/ignition
[ignition-kargs-ip]: ../../provisioning/ignition/network-configuration/#using-static-ip-addresses-with-ignition
[butane-configs]: ../../fb-provision/butane
[ignition]: ../../fb-provision/ignition
[ignition-kargs-ip]: ../../fb-provision/ignition/network-configuration#using-static-ip-addresses-with-ignition
[oem]: ../community-platforms/notes-for-distributors#image-customization
[installing-to-disk]: installing-to-disk
[update-strategies]: ../../setup/releases/update-strategies
[update-strategies]: ../../updates-releases/releases/update-strategies
[release-notes]: https://flatcar-linux.org/releases
[quickstart]: ../
[doc-index]: ../../
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: >
a running system.
weight: 40
aliases:
- /docs/latest/installing/bare-metal/installing-to-disk/
- ../../os/installing-to-disk
- ../../bare-metal/installing-to-disk
---
Expand Down Expand Up @@ -171,10 +172,10 @@ Now that you have a machine booted it is time to play around. Check out the [Fla

[quickstart]: ../
[docs-root]: ../../
[update-strategies]: ../../setup/releases/update-strategies
[update-strategies]: ../../updates-releases/releases/update-strategies
[release-notes]: https://flatcar-linux.org/releases
[flatcar-iso]: booting-with-iso
[butane-section]: #butane-configs
[flatcar-install]: https://raw.githubusercontent.com/flatcar/init/flatcar-master/bin/flatcar-install
[cl-configs]: ../../provisioning/cl-config
[butane]: ../../provisioning/config-transpiler
[cl-configs]: ../../fb-provision/cl-config
[butane]: ../../fb-provision/butane
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Running Flatcar Container Linux on Raspberry Pi 4
linktitle: Running on Raspberry Pi 4
weight: 50
aliases:
- /docs/latest/installing/bare-metal/raspberry-pi/
---
### Hardware Requirements

Expand Down
Loading