Rebuild and generate docs

coreos · Dec 2, 2024 · f8b4b3b · f8b4b3b
1 parent 6bb8fdf
commit f8b4b3b
Show file tree

Hide file tree

Showing 20 changed files with 2,269 additions and 14 deletions.
diff --git a/config/config.go b/config/config.go
@@ -39,7 +39,8 @@ import (
 	openshift4_15 "github.com/coreos/butane/config/openshift/v4_15"
 	openshift4_16 "github.com/coreos/butane/config/openshift/v4_16"
 	openshift4_17 "github.com/coreos/butane/config/openshift/v4_17"
-	openshift4_18_exp "github.com/coreos/butane/config/openshift/v4_18_exp"
+	openshift4_18 "github.com/coreos/butane/config/openshift/v4_18"
+	openshift4_19_exp "github.com/coreos/butane/config/openshift/v4_19_exp"
 	openshift4_8 "github.com/coreos/butane/config/openshift/v4_8"
 	openshift4_9 "github.com/coreos/butane/config/openshift/v4_9"
 	r4e1_0 "github.com/coreos/butane/config/r4e/v1_0"
@@ -83,7 +84,8 @@ func init() {
 	RegisterTranslator("openshift", "4.15.0", openshift4_15.ToConfigBytes)
 	RegisterTranslator("openshift", "4.16.0", openshift4_16.ToConfigBytes)
 	RegisterTranslator("openshift", "4.17.0", openshift4_17.ToConfigBytes)
-	RegisterTranslator("openshift", "4.18.0-experimental", openshift4_18_exp.ToConfigBytes)
+	RegisterTranslator("openshift", "4.18.0", openshift4_18.ToConfigBytes)
+	RegisterTranslator("openshift", "4.19.0-experimental", openshift4_19_exp.ToConfigBytes)
 	RegisterTranslator("r4e", "1.0.0", r4e1_0.ToIgn3_3Bytes)
 	RegisterTranslator("r4e", "1.1.0", r4e1_1.ToIgn3_4Bytes)
 	RegisterTranslator("r4e", "1.2.0-experimental", r4e1_2_exp.ToIgn3_6Bytes)

diff --git a/docs/config-openshift-v4_18.md b/docs/config-openshift-v4_18.md
diff --git a/docs/config-openshift-v4_18-exp.md → docs/config-openshift-v4_19-exp.md b/docs/config-openshift-v4_18-exp.md → docs/config-openshift-v4_19-exp.md
@@ -1,12 +1,12 @@
 ---
 # This file is automatically generated from internal/doc and Ignition's
 # config/doc.  Do not edit.
-title: OpenShift v4.18.0-experimental
+title: OpenShift v4.19.0-experimental
 parent: Configuration specifications
 nav_order: 150
 ---
 
-# OpenShift Specification v4.18.0-experimental
+# OpenShift Specification v4.19.0-experimental
 
 **Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**
 
@@ -15,7 +15,7 @@ The OpenShift configuration is a YAML document conforming to the following speci
 <div id="spec-docs"></div>
 
 * **variant** (string): used to differentiate configs for different operating systems. Must be `openshift` for this specification.
-* **version** (string): the semantic version of the spec for this document. This document is for version `4.18.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
+* **version** (string): the semantic version of the spec for this document. This document is for version `4.19.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
 * **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config.
   * **name** (string): a unique [name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names) for this MachineConfig resource.
   * **labels** (object): string key/value pairs to apply as [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to this MachineConfig resource. `machineconfiguration.openshift.io/role` is required.

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -11,6 +11,9 @@ key](https://getfedora.org/security/).
 
 ### Features
 
+- Add OpenShift spec 4.19.0-experimental, targeting Ignition spec
+  3.6.0-experimental
+- Stabilize OpenShift spec 4.18.0, targeting Ignition spec 3.4.0
 - Stabilize Fcos spec 1.6.0, targeting Ignition spec 3.5.0
 - Add Fcos spec 1.7.0-experimental, targeting Ignition spec
   3.6.0-experimental

diff --git a/docs/specs.md b/docs/specs.md
@@ -51,7 +51,7 @@ Do not use **experimental** specifications for anything beyond **development and
 - Flatcar (`flatcar`)
   - [v1.2.0-experimental](config-flatcar-v1_2-exp.md)
 - OpenShift (`openshift`)
-  - [v4.18.0-experimental](config-openshift-v4_18-exp.md)
+  - [v4.19.0-experimental](config-openshift-v4_19-exp.md)
 - RHEL for Edge (`r4e`)
   - [v1.2.0-experimental](config-r4e-v1_2-exp.md)
 - Fedora IoT (`fiot`)
@@ -84,7 +84,8 @@ Each version of the Butane specification corresponds to a version of the Ignitio
 | `openshift`    | 4.15.0              | 3.4.0              |
 | `openshift`    | 4.16.0              | 3.4.0              |
 | `openshift`    | 4.17.0              | 3.4.0              |
-| `openshift`    | 4.18.0-experimental | 3.6.0-experimental |
+| `openshift`    | 4.18.0              | 3.4.0              |
+| `openshift`    | 4.19.0-experimental | 3.6.0-experimental |
 | `r4e`          | 1.0.0               | 3.3.0              |
 | `r4e`          | 1.1.0               | 3.4.0              |
 | `r4e`          | 1.2.0-experimental  | 3.6.0-experimental |

diff --git a/docs/upgrading-openshift.md b/docs/upgrading-openshift.md
@@ -15,6 +15,12 @@ Occasionally, changes are made to OpenShift Butane configs (those that specify `
 
 {% comment %}
 
+## From Version 4.17.0 to 4.18.0
+
+There are no breaking changes between versions 4.17.0 and 4.18.0 of the `openshift` configuration specification. Any valid 4.17.0 configuration can be updated to a 4.18.0 configuration by changing the version string in the config.
+
+{% endcomment %}
+
 ## From Version 4.16.0 to 4.17.0
 
 There are no breaking changes between versions 4.16.0 and 4.17.0 of the `openshift` configuration specification. Any valid 4.16.0 configuration can be updated to a 4.17.0 configuration by changing the version string in the config.

diff --git a/internal/doc/butane.yaml b/internal/doc/butane.yaml
@@ -330,7 +330,7 @@ root:
                 - variant: fcos
                   min: 1.6.0-experimental
                 - variant: openshift
-                  min: 4.18.0-experimental
+                  min: 4.19.0-experimental
         - name: luks
           desc: describes the clevis configuration for encrypting the root filesystem.
           children:
@@ -362,7 +362,7 @@ root:
           replacement: "Unsupported"
           if:
             - variant: openshift
-              max: 4.17.0
+              max: 4.18.0
       children:
         - name: users
           desc: the list of GRUB superusers.
@@ -371,7 +371,7 @@ root:
               replacement: "Unsupported"
               if:
                 - variant: openshift
-                  max: 4.17.0
+                  max: 4.18.0
           children:
             - name: name
               desc: the user name.
@@ -380,7 +380,7 @@ root:
                   replacement: "Unsupported"
                   if:
                     - variant: openshift
-                      max: 4.17.0
+                      max: 4.18.0
             - name: password_hash
               desc: the PBKDF2 password hash, generated with `grub2-mkpasswd-pbkdf2`.
               # required by validation
@@ -390,7 +390,7 @@ root:
                   replacement: "Unsupported"
                   if:
                     - variant: openshift
-                      max: 4.17.0
+                      max: 4.18.0
     - name: openshift
       after: $
       desc: describes miscellaneous OpenShift configuration. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config.

diff --git a/internal/doc/main.go b/internal/doc/main.go
@@ -56,7 +56,7 @@ import (
 	openshift4_15 "github.com/coreos/butane/config/openshift/v4_15"
 	openshift4_16 "github.com/coreos/butane/config/openshift/v4_16"
 	openshift4_17 "github.com/coreos/butane/config/openshift/v4_17"
-	openshift4_18_exp "github.com/coreos/butane/config/openshift/v4_18_exp"
+	openshift4_19_exp "github.com/coreos/butane/config/openshift/v4_19_exp"
 	openshift4_8 "github.com/coreos/butane/config/openshift/v4_8"
 	openshift4_9 "github.com/coreos/butane/config/openshift/v4_9"
 	r4e1_0 "github.com/coreos/butane/config/r4e/v1_0"
@@ -128,7 +128,7 @@ func generate(dir string) error {
 			"openshift",
 			[]version{
 				// inverse order of website navbar
-				{"4.18.0-experimental", openshift4_18_exp.Config{}},
+				{"4.19.0-experimental", openshift4_19_exp.Config{}},
 				{"4.8.0", openshift4_8.Config{}},
 				{"4.9.0", openshift4_9.Config{}},
 				{"4.10.0", openshift4_10.Config{}},
@@ -139,6 +139,7 @@ func generate(dir string) error {
 				{"4.15.0", openshift4_15.Config{}},
 				{"4.16.0", openshift4_16.Config{}},
 				{"4.17.0", openshift4_17.Config{}},
+				{"4.18.0", openshift4_17.Config{}},
 			},
 		},
 		{