Skip to content

Commit ebf9472

Browse files
authored
Merge pull request #37584 from mburke5678/mco-sno-update
OSDOCS-2387 MCO supports upgrades-in-place for single-node OpenShift
2 parents 038d8ef + de5e80b commit ebf9472

File tree

5 files changed

+47
-1
lines changed

5 files changed

+47
-1
lines changed

modules/install-sno-about-installing-on-a-single-node.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77

88
An installation of {product-title} on a single node is a specialized installation. The primary use case is for edge computing workloads, including small physical footprints, intermittent connectivity, portable clouds, and 5G radio access networks (RAN) close to a base station. An installation on a single node supports autonomous workloads.
99

10-
The major trade off with an installation on a single node is the lack of high availability. Currently, Red Hat does not support upgrading {product-title} when installed on a single node. Upgrades and some configuration changes require re-installation.
10+
The major trade off with an installation on a single node is the lack of high availability.

modules/updating-sno.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/updating-cluster-between-minor.adoc
4+
// * updating/updating-cluster-cli.adoc
5+
// * updating/updating-cluster.adoc
6+
7+
[id="update-single-node-openshift_{context}"]
8+
= About updating single node {product-title}
9+
10+
You can update, or upgrade, a single-node {product-title} cluster by using either the console or CLI.
11+
12+
However, note the following limitations:
13+
14+
* The prerequisite to pause the `MachineHealthCheck` resources is not required because there is no other node to perform the health check.
15+
16+
* Restoring a single-node {product-title} cluster using an etcd backup is not officially supported. However, it is good practice to perform the etcd backup in case your upgrade fails. If your control plane is healthy, you might be able to restore your cluster to a previous state by using the backup.
17+
18+
* Updating a single-node {product-title} cluster requires downtime and can include an automatic reboot. The amount of downtime depends on the update payload, as described in the following scenarios:
19+
20+
** If the update payload contains an operating system update, which requires a reboot, the downtime is significant and impacts cluster management and user workloads.
21+
22+
** If the update contains machine configuration changes that do not require a reboot, the downtime is less, and the impact on the cluster management and user workloads is lessened. In this case, the node draining step is skipped with single-node {product-title} because there is no other node in the cluster to reschedule the workloads to.
23+
24+
** If the update payload does not contain an operating system update or machine configuration changes, a short API outage occurs and resolves quickly.
25+
26+
[IMPORTANT]
27+
====
28+
There are conditions, such as bugs in an updated package, that can cause the single node to not restart after a reboot. In this case, the update does not rollback automatically.
29+
====

updating/updating-cluster-between-minor.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ If you want to use the canary rollout update process, see xref:../updating/updat
5353

5454
include::modules/machine-health-checks-pausing.adoc[leveloffset=+1]
5555

56+
include::modules/updating-sno.adoc[leveloffset=+1]
57+
58+
.Additional resources
59+
60+
* For information on which machine configuration changes require a reboot, see the note in xref:../architecture/control-plane.html#understanding-machine-config-operator_control-plane[Understanding the Machine Config Operator].
61+
5662
include::modules/update-upgrading-web.adoc[leveloffset=+1]
5763

5864
include::modules/update-changing-update-server-web.adoc[leveloffset=+1]

updating/updating-cluster-cli.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ include::modules/understanding-upgrade-channels.adoc[leveloffset=+1]
3838

3939
include::modules/machine-health-checks-pausing.adoc[leveloffset=+1]
4040

41+
include::modules/updating-sno.adoc[leveloffset=+1]
42+
43+
.Additional resources
44+
45+
For information on which machine configuration changes require a reboot, see the note in xref:../architecture/control-plane.html#understanding-machine-config-operator_control-plane[Understanding the Machine Config Operator].
4146
include::modules/update-upgrading-cli.adoc[leveloffset=+1]
4247

4348
include::modules/update-changing-update-server-cli.adoc[leveloffset=+1]

updating/updating-cluster.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ include::modules/update-service-overview.adoc[leveloffset=+1]
3030

3131
include::modules/understanding-upgrade-channels.adoc[leveloffset=+1]
3232

33+
include::modules/updating-sno.adoc[leveloffset=+1]
34+
35+
.Additional resources
36+
37+
For information on which machine configuration changes require a reboot, see the note in xref:../architecture/control-plane.html#understanding-machine-config-operator_control-plane[Understanding the Machine Config Operator].
38+
3339
include::modules/update-changing-update-server-web.adoc[leveloffset=+1]
3440

3541
include::modules/update-upgrading-web.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)