Skip to content

Commit 45e5f4e

Browse files
author
Bob
committed
Apply peer review feedback from PR29360
1 parent 01acb7d commit 45e5f4e

14 files changed

+89
-90
lines changed

‎modules/update-service-configure-cvo.adoc‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[id="update-service-configure-cvo"]
22
= Configuring the Cluster Version Operator (CVO)
33

4-
After the OpenShift Update Service Operator has been installed and the OpenShift Update Service application created CVO can be updated to pull graph data from the locally installed OpenShift Update Service.
4+
After the OpenShift Update Service Operator has been installed and the OpenShift Update Service application has been created, the Cluster Version Operator (CVO) can be updated to pull graph data from the locally installed OpenShift Update Service.
55

66
.Prerequisites
77

88
* The OpenShift Update Service Operator has been installed.
9-
* The Openshift Update Service graph-data container image has been created and pushed to a repository accessible to the OpenShift Update Service.
9+
* The Openshift Update Service graph-data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service.
1010
* The current release and update target releases have been mirrored to a locally accessible registry.
1111
* The OpenShift Update Service application has been created.
1212

@@ -33,10 +33,16 @@ $ NAME=service
3333
$ POLICY_ENGINE_GRAPH_URI="$(oc -n "${NAMESPACE}" get -o jsonpath='{.status.policyEngineURI}/api/upgrades_info/v1/graph{"\n"}' updateservice "${NAME}")"
3434
----
3535

36-
. Patch the CVO ClusterVersion to use the local OpenShift Update Service:
36+
. Set the patch for the pull graph data:
3737
+
3838
[source,terminal]
3939
----
4040
$ PATCH="{\"spec\":{\"upstream\":\"${POLICY_ENGINE_GRAPH_URI}\"}}"
41+
----
42+
+
43+
. Patch the CVO to use the local OpenShift Update Service:
44+
+
45+
[source,terminal]
46+
----
4147
$ oc patch clusterversion version -p $PATCH --type merge
4248
----

‎modules/update-service-create-service-cli.adoc‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
11
[id="update-service-create-service-cli_{context}"]
22
= Creating an OpenShift Update Service application by using the CLI
33

4-
You can use the {product-title} CLI to create an OpenShift Update Service application.
4+
You can use the OpenShift CLI (`oc`) to create an OpenShift Update Service application.
55

66
.Prerequisites
77

8-
* The OpenShift Update Service Operator has already been installed.
9-
* The Openshift Update Service graph-data container image has already been created and pushed to a repository accessible to the OpenShift Update Service.
10-
* The current release and update target releases have already been mirrored to a locally accessible registry.
8+
* The OpenShift Update Service Operator has been installed.
9+
* The Openshift Update Service graph-data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service.
10+
* The current release and update target releases have been mirrored to a locally accessible registry.
1111

1212
.Procedure
1313

14-
To create an OpenShift Update Service application by using the {product-title} CLI:
15-
1614
. Configure the OpenShift Update Service target namespace, for example, `openshift-update-service`:
1715
+
1816
[source,terminal]
1917
----
2018
$ NAMESPACE=openshift-update-service
2119
----
2220
+
23-
The namespace must match the `targetNamespaces` value from the OperatorGroup.
21+
The namespace must match the `targetNamespaces` value from the operator group.
2422

2523
. Configure the name of the OpenShift Update Service application, for example, `service`:
2624
+
@@ -72,11 +70,11 @@ $ while sleep 1; do POLICY_ENGINE_GRAPH_URI="$(oc -n "${NAMESPACE}" get -o jsonp
7270
+
7371
You might need to poll until the command succeeds.
7472

75-
.. Retrieve a graph from the policy engine. Be sure to specify a valid version for *channel*. For example, if running in {product-title} {product-version} use version {product-version}, e.g. *stable-{product-version}*:
73+
.. Retrieve a graph from the policy engine. Be sure to specify a valid version for `channel`. For example, if running in {product-title} {product-version}, use `stable-{product-version}`:
7674
+
7775
[source,terminal]
7876
----
7977
$ while sleep 10; do HTTP_CODE="$(curl --header Accept:application/json --output /dev/stderr --write-out "%{http_code}" "${POLICY_ENGINE_GRAPH_URI}?channel=stable-4.6")"; if test "${HTTP_CODE}" -eq 200; then break; fi; echo "${HTTP_CODE}"; done
8078
----
8179
+
82-
This polls until the graph request succeeds, although depending on which release images you have mirrored, the resulting graph might be empty.
80+
This polls until the graph request succeeds; however, the resulting graph might be empty depending on which release images you have mirrored.

