Skip to content

Commit 0f8c0f4

Browse files
authored
Merge pull request #14219 from kalexand-rh/ui_update
4.0 UI updates
2 parents afef0a8 + fd1c153 commit 0f8c0f4

File tree

7 files changed

+75
-20
lines changed

7 files changed

+75
-20
lines changed

_topic_map.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,13 @@ Topics:
7070
- Name: Uninstalling a cluster on AWS
7171
File: uninstalling-cluster-aws
7272
---
73+
Name: Updating clusters
74+
Dir: updating
75+
Distros: openshift-origin, openshift-enterprise
76+
Topics:
77+
- Name: Updating a cluster
78+
File: updating-cluster
79+
---
7380
Name: Applications
7481
Dir: applications
7582
Distros: openshift-*

modules/update-service-overview.adoc

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,35 @@
11
// Module included in the following assemblies:
22
//
33
// * architecture/architecture.adoc
4+
// * upgrading/upgrading-cluster.adoc
45

56
[id="update-service-overview-{context}"]
6-
== The {product-title} update service
7+
= About the {product-title} update service
78

8-
The {product-title} update service is the hosted service that provides over the air updates to both
9-
{product-title} and {op-system-first}. It provides a graph, or diagram that contain
10-
_vertices_ and the _edges_ that connect them, of component Operators. The edges
11-
in the graph show which versions you can safely upgrade to, and the vertices
12-
are update payloads that specify the intended state of the managed cluster components.
13-
The Cluster Version Operator checks with the {product-title} update service and determines valid upgrades and upgrade paths
14-
based on current component versions and information in the graph. If you
15-
configure it to do so, the {product-title} update service sends the release artifacts that it needs to
16-
perform the upgrade to your image registry, and the Cluster Version Operator
17-
upgrades your cluster. By accepting automatic updates, you can automatically
9+
The {product-title} update service is the hosted service that provides over-the-air
10+
updates to both {product-title} and {op-system-first}. It provides a graph,
11+
or diagram that contain _vertices_ and the _edges_ that connect them, of
12+
component Operators. The edges in the graph show which versions you can safely
13+
update to, and the vertices are update payloads that specify the intended state
14+
of the managed cluster components.
15+
16+
The Cluster Version Operator (CVO) in your cluster checks with the
17+
{product-title} update service to see the valid updates and update paths based
18+
on current component versions and information in the graph. When you request an
19+
update, the {product-title} CVO uses the release image for that update to
20+
upgrade your cluster. The release artifacts are hosted in Quay as container
21+
images.
22+
////
23+
By accepting automatic updates, you can automatically
1824
keep your cluster up to date with the most recent compatible components.
25+
////
1926

20-
To allow the {product-title} update service to provide only compatible updates, a release verification
21-
pipeline exists to drive automation. Each release artifact is verified for
22-
compatibility with supported cloud platforms and system architectures as well
23-
as other component packages. After the pipeline confirms the suitability of a
24-
release, the {product-title} update service can apply the update to your cluster or notify you that it
25-
is available.
27+
To allow the {product-title} update service to provide only compatible updates,
28+
a release verification pipeline exists to drive automation. Each release
29+
artifact is verified for compatibility with supported cloud platforms and system
30+
architectures as well as other component packages. After the pipeline confirms
31+
the suitability of a release, the {product-title} update service can apply the
32+
update to your cluster or notify you that it is available.
2633

2734
////
2835
The interaction between the registry and the {product-title} update service is different during
@@ -38,4 +45,4 @@ During continuous update mode, two controllers run. One continuously updates
3845
the payload manifests, applies them to the cluster, and outputs the status of
3946
the controlled rollout of the Operators, whether they are available, upgrading,
4047
or failed. The second controller polls the {product-title} update service to
41-
determine if updates are available.
48+
determine if updates are available.

modules/upgrade-upgrading-web.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * upgrading/upgrading-cluster.adoc
4+
5+
[id='upgrade-upgrading-web-{context}']
6+
= Updating a cluster by using the web console
7+
8+
If updates are available, you can update your cluster from the web console.
9+
10+
.Prerequisites
11+
12+
* Have access to the web console as a user with `admin` privileges.
13+
14+
.Procedure
15+
16+
. From the web console, click *Administration* > *Cluster Settings* and review
17+
the contents of the *Overview* tab.
18+
.. For production clusters, ensure that the *CHANNEL* is set to `stable-4.0`.
19+
.. If the *UPDATE STATUS* is not *Updates Available*, you cannot upgrade your
20+
cluster.
21+
.. The *DESIRED VERSION* indicates the cluster version that your cluster is running
22+
or is updating to.
23+
24+
. Click *Updates Available*, select a version to update to, and click *Update*.
25+
The *UPDATE STATUS* changes to `Updating`, and you can review the progress of
26+
the Operator upgrades on the *Cluster Operators* tab.
File renamed without changes.
File renamed without changes.

updating/updating-cluster.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[id='updating-cluster']
2+
= Updating a cluster
3+
include::modules/common-attributes.adoc[]
4+
:context: updating-cluster
5+
6+
toc::[]
7+
8+
You can update, or upgrade, an {product-title} cluster.
9+
10+
.Prerequisites
11+
12+
* Access to the cluster as a user with `admin` privileges.
13+
See xref:../authentication/using-rbac.adoc[Using RBAC to define and apply permissions].
14+
15+
include::modules/update-service-overview.adoc[leveloffset=+1]
16+
17+
include::modules/upgrade-upgrading-web.adoc[leveloffset=+1]

upgrading/PLACEHOLDER

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)