openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

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

Browse Source
This commit is contained in:
Michael Burke
2025-04-04 15:34:40 -04:00
parent 0a61f92144
commit 985206f90c
11 changed files with 45 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/cluster-logging-systemd-scaling.adoc
View File

@@ -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+"]

2
modules/containers-signature-verify-enable.adoc
View File

@@ -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+"]

2
modules/installation-special-config-chrony.adoc
View File

@@ -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+"]

2
modules/machineconfig-modify-journald.adoc
View File

@@ -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+"]

11
modules/nw-cluster-mtu-change.adoc
View File

@@ -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

5
modules/nw-ovn-ipsec-north-south-enable.adoc
View File

@@ -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

4
modules/rhcos-load-firmware-blobs.adoc
View File

@@ -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

5
modules/troubleshooting-enabling-kdump-day-one.adoc
View File

@@ -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

2
modules/virt-binding-devices-vfio-driver.adoc
View File

@@ -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

17
snippets/butane-version.adoc Normal file
View File

@@ -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.

2
updating/updating_a_cluster/updating-bootloader-rhcos.adoc
View File

@@ -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