diff --git a/modules/cluster-logging-systemd-scaling.adoc b/modules/cluster-logging-systemd-scaling.adoc index c9252419a2..226aba96b6 100644 --- 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 index 213379aac1..ed82f699d6 100644 --- 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 index 8056d47087..f16fe9ed77 100644 --- 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 index 45e5ce1051..e456dc3ef3 100644 --- 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 index f89b09c8ff..f869eb5a88 100644 --- a/modules/nw-cluster-mtu-change.adoc +++ b/modules/nw-cluster-mtu-change.adoc @@ -124,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 @@ -144,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 index 4f64edd8f9..2e3a1c6b05 100644 --- 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 index b6273a54c5..816fb862b3 100644 --- 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 index 9d0dca5a85..9acfd15b17 100644 --- 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 index 844630f211..dcd4134921 100644 --- 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 new file mode 100644 index 0000000000..90370e6936 --- /dev/null +++ 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 index 3cf0a8e3e2..f8ee75580e 100644 --- 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