OCP MC docs don't highlight that Butane .version is different than z-stream OCP version

Michael Burke · Michael Burke · commit 985206f90c03 · 2025-04-10T16:16:05.000-04:00
diff --git a/modules/cluster-logging-systemd-scaling.adoc b/modules/cluster-logging-systemd-scaling.adoc
@@ -22,7 +22,7 @@ and other settings.
 +
 [NOTE]
 ====
-See "Creating machine configs with Butane" for information about Butane.
+include::snippets/butane-version.adoc[]
 ====
 +
 [source,yaml,subs="attributes+"]
diff --git a/modules/containers-signature-verify-enable.adoc b/modules/containers-signature-verify-enable.adoc
@@ -13,7 +13,7 @@ Enabling container signature validation for Red Hat Container Registries require
 +
 [NOTE]
 ====
-See "Creating machine configs with Butane" for information about Butane.
+include::snippets/butane-version.adoc[]
 ====
 +
 [source,yaml,subs="attributes+"]
diff --git a/modules/installation-special-config-chrony.adoc b/modules/installation-special-config-chrony.adoc
@@ -32,7 +32,7 @@ to your nodes as a machine config.
 +
 [NOTE]
 ====
-See "Creating machine configs with Butane" for information about Butane.
+include::snippets/butane-version.adoc[]
 ====
 +
 [source,yaml,subs="attributes+"]
diff --git a/modules/machineconfig-modify-journald.adoc b/modules/machineconfig-modify-journald.adoc
@@ -20,7 +20,7 @@ This procedure describes how to modify `journald` rate limiting settings in the
 +
 [NOTE]
 ====
-See "Creating machine configs with Butane" for information about Butane.
+include::snippets/butane-version.adoc[]
 ====
 +
 [source,yaml,subs="attributes+"]
diff --git a/modules/nw-cluster-mtu-change.adoc b/modules/nw-cluster-mtu-change.adoc
@@ -91,7 +91,6 @@ where:
 ** If your hardware MTU is specified in a NetworkManager connection configuration, complete the following steps. This approach is the default for {product-title} if you do not explicitly specify your network configuration with DHCP, a kernel command line, or some other method. Your cluster nodes must all use the same underlying network configuration for the following procedure to work unmodified.
 
 ... Find the primary network interface by entering the following command:
-
 +
 [source,terminal]
 ----
@@ -125,6 +124,11 @@ where:
 
 .... Create the following Butane config in the `control-plane-interface.bu` file:
 +
+[NOTE]
+====
+include::snippets/butane-version.adoc[]
+====
++
 [source,yaml, subs="attributes+"]
 ----
 variant: openshift
@@ -145,6 +149,11 @@ storage:
 
 .... Create the following Butane config in the `worker-interface.bu` file:
 +
+[NOTE]
+====
+include::snippets/butane-version.adoc[]
+====
++
 [source,yaml, subs="attributes+"]
 ----
 variant: openshift
diff --git a/modules/nw-ovn-ipsec-north-south-enable.adoc b/modules/nw-ovn-ipsec-north-south-enable.adoc
@@ -121,6 +121,11 @@ $ oc create -f ipsec-config.yaml
 
 .. To create Butane config files for the control plane and worker nodes, enter the following command:
 +
+[NOTE]
+====
+include::snippets/butane-version.adoc[]
+====
++
 [source,terminal,subs="attributes+"]
 ----
 $ for role in master worker; do
diff --git a/modules/rhcos-load-firmware-blobs.adoc b/modules/rhcos-load-firmware-blobs.adoc
@@ -14,10 +14,10 @@ Because the default location for firmware blobs in `/usr/lib` is read-only, you
 +
 [NOTE]
 ====
-See "Creating machine configs with Butane" for information about Butane.
+include::snippets/butane-version.adoc[]
 ====
-.Butane config file for custom firmware blob
 +
+.Butane config file for custom firmware blob
 [source,yaml,subs="attributes+"]
 ----
 variant: openshift
diff --git a/modules/troubleshooting-enabling-kdump-day-one.adoc b/modules/troubleshooting-enabling-kdump-day-one.adoc
@@ -25,6 +25,11 @@ Create a `MachineConfig` object for cluster-wide configuration:
 
 . Create a Butane config file, `99-worker-kdump.bu`, that configures and enables kdump:
 +
+[NOTE]
+====
+include::snippets/butane-version.adoc[]
+====
++
 [source,yaml,subs="attributes+"]
 ----
 variant: openshift
diff --git a/modules/virt-binding-devices-vfio-driver.adoc b/modules/virt-binding-devices-vfio-driver.adoc
@@ -28,7 +28,7 @@ $ lspci -nnv | grep -i nvidia
 +
 [NOTE]
 ====
-See "Creating machine configs with Butane" for information about Butane.
+include::snippets/butane-version.adoc[]
 ====
 +
 .Example
