Skip to content

Commit 7e19b7e

Browse files
mburke5678mburke5678
authored
Merge pull request #91674 from mburke5678/mco-butane-version
OCP MC docs don't highlight that Butane .version is different than z-stream OCP version
2 parents 60bb1f4 + 985206f commit 7e19b7e

11 files changed

+45
-8
lines changed

‎modules/cluster-logging-systemd-scaling.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ and other settings.
2222
+
2323
[NOTE]
2424
====
25-
See "Creating machine configs with Butane" for information about Butane.
25+
include::snippets/butane-version.adoc[]
2626
====
2727
+
2828
[source,yaml,subs="attributes+"]

‎modules/containers-signature-verify-enable.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Enabling container signature validation for Red Hat Container Registries require
1313
+
1414
[NOTE]
1515
====
16-
See "Creating machine configs with Butane" for information about Butane.
16+
include::snippets/butane-version.adoc[]
1717
====
1818
+
1919
[source,yaml,subs="attributes+"]

‎modules/installation-special-config-chrony.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ to your nodes as a machine config.
3232
+
3333
[NOTE]
3434
====
35-
See "Creating machine configs with Butane" for information about Butane.
35+
include::snippets/butane-version.adoc[]
3636
====
3737
+
3838
[source,yaml,subs="attributes+"]

‎modules/machineconfig-modify-journald.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This procedure describes how to modify `journald` rate limiting settings in the
2020
+
2121
[NOTE]
2222
====
23-
See "Creating machine configs with Butane" for information about Butane.
23+
include::snippets/butane-version.adoc[]
2424
====
2525
+
2626
[source,yaml,subs="attributes+"]

‎modules/nw-cluster-mtu-change.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,11 @@ where:
124124

125125
.... Create the following Butane config in the `control-plane-interface.bu` file:
126126
+
127+
[NOTE]
128+
====
129+
include::snippets/butane-version.adoc[]
130+
====
131+
+
127132
[source,yaml, subs="attributes+"]
128133
----
129134
variant: openshift
@@ -144,6 +149,11 @@ storage:
144149

145150
.... Create the following Butane config in the `worker-interface.bu` file:
146151
+
152+
[NOTE]
153+
====
154+
include::snippets/butane-version.adoc[]
155+
====
156+
+
147157
[source,yaml, subs="attributes+"]
148158
----
149159
variant: openshift

‎modules/nw-ovn-ipsec-north-south-enable.adoc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,11 @@ $ oc create -f ipsec-config.yaml
121121

122122
.. To create Butane config files for the control plane and worker nodes, enter the following command:
123123
+
124+
[NOTE]
125+
====
126+
include::snippets/butane-version.adoc[]
127+
====
128+
+
124129
[source,terminal,subs="attributes+"]
125130
----
126131
$ for role in master worker; do

‎modules/rhcos-load-firmware-blobs.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ Because the default location for firmware blobs in `/usr/lib` is read-only, you
1414
+
1515
[NOTE]
1616
====
17-
See "Creating machine configs with Butane" for information about Butane.
17+
include::snippets/butane-version.adoc[]
1818
====
19-
.Butane config file for custom firmware blob
2019
+
20+
.Butane config file for custom firmware blob
2121
[source,yaml,subs="attributes+"]
2222
----
2323
variant: openshift

‎modules/troubleshooting-enabling-kdump-day-one.adoc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ Create a `MachineConfig` object for cluster-wide configuration:
2525

2626
. Create a Butane config file, `99-worker-kdump.bu`, that configures and enables kdump:
2727
+
28+
[NOTE]
29+
====
30+
include::snippets/butane-version.adoc[]
31+
====
32+
+
2833
[source,yaml,subs="attributes+"]
2934
----
3035
variant: openshift

‎modules/virt-binding-devices-vfio-driver.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ $ lspci -nnv | grep -i nvidia
2828
+
2929
[NOTE]
3030
====
31-
See "Creating machine configs with Butane" for information about Butane.
31+
include::snippets/butane-version.adoc[]
3232
====
3333
+
3434
.Example

‎snippets/butane-version.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Text snippet included in the following modules:
2+
//
3+
// * modules/about-crio.adoc
4+
// * modules/nodes-containers-using.adoc
5+
// * modules/cluster-logging-systemd-scaling.adoc
6+
// * modules/containers-signature-verify-enable.adoc
7+
// * modules/machineconfig-modify-journald.adoc
8+
// * modules/nw-cluster-mtu-change.adoc
9+
// * modules/nw-ovn-ipsec-north-south-enable.adoc
10+
// * modules/rhcos-load-firmware-blobs.adoc
11+
// * modules/troubleshooting-enabling-kdump-day-one.adoc
12+
// * modules/virt-binding-devices-vfio-driver.adoc
13+
// * updating/updating_a_cluster/updating-bootloader-rhcos.adoc
14+
15+
:_mod-docs-content-type: SNIPPET
16+
17+
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.

0 commit comments

Comments
 (0)