Skip to content

OCPBUGS-121938: Reworked the note on Migrating a configured br-ex bri… #119740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dfitzmau merged 1 commit into from
Sep 29, 2026
Merged

OCPBUGS-121938: Reworked the note on Migrating a configured br-ex bri… #119740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset
[role="_additional-resources"]
.Additional resources

* xref:../../../installing/install_config/installing-customizing.adoc#installation-special-config-butane-create_installing-customizing[Creating a MachineConfig object by using Butane]

* xref:../../../networking/ovn_kubernetes_network_provider/converting-to-dual-stack.adoc#nw-dual-stack-convert_converting-to-dual-stack[Converting to a dual-stack cluster network]

* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#bare-metal-expanding-the-cluster[Expanding the cluster]
Expand Down
2 changes: 2 additions & 0 deletions ...ing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset
[role="_additional-resources"]
.Additional resources

* xref:../../../installing/install_config/installing-customizing.adoc#installation-special-config-butane-create_installing-customizing[Creating a MachineConfig object by using Butane]

* xref:../../../networking/ovn_kubernetes_network_provider/converting-to-dual-stack.adoc#nw-dual-stack-convert_converting-to-dual-stack[Converting to a dual-stack cluster network]

* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#bare-metal-expanding-the-cluster[Expanding the cluster]
Expand Down
2 changes: 2 additions & 0 deletions installing/installing_bare_metal/upi/installing-bare-metal.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset
[role="_additional-resources"]
.Additional resources

* xref:../../../installing/install_config/installing-customizing.adoc#installation-special-config-butane-create_installing-customizing[Creating a MachineConfig object by using Butane]

* xref:../../../networking/ovn_kubernetes_network_provider/converting-to-dual-stack.adoc#nw-dual-stack-convert_converting-to-dual-stack[Converting to a dual-stack cluster network]

* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#bare-metal-expanding-the-cluster[Expanding the cluster]
Expand Down
2 changes: 2 additions & 0 deletions ...alling/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset
[role="_additional-resources"]
.Additional resources

* xref:../../../installing/install_config/installing-customizing.adoc#installation-special-config-butane-create_installing-customizing[Creating a MachineConfig object by using Butane]

* xref:../../../networking/ovn_kubernetes_network_provider/converting-to-dual-stack.adoc#nw-dual-stack-convert_converting-to-dual-stack[Converting to a dual-stack cluster network]

* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#bare-metal-expanding-the-cluster[Expanding the cluster]
Expand Down
5 changes: 5 additions & 0 deletions ...nstalling_with_agent_based_installer/installing-with-agent-based-installer.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ include::modules/installing-ocp-agent-manifest-folder.adoc[leveloffset=+2]

include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-butane-create_installing-customizing[Creating a MachineConfig object by using Butane]

// Disk partitioning
include::modules/installation-user-infra-machines-advanced-disk.adoc[leveloffset=+2]

Expand Down
5 changes: 5 additions & 0 deletions modules/creating-manifest-file-customized-br-ex-bridge.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ For more information about an additional manifest file, see "Creating a director
====
endif::agent[]

[NOTE]
====
You can use Butane to create machine configs. For more information, see "Creating a MachineConfig object by using Butane".

@dfitzmau dfitzmau Sep 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated parentheses item to match exact link section name.

====

Consider using the customized `br-ex` bridge configuration for any of the following tasks:

* You need to modify the `br-ex` bridge after you installed the cluster.
Expand Down
10 changes: 5 additions & 5 deletions modules/migrating-br-ex-bridge-nmstate.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,10 @@ Replace `<nmstate_configuration>` with the name of your NMState resource YAML fi
[IMPORTANT]
====
To ensure network stability and performance, you must explicitly declare the MTU in the manifest for every interface. Do not rely on automatic MTU configuration. The MTU configured on a bridge port or VLAN-tagged interface must not exceed the maximum frame size supported by the attached physical medium. A mismatch causes packet fragmentation or connectivity loss.

The following example sets the MTU to `9000` for both the physical device and the bridge interface in the NMState configuration file. You must base64-encode the file and then embed the output in a `MachineConfig` manifest file. The `MachineConfig` manifest file writes to `/etc/nmstate/openshift/cluster.yml` or a per-node path under `/etc/nmstate/openshift/`.

====
+
You can use NMState to apply various network settings across cluster nodes. As an example, the following configuration sets the MTU to `9000` for both a physical device and a bridge interface. You must encode the file in base64 format and then embed the output in a `MachineConfig` manifest file. The `MachineConfig` manifest file writes to `/etc/nmstate/openshift/cluster.yml` or a per-node path under `/etc/nmstate/openshift/`.
+
.NMState file before encoding
[source,yaml]
----
Expand All @@ -64,7 +65,7 @@ interfaces:
mtu: 9000
# ...
----

+
.MachineConfig embeds the encoded file
[source,yaml]
----
Expand All @@ -83,7 +84,6 @@ spec:
path: /etc/nmstate/openshift/cluster.yml
# ...
----
====

. Apply the updates from the `MachineConfig` object to your cluster by entering the following command:
+
Expand Down