diff --git a/snippets/butane-version.adoc b/snippets/butane-version.adoc
@@ -0,0 +1,17 @@
+// Text snippet included in the following modules:
+//
+// * modules/about-crio.adoc
+// * modules/nodes-containers-using.adoc
+// * modules/cluster-logging-systemd-scaling.adoc
+// * modules/containers-signature-verify-enable.adoc
+// * modules/machineconfig-modify-journald.adoc
+// * modules/nw-cluster-mtu-change.adoc
+// * modules/nw-ovn-ipsec-north-south-enable.adoc
+// * modules/rhcos-load-firmware-blobs.adoc
+// * modules/troubleshooting-enabling-kdump-day-one.adoc
+// * modules/virt-binding-devices-vfio-driver.adoc
+// * updating/updating_a_cluster/updating-bootloader-rhcos.adoc
+
+:_mod-docs-content-type: SNIPPET
+
+The link:https://coreos.github.io/butane/specs/[Butane version] you specify in the config file should match the {product-title} version and always ends in `0`. For example, `{product-version}.0`. See "Creating machine configs with Butane" for information about Butane.
diff --git a/updating/updating_a_cluster/updating-bootloader-rhcos.adoc b/updating/updating_a_cluster/updating-bootloader-rhcos.adoc
@@ -90,7 +90,7 @@ The boot loader update operation generally completes quickly thus the risk is lo
 +
 [NOTE]
 ====
-See "Creating machine configs with Butane" for information about Butane.
+include::snippets/butane-version.adoc[]
 ====
 +
 .Example output

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ and other settings.`
`22`	`22`	`+`
`23`	`23`	`[NOTE]`
`24`	`24`	`====`
`25`		`-See "Creating machine configs with Butane" for information about Butane.`
	`25`	`+include::snippets/butane-version.adoc[]`
`26`	`26`	`====`
`27`	`27`	`+`
`28`	`28`	`[source,yaml,subs="attributes+"]`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ Enabling container signature validation for Red Hat Container Registries require`
`13`	`13`	`+`
`14`	`14`	`[NOTE]`
`15`	`15`	`====`
`16`		`-See "Creating machine configs with Butane" for information about Butane.`
	`16`	`+include::snippets/butane-version.adoc[]`
`17`	`17`	`====`
`18`	`18`	`+`
`19`	`19`	`[source,yaml,subs="attributes+"]`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ to your nodes as a machine config.`
`32`	`32`	`+`
`33`	`33`	`[NOTE]`
`34`	`34`	`====`
`35`		`-See "Creating machine configs with Butane" for information about Butane.`
	`35`	`+include::snippets/butane-version.adoc[]`
`36`	`36`	`====`
`37`	`37`	`+`
`38`	`38`	`[source,yaml,subs="attributes+"]`
Original file line number	Diff line number	Diff line change
@@ -20,7 +20,7 @@ This procedure describes how to modify `journald` rate limiting settings in the
`20`	`20`	`+`
`21`	`21`	`[NOTE]`
`22`	`22`	`====`
`23`		`-See "Creating machine configs with Butane" for information about Butane.`
	`23`	`+include::snippets/butane-version.adoc[]`
`24`	`24`	`====`
`25`	`25`	`+`
`26`	`26`	`[source,yaml,subs="attributes+"]`
Original file line number	Diff line number	Diff line change
@@ -14,10 +14,10 @@ Because the default location for firmware blobs in `/usr/lib` is read-only, you
`14`	`14`	`+`
`15`	`15`	`[NOTE]`
`16`	`16`	`====`
`17`		`-See "Creating machine configs with Butane" for information about Butane.`
	`17`	`+include::snippets/butane-version.adoc[]`
`18`	`18`	`====`
`19`		`-.Butane config file for custom firmware blob`
`20`	`19`	`+`
	`20`	`+.Butane config file for custom firmware blob`
`21`	`21`	`[source,yaml,subs="attributes+"]`
`22`	`22`	`----`
`23`	`23`	`variant: openshift`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ $ lspci -nnv \| grep -i nvidia`
`28`	`28`	`+`
`29`	`29`	`[NOTE]`
`30`	`30`	`====`
`31`		`-See "Creating machine configs with Butane" for information about Butane.`
	`31`	`+include::snippets/butane-version.adoc[]`
`32`	`32`	`====`
`33`	`33`	`+`
`34`	`34`	`.Example`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ The boot loader update operation generally completes quickly thus the risk is lo`
`90`	`90`	`+`
`91`	`91`	`[NOTE]`
`92`	`92`	`====`
`93`		`-See "Creating machine configs with Butane" for information about Butane.`
	`93`	`+include::snippets/butane-version.adoc[]`
`94`	`94`	`====`
`95`	`95`	`+`
`96`	`96`	`.Example output`