Updates rollback to SDN procedure to add live migration #81099
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * networking/ovn_kubernetes_network_provider/migrate-from-openshift-sdn.adoc | ||
|
|
||
| ifeval::["{context}" == "migrate-to-openshift-sdn"] | ||
| :sdn: OpenShift SDN | ||
| :previous-sdn: OVN-Kubernetes | ||
| :type: OpenShiftSDN | ||
| endif::[] | ||
| ifeval::["{context}" == "migrate-from-openshift-sdn"] | ||
| :sdn: OVN-Kubernetes | ||
| :previous-sdn: OpenShift SDN | ||
| :type: OVNKubernetes | ||
| endif::[] | ||
|
|
||
| [id="how-the-live-migration-process-works_{context}"] | ||
| = How the limited live migration process works | ||
|
|
||
| The following table summarizes the limited live migration process by segmenting between the user-initiated steps in the process and the actions that the migration script performs in response. | ||
|
|
||
| .Limited live migration to OVNKubernetes from OpenShiftSDN | ||
| [cols="1,1a",options="header"] | ||
| |=== | ||
| |User-initiated steps|Migration activity | ||
| ifdef::openshift-rosa,openshift-dedicated[] | ||
| | Add the `unsupported-red-hat-internal-testing` annotation to the cluster-level network configuration. | ||
| | The Cluster Network Operator (CNO) acknowledges the unsupported testing environment. | ||
| endif::[] | ||
|
|
||
| | Patch the cluster-level networking configuration by changing the `networkType` from `OpenShiftSDN` to `OVNKubernetes`. | ||
| | | ||
| Cluster Network Operator (CNO):: | ||
| + | ||
| -- | ||
| * Sets migration related fields in the `network.operator` custom resource (CR) and waits for routable MTUs to be applied to all nodes. | ||
| * Patches the `network.operator` CR to set the migration mode to `Live` for OVN-Kubernetes and deploys the OpenShift SDN network plugin in migration mode. | ||
| * Deploys OVN-Kubernetes with hybrid overlay enabled, ensuring that no racing conditions occur. | ||
| * Waits for the OVN-Kubernetes deployment and updates the conditions in the status of the `network.config` CR. | ||
| * Triggers the Machine Config Operator (MCO) to apply the new machine config to each machine config pool, which includes node cordoning, draining, and rebooting. | ||
| * OVN-Kubernetes adds nodes to the appropriate zones and recreates pods using OVN-Kubernetes as the default CNI plugin. | ||
| * Removes migration-related fields from the network.operator CR and performs cleanup actions, such as deleting OpenShift SDN resources and redeploying OVN-Kubernetes in normal mode with the necessary configurations. | ||
| * Waits for the OVN-Kubernetes redeployment and updates the status conditions in the `network.config` CR to indicate migration completion. If your migration is blocked, see "Checking limited live migration metrics" for information on troubleshooting the issue. | ||
| -- | ||
| |=== | ||
|
|
||
| ifdef::sdn[] | ||
| :!sdn: | ||
| endif::[] | ||
| ifdef::previous-sdn[] | ||
| :!previous-sdn: | ||
| endif::[] | ||
| ifdef::type[] | ||
| :!type: | ||
| endif::[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * networking/ovn_kubernetes_network_provider/rollback-to-openshift-sdn.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="nw-ovn-kubernetes-rollback-live_{context}"] | ||
| = Using the limited live migration method to roll back to the OpenShift SDN network plugin | ||
|
|
||
| As a cluster administrator, you can roll back to the OpenShift SDN Container Network Interface (CNI) network plugin by using the limited live migration method. During the migration with this method, nodes are automatically rebooted and service to the cluster is not interrupted. | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| You must wait until the migration process from OpenShift SDN to OVN-Kubernetes network plugin is successful before initiating a rollback. | ||
| ==== | ||
|
|
||
| If a rollback to OpenShift SDN is required, the following table describes the process. | ||
|
|
||
| .Performing a rollback to OpenShift SDN | ||
| [cols="1,1a",options="header"] | ||
| |=== | ||
|
|
||
| |User-initiated steps|Migration activity | ||
| ifdef::openshift-rosa,openshift-dedicated[] | ||
| | Add the `unsupported-red-hat-internal-testing` annotation to the cluster-level network configuration. | ||
| | The Cluster Network Operator (CNO) acknowledges the unsupported testing environment. | ||
| endif::[] | ||
|
|
||
| | Patch the cluster-level networking configuration by changing the `networkType` from `OVNKubernetes` to `OpenShiftSDN`. | ||
| | | ||
| Cluster Network Operator (CNO):: Performs the following actions: | ||
| + | ||
| -- | ||
| * Sets migration related fields in the `network.operator` custom resource (CR) and waits for routable MTUs to be applied to all nodes by the Machine Config Operator (MCO). | ||
| * Patches the `network.operator` CR to set the migration mode to `Live` for OpenShiftSDN and deploys the OpenShiftSDN network plugin in migration mode. | ||
| * Deploys OVN-Kubernetes with hybrid overlay enabled. | ||
| * Waits for both CNI plugins to be deployed and updates the conditions in the status of the `network.config` CR. | ||
| * Triggers the MCO to apply the new machine config to each machine config pool, which includes node cordoning, draining, and rebooting. | ||
| * Removes migration-related fields from the `network.operator` CR and performs cleanup actions, such as deleting OpenShift SDN resources and redeploying OVN-Kubernetes in normal mode with the necessary configurations. | ||
| * Waits for the OpenShiftSDN redeployment and updates the status conditions in the `network.config` CR to indicate migration completion. | ||
| -- | ||
|
|
||
| |=== | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * The {oc-first} is installed. | ||
| * Access to the cluster as a user with the cluster-admin role is available. | ||
| * The cluster is installed on infrastructure configured with the OVN-Kubernetes network plugin. | ||
| * A recent backup of the etcd database is available. | ||
| * A manual reboot can be triggered for each node. | ||
| * The cluster is in a known good state, without any errors. | ||
| .Procedure | ||
|
|
||
| . To initiate the rollback to OpenShift SDN, enter the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc patch Network.config.openshift.io cluster --type='merge' --patch '{"metadata":{"annotations":{"network.openshift.io/network-type-migration":""}},"spec":{"networkType":"OpenShiftSDN"}}' | ||
| ---- | ||
|
|
||
| . To watch the progress of your migration, enter the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ watch -n1 'oc get network.config/cluster -o json | jq ".status.conditions[]|\"\\(.type) \\(.status) \\(.reason) \\(.message)\"" -r | column --table --table-columns NAME,STATUS,REASON,MESSAGE --table-columns-limit 4; echo; oc get mcp -o wide; echo; oc get node -o "custom-columns=NAME:metadata.name,STATE:metadata.annotations.machineconfiguration\\.openshift\\.io/state,DESIRED:metadata.annotations.machineconfiguration\\.openshift\\.io/desiredConfig,CURRENT:metadata.annotations.machineconfiguration\\.openshift\\.io/currentConfig,REASON:metadata.annotations.machineconfiguration\\.openshift\\.io/reason"' | ||
| ---- | ||
| + | ||
| The command prints the following information every second: | ||
| + | ||
| * The conditions on the status of the `network.config.openshift.io/cluster` object, reporting the progress of the migration. | ||
| * The status of different nodes with respect to the `machine-config-operator` resource, including whether they are upgrading or have been upgraded, as well as their current and desired configurations. | ||
|
|
||
| . Complete the following steps only if the migration succeeds and your cluster is in a good state: | ||
|
|
||
| .. Remove the `network.openshift.io/network-type-migration=` annotation from the `network.config` custom resource by entering the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc annotate network.config cluster network.openshift.io/network-type-migration- | ||
| ---- | ||
|
|
||
| .. Remove the OVN-Kubernetes network provider namespace by entering the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc delete namespace openshift-ovn-kubernetes | ||
| ---- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] | |
|
|
||
| toc::[] | ||
|
|
||
| As a cluster administrator, you can roll back to the OVN-Kubernetes network plugin from the OpenShift SDN network plugin if the migration to OpenShift SDN is unsuccessful. | ||
|
|
||
| include::snippets/sdn-deprecation-statement.adoc[] | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,8 +6,15 @@ include::_attributes/common-attributes.adoc[] | |
|
|
||
| toc::[] | ||
|
|
||
| As a cluster administrator, you can roll back to the OpenShift SDN network plugin from the OVN-Kubernetes network plugin using either the _offline_ migration method, or the _limited live_ migration method. This can only be done after the migration to the OVN-Kubernetes network plugin has successfully completed. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| * If you used the offline migration method to migrate to the OpenShift SDN network plugin from the OVN-Kubernetes network plugin, you should use the offline migration rollback method. | ||
| * If you used the limited live migration method to migrate to the OpenShift SDN network plugin from the OVN-Kubernetes network plugin, you should use the limited live migration rollback method. | ||
| ==== | ||
|
|
||
| include::snippets/sdn-deprecation-statement.adoc[] | ||
|
|
||
| include::modules/nw-ovn-kubernetes-rollback.adoc[leveloffset=+1] | ||
| include::modules/nw-ovn-kubernetes-rollback-live.adoc[leveloffset=+1] | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mark these up? Or switch to "OpenShift SDN" if a general reference?