From 3a6953a323bf7e11de815d03590d29a40283308e Mon Sep 17 00:00:00 2001 From: Benjamin Ritter Date: Fri, 12 Jun 2026 14:40:07 +0000 Subject: [PATCH] docs: document the OS image lifecycle and provisioning model Signed-off-by: Benjamin Ritter --- docs/04-For Operators/02-operating-systems.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/04-For Operators/02-operating-systems.md b/docs/04-For Operators/02-operating-systems.md index 6155438..db37363 100644 --- a/docs/04-For Operators/02-operating-systems.md +++ b/docs/04-For Operators/02-operating-systems.md @@ -28,6 +28,24 @@ The supported images for firewalls are: | :------- | :----------- | :------ | -------- | | Linux | Ubuntu | 3 | 24.04 | +## Image Lifecycle + +Our images are derived from the official Docker images of the respective distribution. On top of that, we add the components required by the metal-stack infrastructure, e.g. FRR for routing-to-the-host and automation tools like [cloud-init](https://docs.cloud-init.io/en/latest/index.html) to run user provided post-install tasks. + +Every image registered with the metal-api carries one of the following lifecycle classifications: + +| Classification | Meaning | +| :------------- | :--------------------------------------------------------------------------------------- | +| preview | Recently introduced image, not yet recommended for production use | +| supported | Regularly updated and scanned image, recommended for production use | +| deprecated | Image will expire and be removed soon, users should switch to a newer image | + +These classifications prevent breaking changes in new images from affecting production workloads. + +:::info +Operating system images are provided by the operators of a metal-stack installation, not by its end-users. End-users can only choose from the images that have been registered with the metal-api. If you require an additional image in an installation, get in touch with your operators. +::: + ## Building Your Own Images It is fully possible to build your own operating system images and provision them through the metal-stack without any in-tree implementations.