From 237e6a5dbfbf46adb867f7177307ffd90de90ce5 Mon Sep 17 00:00:00 2001 From: Steven Presti Date: Tue, 26 Nov 2024 15:44:25 -0500 Subject: [PATCH] docs: update documentation for stablized and updated configs --- docs/examples.md | 8 ++++---- docs/release-notes.md | 14 +++++++++++++- docs/specs.md | 6 ++++-- docs/upgrading-fcos.md | 30 ++++++++++++++++++++++++++++++ 4 files changed, 51 insertions(+), 7 deletions(-) diff --git a/docs/examples.md b/docs/examples.md index b6061633..57d3fa2f 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -301,7 +301,7 @@ This example uses the shortcut `boot_device` syntax to configure an encrypted ro ```yaml variant: fcos -version: 1.6.0-experimental +version: 1.6.0 boot_device: layout: s390x-eckd luks: @@ -316,7 +316,7 @@ This example uses the shortcut `boot_device` syntax to configure an encrypted ro ```yaml variant: fcos -version: 1.6.0-experimental +version: 1.6.0 boot_device: layout: s390x-zfcp luks: @@ -331,7 +331,7 @@ This example uses the shortcut `boot_device` syntax to configure an encrypted ro ```yaml variant: fcos -version: 1.6.0-experimental +version: 1.6.0 boot_device: layout: s390x-virt luks: @@ -345,7 +345,7 @@ This example uses the shortcut `boot_device` syntax to configure an encrypted ro ```yaml variant: fcos -version: 1.6.0-experimental +version: 1.6.0 boot_device: layout: s390x-eckd luks: diff --git a/docs/release-notes.md b/docs/release-notes.md index 1b60416d..e039ab0d 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -8,7 +8,18 @@ nav_order: 9 ### Features -- Support LUKS encryption using IBM CEX secure keys on s390x _(fcos 1.6-exp)_ _(openshift 4.18.0-exp)_ +- Stabilize Fcos spec 1.6.0, targeting Ignition spec 3.5.0 +- Add Fedora CoreOS spec 1.7.0-experimental, targeting Ignition spec + 3.6.0-experimental +- Update Fiot spec 1.1.0-experimental to target Ignition spec + 3.6.0-experimental +- Update Flatcar spec 1.2.0-experimental to target Ignition spec + 3.6.0-experimental +- Update OpenShift spec 4.18.0-experimental, targeting Ignition spec + 3.6.0-experimental +- Update R4e spec 1.2.0-experimental to target Ignition spec + 3.6.0-experimental +- Support LUKS encryption using IBM CEX secure keys on s390x _(fcos 1.6)_ _(openshift 4.18.0-exp)_ ### Bug fixes @@ -19,6 +30,7 @@ nav_order: 9 - Re-vendor latest ignition release; 3.5.0-experimental becomes 3.5.0 + ## Butane 0.22.0 (2024-09-20) ### Features diff --git a/docs/specs.md b/docs/specs.md index ead1f45f..33c978ef 100644 --- a/docs/specs.md +++ b/docs/specs.md @@ -15,6 +15,7 @@ See the [Upgrading Configs](upgrading.md) page for instructions to update a conf We recommend that you always use the latest **stable** specification for your operating system to benefit from new features and bug fixes. The following **stable** specification versions are currently supported in Butane: - Fedora CoreOS (`fcos`) + - [v1.6.0](config-fcos-v1_6.md) - [v1.5.0](config-fcos-v1_5.md) - [v1.4.0](config-fcos-v1_4.md) - [v1.3.0](config-fcos-v1_3.md) @@ -46,7 +47,7 @@ We recommend that you always use the latest **stable** specification for your op Do not use **experimental** specifications for anything beyond **development and testing** as they are subject to change **without warning or announcement**. The following **experimental** specification versions are currently available in Butane: - Fedora CoreOS (`fcos`) - - [v1.6.0-experimental](config-fcos-v1_6-exp.md) + - [v1.7.0-experimental](config-fcos-v1_7-exp.md) - Flatcar (`flatcar`) - [v1.2.0-experimental](config-flatcar-v1_2-exp.md) - OpenShift (`openshift`) @@ -68,7 +69,8 @@ Each version of the Butane specification corresponds to a version of the Ignitio | `fcos` | 1.3.0 | 3.2.0 | | `fcos` | 1.4.0 | 3.3.0 | | `fcos` | 1.5.0 | 3.4.0 | -| `fcos` | 1.6.0-experimental | 3.5.0-experimental | +| `fcos` | 1.6.0 | 3.5.0 | +| `fcos` | 1.7.0-experimental | 3.6.0-experimental | | `flatcar` | 1.0.0 | 3.3.0 | | `flatcar` | 1.1.0 | 3.4.0 | | `flatcar` | 1.2.0-experimental | 3.5.0-experimental | diff --git a/docs/upgrading-fcos.md b/docs/upgrading-fcos.md index 3a4c89c7..97dc70a7 100644 --- a/docs/upgrading-fcos.md +++ b/docs/upgrading-fcos.md @@ -3,6 +3,36 @@ title: Fedora CoreOS parent: Upgrading configs nav_order: 1 --- +# Upgrading Fedora CoreOS configs + +Occasionally, changes are made to Fedora CoreOS Butane configs (those that specify `variant: fcos`) that break backward compatibility. While this is not a concern for running machines, since Ignition only runs one time during first boot, it is a concern for those who maintain configuration files. This document serves to detail each of the breaking changes and tries to provide some reasoning for the change. This does not cover all of the changes to the spec - just those that need to be considered when migrating from one version to the next. + +{: .no_toc } + +1. TOC +{:toc} + +## From Version 1.5.0 to Version 1.6.0 + +There are no breaking changes between versions 1.4.0 and 1.5.0 of the `fcos` configuration specification. Any valid 1.4.0 configuration can be updated to a 1.5.0 configuration by changing the version string in the config. + +The following is a list of notable new features. + +### Luks CEX support + +The `luks` sections in `storage` and `boot_device` gained a `cex` field. If enabled, this will configure an encrypted root filesystem on a s390x using IBM Crypto Express (CEX) card. + + +```yaml +variant: fcos +version: 1.6.0 +boot_device: + layout: s390x-eckd + luks: + device: /dev/dasda + cex: + enabled: true +``` # Upgrading Fedora CoreOS configs