openshift/v4.17: Stabilize 4.17.0 spec

config/config.go

@@ -37,7 +37,7 @@ import (
 	openshift4_14 "github.com/coreos/butane/config/openshift/v4_14"
 	openshift4_15 "github.com/coreos/butane/config/openshift/v4_15"
 	openshift4_16 "github.com/coreos/butane/config/openshift/v4_16"
-	openshift4_17_exp "github.com/coreos/butane/config/openshift/v4_17_exp"
+	openshift4_17_exp "github.com/coreos/butane/config/openshift/v4_17"
 	openshift4_18_exp "github.com/coreos/butane/config/openshift/v4_18_exp"
 	openshift4_8 "github.com/coreos/butane/config/openshift/v4_8"
 	openshift4_9 "github.com/coreos/butane/config/openshift/v4_9"
@@ -80,7 +80,7 @@ func init() {
 	RegisterTranslator("openshift", "4.14.0", openshift4_14.ToConfigBytes)
 	RegisterTranslator("openshift", "4.15.0", openshift4_15.ToConfigBytes)
 	RegisterTranslator("openshift", "4.16.0", openshift4_16.ToConfigBytes)
-	RegisterTranslator("openshift", "4.17.0-experimental", openshift4_17_exp.ToConfigBytes)
+	RegisterTranslator("openshift", "4.17.0", openshift4_17_exp.ToConfigBytes)
 	RegisterTranslator("openshift", "4.18.0-experimental", openshift4_18_exp.ToConfigBytes)
 	RegisterTranslator("r4e", "1.0.0", r4e1_0.ToIgn3_3Bytes)
 	RegisterTranslator("r4e", "1.1.0", r4e1_1.ToIgn3_4Bytes)

config/openshift/v4_17_exp/schema.go → config/openshift/v4_17/schema.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.)
 
-package v4_17_exp
+package v4_17
 
 import (
 	fcos "github.com/coreos/butane/config/fcos/v1_6_exp"

config/openshift/v4_17_exp/translate.go → config/openshift/v4_17/translate.go

@@ -12,14 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.)
 
-package v4_17_exp
+package v4_17
 
 import (
 	"net/url"
 	"strings"
 
 	"github.com/coreos/butane/config/common"
-	"github.com/coreos/butane/config/openshift/v4_17_exp/result"
+	"github.com/coreos/butane/config/openshift/v4_17/result"
 	cutil "github.com/coreos/butane/config/util"
 	"github.com/coreos/butane/translate"
 

config/openshift/v4_17_exp/translate_test.go → config/openshift/v4_17/translate_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.)
 
-package v4_17_exp
+package v4_17
 
 import (
 	"fmt"
@@ -22,7 +22,7 @@ import (
 	base "github.com/coreos/butane/base/v0_6_exp"
 	"github.com/coreos/butane/config/common"
 	fcos "github.com/coreos/butane/config/fcos/v1_6_exp"
-	"github.com/coreos/butane/config/openshift/v4_17_exp/result"
+	"github.com/coreos/butane/config/openshift/v4_17/result"
 	confutil "github.com/coreos/butane/config/util"
 	"github.com/coreos/butane/translate"
 

config/openshift/v4_17_exp/validate.go → config/openshift/v4_17/validate.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.)
 
-package v4_17_exp
+package v4_17
 
 import (
 	"github.com/coreos/butane/config/common"

config/openshift/v4_17_exp/validate_test.go → config/openshift/v4_17/validate_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.)
 
-package v4_17_exp
+package v4_17
 
 import (
 	"fmt"

docs/config-openshift-v4_17-exp.md → docs/config-openshift-v4_17.md

@@ -1,21 +1,19 @@
 ---
 # This file is automatically generated from internal/doc and Ignition's
 # config/doc.  Do not edit.
-title: OpenShift v4.17.0-experimental
+title: OpenShift v4.17.0
 parent: Configuration specifications
-nav_order: 150
+nav_order: 140
 ---
 
-# OpenShift Specification v4.17.0-experimental
-
-**Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**
+# OpenShift Specification v4.17.0
 
 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 
 <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.17.0-experimental` and generates Ignition configs with version `3.5.0-experimental`.
+* **version** (string): the semantic version of the spec for this document. This document is for version `4.17.0` and generates Ignition configs with version `3.5.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.
@@ -158,7 +156,7 @@ The OpenShift configuration is a YAML document conforming to the following speci
     * **_ssh_authorized_keys_** (list of strings): a list of SSH keys to be added as an SSH key fragment at `.ssh/authorized_keys.d/ignition` in the user's home directory. All SSH keys must be unique.
     * **_ssh_authorized_keys_local_** (list of strings): a list of local paths to SSH key files, relative to the directory specified by the `--files-dir` command-line argument, to be added as SSH key fragments at `.ssh/authorized_keys.d/ignition` in the user's home directory. All SSH keys must be unique. Each file may contain multiple SSH keys, one per line.
 * **_boot_device_** (object): describes the desired boot device configuration. At least one of `luks` or `mirror` must be specified.
-  * **_layout_** (string): the disk layout of the target OS image. Supported values are `aarch64`, `ppc64le`, `s390x-eckd`, `s390x-virt`, `s390x-zfcp`, and `x86_64`. Defaults to `x86_64`.
+  * **_layout_** (string): the disk layout of the target OS image. Supported values are `aarch64`, `ppc64le`, and `x86_64`. Defaults to `x86_64`.
   * **_luks_** (object): describes the clevis configuration for encrypting the root filesystem.
     * **_device_** (string): the whole-disk device (not partitions), referenced by their absolute path. Must start with `/dev/dasd` for `s390x-eckd` layout or `/dev/sd` for `s390x-zfcp` layouts.
     * **_tang_** (list of objects): describes a tang server. Every server must have a unique `url`.
@@ -170,10 +168,10 @@ The OpenShift configuration is a YAML document conforming to the following speci
     * **_discard_** (boolean): whether to issue discard commands to the underlying block device when blocks are freed. Enabling this improves performance and device longevity on SSDs and space utilization on thinly provisioned SAN devices, but leaks information about which disk blocks contain data. If omitted, it defaults to false.
   * **_mirror_** (object): describes mirroring of the boot disk for fault tolerance.
     * **_devices_** (list of strings): the list of whole-disk devices (not partitions) to include in the disk array, referenced by their absolute path. At least two devices must be specified.
-* **_grub_** (object): describes the desired GRUB bootloader configuration.
-  * **_users_** (list of objects): the list of GRUB superusers.
-    * **name** (string): the user name.
-    * **password_hash** (string): the PBKDF2 password hash, generated with `grub2-mkpasswd-pbkdf2`.
+* **_grub_** (object): Unsupported
+  * **_users_** (list of objects): Unsupported
+    * **name** (string): Unsupported
+    * **password_hash** (string): Unsupported
 * **_openshift_** (object): describes miscellaneous OpenShift configuration. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config.
   * **_kernel_type_** (string): which kernel to use on the node. Must be `default` or `realtime`.
   * **_kernel_arguments_** (list of strings): arguments to be added to the kernel command line.

docs/specs.md

@@ -25,6 +25,7 @@ We recommend that you always use the latest **stable** specification for your op
   - [v1.1.0](config-flatcar-v1_1.md)
   - [v1.0.0](config-flatcar-v1_0.md)
 - OpenShift (`openshift`)
+  - [v4.17.0](config-openshift-v4_17.md)
   - [v4.16.0](config-openshift-v4_16.md)
   - [v4.15.0](config-openshift-v4_15.md)
   - [v4.14.0](config-openshift-v4_14.md)
@@ -80,7 +81,7 @@ Each version of the Butane specification corresponds to a version of the Ignitio
 | `openshift`    | 4.14.0              | 3.4.0              |
 | `openshift`    | 4.15.0              | 3.4.0              |
 | `openshift`    | 4.16.0              | 3.4.0              |
-| `openshift`    | 4.17.0-experimental | 3.5.0-experimental |
+| `openshift`    | 4.17.0              | 3.4.0              |
 | `openshift`    | 4.18.0-experimental | 3.5.0-experimental |
 | `r4e`          | 1.0.0               | 3.3.0              |
 | `r4e`          | 1.1.0               | 3.4.0              |

internal/doc/butane.yaml

@@ -330,7 +330,7 @@ root:
                 - variant: fcos
                   min: 1.6.0-experimental
                 - variant: openshift
-                  min: 4.17.0-experimental
+                  min: 4.18.0-experimental
         - name: luks
           desc: describes the clevis configuration for encrypting the root filesystem.
           children:
@@ -357,7 +357,7 @@ root:
           replacement: "Unsupported"
           if:
             - variant: openshift
-              max: 4.16.0
+              max: 4.17.0
       children:
         - name: users
           desc: the list of GRUB superusers.
@@ -366,7 +366,7 @@ root:
               replacement: "Unsupported"
               if:
                 - variant: openshift
-                  max: 4.16.0
+                  max: 4.17.0
           children:
             - name: name
               desc: the user name.
@@ -375,7 +375,7 @@ root:
                   replacement: "Unsupported"
                   if:
                     - variant: openshift
-                      max: 4.16.0
+                      max: 4.17.0
             - name: password_hash
               desc: the PBKDF2 password hash, generated with `grub2-mkpasswd-pbkdf2`.
               # required by validation
@@ -385,7 +385,7 @@ root:
                   replacement: "Unsupported"
                   if:
                     - variant: openshift
-                      max: 4.16.0
+                      max: 4.17.0
     - name: openshift
       after: $
       desc: describes miscellaneous OpenShift configuration. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config.

internal/doc/main.go

@@ -54,7 +54,7 @@ import (
 	openshift4_14 "github.com/coreos/butane/config/openshift/v4_14"
 	openshift4_15 "github.com/coreos/butane/config/openshift/v4_15"
 	openshift4_16 "github.com/coreos/butane/config/openshift/v4_16"
-	openshift4_17_exp "github.com/coreos/butane/config/openshift/v4_17_exp"
+	openshift4_17 "github.com/coreos/butane/config/openshift/v4_17"
 	openshift4_18_exp "github.com/coreos/butane/config/openshift/v4_18_exp"
 	openshift4_8 "github.com/coreos/butane/config/openshift/v4_8"
 	openshift4_9 "github.com/coreos/butane/config/openshift/v4_9"
@@ -127,7 +127,6 @@ func generate(dir string) error {
 			[]version{
 				// inverse order of website navbar
 				{"4.18.0-experimental", openshift4_18_exp.Config{}},
-				{"4.17.0-experimental", openshift4_17_exp.Config{}},
 				{"4.8.0", openshift4_8.Config{}},
 				{"4.9.0", openshift4_9.Config{}},
 				{"4.10.0", openshift4_10.Config{}},
@@ -137,6 +136,7 @@ func generate(dir string) error {
 				{"4.14.0", openshift4_14.Config{}},
 				{"4.15.0", openshift4_15.Config{}},
 				{"4.16.0", openshift4_16.Config{}},
+				{"4.17.0", openshift4_17.Config{}},
 			},
 		},
 		{