Skip to content

Commit 3da64a8

Browse files
authored
Merge pull request #41268 from sagidlow/OSDOCS-3068
OSDOCS-3068: Adding an intro to Updates docs
2 parents 3900779 + 3cb109d commit 3da64a8

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,8 @@ Name: Updating clusters
430430
Dir: updating
431431
Distros: openshift-origin,openshift-enterprise
432432
Topics:
433+
- Name: Understanding OpenShift updates
434+
File: understanding-openshift-updates
433435
- Name: Understanding the OpenShift Update Service
434436
File: understanding-the-update-service
435437
- Name: Installing and configuring the OpenShift Update Service

modules/update-common-terms.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/understanding-openshift-updates.adoc
4+
5+
:_content-type: REFERENCE
6+
[id="update-common-terms_{context}"]
7+
= Common terms
8+
9+
Control plane:: The _control plane_, which is composed of control plane machines, manages the {product-title} cluster. The control plane machines manage workloads on the compute machines, which are also known as worker machines.
10+
11+
Cluster Version Operator:: The _Cluster Version Operator_ (CVO) starts the update process for the cluster. It checks with OSUS based on the current cluster version and retrieves the graph which contains available or possible update paths.
12+
13+
Machine Config Operator:: The _Machine Config Operator_ (MCO) is a cluster-level Operator that manages the operating system and machine configurations. Through the MCO, platform administrators can configure and update systemd, CRI-O and Kubelet, the kernel, NetworkManager, and other system features on the worker nodes.
14+
+
15+
For more information, see link:https://docs.openshift.com/container-platform/latest/post_installation_configuration/machine-configuration-tasks.html#machine-config-overview-post-install-machine-configuration-tasks[Machine config overview].
16+
17+
OpenShift Update Service:: The _OpenShift Update Service_ (OSUS) provides over-the-air updates to {product-title}, including to {op-system-first}. It provides a graph, or diagram, that contains the vertices of component Operators and the edges that connect them.
18+
+
19+
For more information, see link:https://docs.openshift.com/container-platform/latest/updating/understanding-the-update-service.html#update-service-overview_understanding-the-update-service[About the OpenShift Update Service].
20+
21+
Channels:: _Channels_ declare an update strategy tied to minor versions of {product-title}. The OSUS uses this configured strategy to recommend update edges consistent with that strategy.
22+
+
23+
For more information, see link:https://docs.openshift.com/container-platform/latest/updating/understanding-upgrade-channels-release.html[Understanding update channels and releases].
24+
25+
Recommended update edge:: A _recommended update edge_ is a recommended update between {product-title} releases. Whether a given update is recommended can depend on the cluster's configured channel, current version, known bugs, and other information. OSUS communicates the recommended edges to the CVO, which runs in every cluster.
26+
27+
Extended Update Support:: All post-4.7 even-numbered minor releases are labeled as _Extended Update Support_ (EUS) releases. These releases introduce a verified update path between EUS releases, permitting customers to streamline updates of worker worker nodes and formulate update strategies of EUS-to-EUS {product-title} releases that will cause fewer reboots of worker nodes.
28+
+
29+
For more information, see link:https://access.redhat.com/support/policy/updates/openshift-eus[Red Hat OpenShift Extended Update Support (EUS) Overview].
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_content-type: ASSEMBLY
2+
[id="understanding-openshift-updates"]
3+
= Understanding {product-title} updates
4+
include::modules/common-attributes.adoc[]
5+
:context: understanding-openshift-updates
6+
7+
toc::[]
8+
9+
With {product-title} 4, you can update a {product-title} cluster with a single operation by using the web console or the OpenShift CLI (`oc`). Platform administrators are automatically notified when an update is available for their cluster.
10+
11+
The OpenShift Update Service (OSUS) builds a graph of upgrade possibilities based on release images in the registry.
12+
The graph is based on recommended, tested update paths from a specific version. {product-title} clusters connect to the Red Hat Hybrid Cloud servers and identify which clusters the user is running, along with the version information. OSUS responds with information about known update targets. Either a cluster administrator or an automatic update controller edits the custom resource (CR) of the Cluster Version Operator (CVO) with the new version to update to.
13+
After the CVO receives the update image from the registry, the CVO then applies the changes.
14+
15+
include::modules/update-common-terms.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)