docs: Mark grub section as unsupported

See: coreos#515
travier · Feb 16, 2024 · 1f9c36a · 1f9c36a
1 parent ae655ae
commit 1f9c36a
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/docs/config-openshift-v4_14.md b/docs/config-openshift-v4_14.md
@@ -167,10 +167,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.
+* **_grub_** (object): Unsupported
+  * **_users_** (list of objects): Unsupported
     * **name** (string): the user name.
-    * **password_hash** (string): the PBKDF2 password hash, generated with `grub2-mkpasswd-pbkdf2`.
+    * **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.

diff --git a/internal/doc/butane.yaml b/internal/doc/butane.yaml
@@ -352,16 +352,34 @@ root:
     - name: grub
       after: $
       desc: describes the desired GRUB bootloader configuration.
+      transforms:
+        - regex: ".*"
+          replacement: "Unsupported"
+          if:
+            - variant: openshift
+              max: 4.14.0
       children:
         - name: users
           desc: the list of GRUB superusers.
+          transforms:
+            - regex: ".*"
+              replacement: "Unsupported"
+              if:
+                - variant: openshift
+                  max: 4.14.0
           children:
             - name: name
               desc: the user name.
             - name: password_hash
               desc: the PBKDF2 password hash, generated with `grub2-mkpasswd-pbkdf2`.
               # required by validation
               required: true
+              transforms:
+                - regex: ".*"
+                  replacement: "Unsupported"
+                  if:
+                    - variant: openshift
+                      max: 4.14.0
     - name: openshift
       after: $
       desc: describes miscellaneous OpenShift configuration. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config.