From 3bd5d17d2256da2290ffc75ff4f238b13d2ad34e Mon Sep 17 00:00:00 2001 From: Arthur Chaloin Date: Wed, 10 Jan 2024 15:28:12 +0100 Subject: [PATCH] docs: add readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f0c6be1 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Flatcar Proxmox VE cloud image + +This repository contains a customized OEM partition for Flatcar that supports Proxmox VE. + +## Supported features + +- Set hostname +- Write SSH keys +- Write systemd networkd configuration +- Write attributes file (metadata) + +## How it works + +The following is run on Github Actions : + +- Download the latest Flatcar image (stable) +- Mount the OEM partition +- Write the contents of the `oem/` directory into the OEM partition +- Download and include our [forked Afterburn](https://github.com/coreos/afterburn/pull/1023) that supports Proxmox VE +- Bundle the image again and upload it to Github releases. + +## What's included in the OEM partition ? + +- Ignition configuration file that will write our custom files +- Systemd configuration files that run our modifed version of Afterburn. +- The forked afterburn binary