‎modules/update-service-create-service-web-console.adoc‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
[id="update-service-create-service-web-console_{context}"]
22
= Creating an OpenShift Update Service application by using the web console
33

4-
You can use the {product-title} web console to create an Update Service application by using the OpenShift Update Service Operator.
4+
You can use the {product-title} web console to create an OpenShift Update Service application by using the OpenShift Update Service Operator.
55

66
.Prerequisites
77

8-
* The OpenShift Update Service Operator has already been installed.
9-
* The Openshift Update Service graph-data container image has already been created and pushed to a repository accessible to the OpenShift Update Service.
10-
* The current release and update target releases have already been mirrored to a locally accessible registry.
8+
* The OpenShift Update Service Operator has been installed.
9+
* The Openshift Update Service graph-data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service.
10+
* The current release and update target releases have been mirrored to a locally accessible registry.
1111

1212
.Procedure
1313

14-
To create an OpenShift Update Service application by using the {product-title} web console:
15-
16-
. In the {product-title} web console, click *Operators* -> *Installed Operators*.
14+
. In the web console, click *Operators* -> *Installed Operators*.
1715

1816
. Choose *OpenShift Update Service* from the list of installed Operators.
1917

@@ -39,4 +37,4 @@ To create an OpenShift Update Service application by using the {product-title} w
3937

4038
** Click the *Resources* tab.
4139

42-
** Verify each application resource has status *Created*.
40+
** Verify each application resource has a status of *Created*.

‎modules/update-service-delete-service-cli.adoc‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
[id="update-service-delete-service-cli_{context}"]
22
= Deleting an OpenShift Update Service application by using the CLI
33

4-
You can use the {product-title} CLI to delete an OpenShift Update Service application.
4+
You can use the OpenShift CLI (`oc`) to delete an OpenShift Update Service application.
55

66
.Procedure
77

8-
To delete an OpenShift Update Service application by using the {product-title} CLI:
9-
108
. Get the OpenShift Update Service application name using the namespace the OpenShift Update Service application was created in, for example, `openshift-update-service`:
119
+
1210
[source,terminal]
@@ -21,7 +19,7 @@ NAME AGE
2119
service 6s
2220
----
2321

24-
. Delete the OpenShift Update Service application using the `Name` value from the previous step and the namespace the OpenShift Update Service application was created in, for example, `openshift-update-service`:
22+
. Delete the OpenShift Update Service application using the `NAME` value from the previous step and the namespace the OpenShift Update Service application was created in, for example, `openshift-update-service`:
2523
+
2624
[source,terminal]
2725
----

‎modules/update-service-delete-service-web-console.adoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,16 @@ You can use the {product-title} web console to delete an OpenShift Update Servic
55

66
.Prerequisites
77

8-
* The OpenShift Update Service Operator has already been installed.
8+
* The OpenShift Update Service Operator has been installed.
99

1010
.Procedure
1111

12-
To delete an OpenShift Update Service application by using the {product-title} web console:
13-
14-
. In the {product-title} web console, click *Operators* -> *Installed Operators*.
12+
. In the web console, click *Operators* -> *Installed Operators*.
1513

1614
. Choose *OpenShift Update Service* from the list of installed Operators.
1715

1816
. Click the *Update Service* tab.
1917

20-
. From the list of installed OpenShift Update Service applications, select the menu icon at the far right of the application to be deleted and then click *Delete UpdateService*.
18+
. From the list of installed OpenShift Update Service applications, select the application to be deleted and then click *Delete UpdateService*.
2119

22-
. From the *Delete UpdateService?* pop up click the *Delete* button to confirm the deletion.
20+
. From the *Delete UpdateService?* confirmation dialog, click *Delete* to confirm the deletion.

‎modules/update-service-graph-data.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[id="update-service-graph-data_{context}"]
22
= Creating the OpenShift Update Service graph data container image
33

4-
The OpenShift Update Service requires a graph-data container image, from which the OpenShift Update Service retrieves information about channel membership and blocked update edges. Graph data is typically fetched directly from the upgrade graph data repository. In environments where an internet connection is unavailable, loading this information from an init container is another way to make the graph data available to the OpenShift Update Service. The role of the init container is to provide a local copy of the graph data, and during pod initialization, the init container copies the data to a volume accessible by the service.
4+
The OpenShift Update Service requires a graph-data container image, from which the OpenShift Update Service retrieves information about channel membership and blocked update edges. Graph data is typically fetched directly from the upgrade graph data repository. In environments where an internet connection is unavailable, loading this information from an init container is another way to make the graph data available to the OpenShift Update Service. The role of the init container is to provide a local copy of the graph data, and during pod initialization, the init container copies the data to a volume that is accessible by the service.
55

66
.Procedure
77

@@ -23,7 +23,7 @@ CMD exec /bin/bash -c "tar xvzf cincinnati-graph-data.tar.gz -C /var/lib/cincinn
2323
$ podman build -f ./Dockerfile -t registry.example.com/openshift/graph-data:latest
2424
----
2525

26-
. Push the graph-data container image created in the above step to a repository accessible to the OpenShift Update Service, for example, `registry.example.com/openshift/graph-data:latest`:
26+
. Push the graph-data container image created in the above step to a repository that is accessible to the OpenShift Update Service, for example, `registry.example.com/openshift/graph-data:latest`:
2727
+
2828
[source,terminal]
2929
----

‎modules/update-service-install-cli.adoc‎

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
[id="update-service-install-cli_{context}"]
22
= Installing the OpenShift Update Service Operator by using the CLI
33

4-
You can use the {product-title} CLI to install the OpenShift Update Service Operator.
4+
You can use the OpenShift CLI (`oc`) to install the OpenShift Update Service Operator.
55

66
.Procedure
77

8-
To install the OpenShift Update Service Operator by using the {product-title} CLI:
8+
. Create a namespace for the OpenShift Update Service Operator:
99

10-
. Create a Namespace for the OpenShift Update Service Operator:
11-
12-
.. Create a Namespace object YAML file, for example, `update-service-namespace.yaml`, for the OpenShift Update Service Operator:
10+
.. Create a `Namespace` object YAML file, for example, `update-service-namespace.yaml`, for the OpenShift Update Service Operator:
1311
+
1412
[source,yaml]
1513
----
@@ -22,13 +20,13 @@ metadata:
2220
labels:
2321
openshift.io/cluster-monitoring: "true" <1>
2422
----
25-
<1> Set the `openshift.io/cluster-monitoring` label to enable operator recommended cluster monitoring on this namespace.
23+
<1> Set the `openshift.io/cluster-monitoring` label to enable Operator-recommended cluster monitoring on this namespace.
2624

27-
.. Create the Namespace:
25+
.. Create the namespace:
2826
+
2927
[source,terminal]
3028
----
31-
$ oc create -f <file-name>.yaml
29+
$ oc create -f <filename>.yaml
3230
----
3331
+
3432
For example:
@@ -40,7 +38,7 @@ $ oc create -f update-service-namespace.yaml
4038

4139
. Install the OpenShift Update Service Operator by creating the following objects:
4240

43-
.. Create an Operator Group object YAML file, for example, `update-service-operator-group.yaml`:
41+
.. Create an `OperatorGroup` object YAML file, for example, `update-service-operator-group.yaml`:
4442
+
4543
[source,yaml]
4644
----
@@ -53,11 +51,11 @@ spec:
5351
- openshift-update-service
5452
----
5553

56-
.. Create an Operator Group object:
54+
.. Create an `OperatorGroup` object:
5755
+
5856
[source,terminal]
5957
----
60-
$ oc -n openshift-update-service create -f <file-name>.yaml
58+
$ oc -n openshift-update-service create -f <filename>.yaml
6159
----
6260
+
6361
For example:
@@ -67,7 +65,7 @@ For example:
6765
$ oc -n openshift-update-service create -f update-service-operator-group.yaml
6866
----
6967

70-
.. Create a Subscription object YAML file, for example, `update-service-subscription.yaml`:
68+
.. Create a `Subscription` object YAML file, for example, `update-service-subscription.yaml`:
7169
+
7270
.Example Subscription
7371
[source,yaml]
@@ -83,13 +81,13 @@ spec:
8381
sourceNamespace: "openshift-marketplace"
8482
name: "cincinnati-operator"
8583
----
86-
<1> Specify the name of the CatalogSource that provides the Operator. For clusters that do not use a custom Operator Lifecycle Manager (OLM), specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the CatalogSource object created when you configured the Operator Lifecycle Manager (OLM).
84+
<1> Specify the name of the catalog source that provides the Operator. For clusters that do not use a custom Operator Lifecycle Manager (OLM), specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the `CatalogSource` object created when you configured Operator Lifecycle Manager (OLM).
8785

88-
.. Create the Subscription object:
86+
.. Create the `Subscription` object:
8987
+
9088
[source,terminal]
9189
----
92-
$ oc create -f <file-name>.yaml
90+
$ oc create -f <filename>.yaml
9391
----
9492
+
9593
For example:
@@ -116,4 +114,4 @@ update-service-operator.v4.6.0 OpenShift Update Service 4.6.0
116114
...
117115
----
118116
+
119-
If the OpenShift Update Service Operator is listed, installation succeeded. The version number might be different than shown.
117+
If the OpenShift Update Service Operator is listed, the installation was successful. The version number might be different than shown.

‎modules/update-service-install-web-console.adoc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
[id="update-service-install-web-console_{context}"]
22
= Installing the OpenShift Update Service Operator by using the web console
33

4-
You can use the {product-title} web console to install the OpenShift Update Service Operator.
4+
You can use the web console to install the OpenShift Update Service Operator.
55

66
.Procedure
77

8-
To install the OpenShift Update Service Operator using the {product-title} web console:
9-
10-
. In the {product-title} web console, click *Operators* -> *OperatorHub*.
8+
. In the web console, click *Operators* -> *OperatorHub*.
119
+
1210
[NOTE]
1311
====
14-
Enter `Update Service` into the *Filter by keyword...* field to find the operator faster.
12+
Enter `Update Service` into the *Filter by keyword...* field to find the Operator faster.
1513
====
1614

1715
. Choose *OpenShift Update Service* from the list of available Operators, and click *Install*.
1816

19-
.. `v1` will be selected as the *Update Channel* since it is the only channel available in this release.
17+
.. Channel `v1` is selected as the *Update Channel* since it is the only channel available in this release.
2018

2119
.. Select *A specific namespace on the cluster* under *Installation Mode*.
2220

‎modules/update-service-mirror-release.adoc‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To avoid excessive memory usage by the OpenShift Update Service application, it
1010

1111
.Prerequisites
1212

13-
* Review and complete the steps from "Mirroring images for a disconnected installation" up to but not including the section entitled *Mirroring the {product-title} image repository*.
13+
* You reviewed and completed the steps from "Mirroring images for a disconnected installation" up to but not including the section entitled *Mirroring the {product-title} image repository*.
1414
//TODO: Add xref to preceding step when allowed.
1515
* You configured a mirror registry to use in your restricted network and can access the certificate and credentials that you configured.
1616
ifndef::openshift-origin[]
@@ -117,10 +117,10 @@ $ ARCHITECTURE=<server_architecture>
117117
----
118118
$ REMOVABLE_MEDIA_PATH=<path> <1>
119119
----
120-
<1> Specify the full path, including the initial forward slash (/) character.
120+
<1> Specify the full path, including the initial forward slash (`/`) character.
121121

122122
. Mirror the version images to the internal container registry:
123-
** If your mirror host does not have Internet access, take the following actions:
123+
** If your mirror host does not have internet access, take the following actions:
124124
... Connect the removable media to a system that is connected to the Internet.
125125
... Review the images and configuration manifests to mirror:
126126
+
@@ -146,11 +146,15 @@ $ TEMP_REPOSITORY='<temp_repository_name>'
146146
+
147147
For `<temp_repository_name>`, specify the name of a temporary repository to create in your
148148
registry, such as `ocp4/temp`.
149-
... Take the media to the restricted network environment and upload the images to the temporary repository in the local container registry. Uploading the images to the temporary repository allows you to then mirror them from there to the final repositories at which time the release images will be mirrored to a separate repository.
149+
... Take the media to the restricted network environment and upload the images to the temporary repository in the local container registry. By uploading the images to the temporary repository, you can then mirror them to the final repositories so that the release images are mirrored to a separate repository.
150150
+
151151
[source,terminal]
152152
----
153153
$ oc image mirror -a ${LOCAL_SECRET_JSON} --from-dir=${REMOVABLE_MEDIA_PATH}/mirror "file://openshift/release:${OCP_RELEASE}*" ${LOCAL_REGISTRY}/${TEMP_REPOSITORY} <1>
154+
----
155+
+
156+
[source,terminal]
157+
----
154158
$ oc adm release mirror -a ${LOCAL_SECRET_JSON} \
155159
--from=${LOCAL_REGISTRY}/${TEMP_REPOSITORY} \
156160
--to=${LOCAL_REGISTRY}/${LOCAL_REPOSITORY} \
@@ -159,8 +163,7 @@ $ oc adm release mirror -a ${LOCAL_SECRET_JSON} \
159163
+
160164
<1> For `REMOVABLE_MEDIA_PATH`, you must use the same path that you specified when you mirrored the images.
161165

162-
** If the local container registry is connected to the mirror host, take the following actions:
163-
... Directly push the release images to the local registry by using following command:
166+
** If the local container registry is connected to the mirror host, push the release images directly to the local registry:
164167
+
165168
[source,terminal]
166169
----

0 commit comments

Comments
 (0)