Skip to content

Commit 27ba5f5

Browse files
authored
Merge pull request #76673 from skopacz1/OSDOCS-106044
OSDOCS#10644: update 'local' wording in disconnected update docs
2 parents 91d4a61 + b3a0a1d commit 27ba5f5

File tree

6 files changed

+21
-21
lines changed

6 files changed

+21
-21
lines changed

modules/disconnected-osus-overview.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@
77

88
= Using the OpenShift Update Service in a disconnected environment
99

10-
The OpenShift Update Service (OSUS) provides update recommendations to {product-title} clusters. Red Hat publicly hosts the OpenShift Update Service, and clusters in a connected environment can connect to the service through public APIs to retrieve update recommendations.
10+
The OpenShift Update Service (OSUS) provides update recommendations to {product-title} clusters. Red{nbsp}Hat publicly hosts the OpenShift Update Service, and clusters in a connected environment can connect to the service through public APIs to retrieve update recommendations.
1111

12-
However, clusters in a disconnected environment cannot access these public APIs to retrieve update information. To have a similar update experience in a disconnected environment, you can install and configure the OpenShift Update Service locally so that it is available within the disconnected environment.
12+
However, clusters in a disconnected environment cannot access these public APIs to retrieve update information. To have a similar update experience in a disconnected environment, you can install and configure the OpenShift Update Service so that it is available within the disconnected environment.
1313

1414
A single OSUS instance is capable of serving recommendations to thousands of clusters.
1515
OSUS can be scaled horizontally to cater to more clusters by changing the replica value.
1616
So for most disconnected use cases, one OSUS instance is enough.
17-
For example, Red Hat hosts just one OSUS instance for the entire fleet of connected clusters.
17+
For example, Red{nbsp}Hat hosts just one OSUS instance for the entire fleet of connected clusters.
1818

1919
If you want to keep update recommendations separate in different environments, you can run one OSUS instance for each environment.
2020
For example, in a case where you have separate test and stage environments, you might not want a cluster in a stage environment to receive update recommendations to version A if that version has not been tested in the test environment yet.
2121

22-
The following sections describe how to install a local OSUS instance and configure it to provide update recommendations to a cluster.
22+
The following sections describe how to install an OSUS instance and configure it to provide update recommendations to a cluster.

modules/update-service-configure-cvo.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
[id="update-service-configure-cvo"]
66
= Configuring the Cluster Version Operator (CVO)
77

8-
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.
8+
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 OpenShift Update Service installed in your environment.
99

1010
.Prerequisites
1111

1212
* The OpenShift Update Service Operator has been installed.
1313
* The OpenShift Update Service graph data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service.
14-
* The current release and update target releases have been mirrored to a locally accessible registry.
14+
* The current release and update target releases have been mirrored to a registry in the disconnected environment.
1515
* The OpenShift Update Service application has been created.
1616
1717
.Procedure
@@ -44,7 +44,7 @@ $ POLICY_ENGINE_GRAPH_URI="$(oc -n "${NAMESPACE}" get -o jsonpath='{.status.poli
4444
$ PATCH="{\"spec\":{\"upstream\":\"${POLICY_ENGINE_GRAPH_URI}\"}}"
4545
----
4646
+
47-
. Patch the CVO to use the local OpenShift Update Service:
47+
. Patch the CVO to use the OpenShift Update Service in your environment:
4848
+
4949
[source,terminal]
5050
----

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can use the OpenShift CLI (`oc`) to create an OpenShift Update Service appli
1111

1212
* The OpenShift Update Service Operator has been installed.
1313
* The OpenShift Update Service graph data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service.
14-
* The current release and update target releases have been mirrored to a locally accessible registry.
14+
* The current release and update target releases have been mirrored to a registry in the disconnected environment.
1515
1616
.Procedure
1717

@@ -31,7 +31,7 @@ The namespace must match the `targetNamespaces` value from the operator group.
3131
$ NAME=service
3232
----
3333

34-
. Configure the local registry and repository for the release images as configured in "Mirroring the {product-title} image repository", for example, `registry.example.com/ocp4/openshift4-release-images`:
34+
. Configure the registry and repository for the release images as configured in "Mirroring the {product-title} image repository", for example, `registry.example.com/ocp4/openshift4-release-images`:
3535
//TODO: Add xref to the preceding step when allowed.
3636
+
3737
[source,terminal]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can use the {product-title} web console to create an OpenShift Update Servic
1111

1212
* The OpenShift Update Service Operator has been installed.
1313
* The OpenShift Update Service graph data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service.
14-
* The current release and update target releases have been mirrored to a locally accessible registry.
14+
* The current release and update target releases have been mirrored to a registry in the disconnected environment.
1515
1616
.Procedure
1717

@@ -28,7 +28,7 @@ You can use the {product-title} web console to create an OpenShift Update Servic
2828
. Enter the local pullspec in the *Graph Data Image* field to the graph data container image created in "Creating the OpenShift Update Service graph data container image", for example, `registry.example.com/openshift/graph-data:latest`.
2929
//TODO: Add xref to preceding step when allowed.
3030

31-
. In the *Releases* field, enter the local registry and repository created to contain the release images in "Mirroring the OpenShift Container Platform image repository", for example, `registry.example.com/ocp4/openshift4-release-images`.
31+
. In the *Releases* field, enter the registry and repository created to contain the release images in "Mirroring the OpenShift Container Platform image repository", for example, `registry.example.com/ocp4/openshift4-release-images`.
3232
//TODO: Add xref to preceding step when allowed.
3333

3434
. Enter `2` in the *Replicas* field.

modules/update-service-graph-data.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,5 @@ $ podman push registry.example.com/openshift/graph-data:latest
4343
+
4444
[NOTE]
4545
====
46-
To push a graph data image to a local registry in a disconnected environment, copy the graph data container image created in the previous step to a repository that is accessible to the OpenShift Update Service. Run `oc image mirror --help` for available options.
46+
To push a graph data image to a registry in a disconnected environment, copy the graph data container image created in the previous step to a repository that is accessible to the OpenShift Update Service. Run `oc image mirror --help` for available options.
4747
====

updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update-osus.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The following steps outline the high-level workflow on how to update a cluster i
2424

2525
. Create a graph data container image for the OpenShift Update Service.
2626

27-
. Install the OSUS application and configure your clusters to use the local OpenShift Update Service.
27+
. Install the OSUS application and configure your clusters to use the OpenShift Update Service in your environment.
2828

2929
. Perform a supported update procedure from the documentation as you would with a connected cluster.
3030

@@ -40,7 +40,7 @@ include::modules/disconnected-osus-overview.adoc[leveloffset=+1]
4040
== Prerequisites
4141

4242
* You must have the `oc` command-line interface (CLI) tool installed.
43-
* You must provision a local container image registry with the container images for your update, as described in xref:../../../updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images].
43+
* You must provision a container image registry in your environment with the container images for your update, as described in xref:../../../updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images].
4444

4545
[id="registry-configuration-for-update-service"]
4646
== Configuring access to a secured registry for the OpenShift Update Service
@@ -66,7 +66,7 @@ data:
6666
...
6767
-----END CERTIFICATE-----
6868
----
69-
<1> The OpenShift Update Service Operator requires the config map key name updateservice-registry in the registry CA cert.
69+
<1> The OpenShift Update Service Operator requires the config map key name `updateservice-registry` in the registry CA cert.
7070
<2> If the registry has the port, such as `registry-with-port.example.com:5000`, `:` should be replaced with `..`.
7171

7272
// Updating the global cluster pull secret
@@ -114,7 +114,7 @@ and must be no more than 63 characters`, try creating the Update Service with a
114114
====
115115

116116
// Configuring the Cluster Version Operator (CVO)
117-
include::modules/update-service-configure-cvo.adoc[leveloffset=+3]
117+
include::modules/update-service-configure-cvo.adoc[leveloffset=+1]
118118

119119
[NOTE]
120120
====
@@ -126,15 +126,15 @@ See xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-
126126

127127
Before updating your cluster, confirm that the following conditions are met:
128128

129-
* The Cluster Version Operator (CVO) is configured to use your locally-installed OpenShift Update Service application.
129+
* The Cluster Version Operator (CVO) is configured to use your installed OpenShift Update Service application.
130130
* The release image signature config map for the new release is applied to your cluster.
131131
+
132132
[NOTE]
133133
====
134-
The release image signature config map allows the Cluster Version Operator (CVO) to ensure the integrity of release images by verifying that the actual image signatures match the expected signatures.
134+
The Cluster Version Operator (CVO) uses release image signatures to ensure that release images have not been modified, by verifying that the release image signatures match the expected result.
135135
====
136-
* The current release and update target release images are mirrored to a locally accessible registry.
137-
* A recent graph data container image has been mirrored to your local registry.
136+
* The current release and update target release images are mirrored to a registry in the disconnected environment.
137+
* A recent graph data container image has been mirrored to your registry.
138138
* A recent version of the OpenShift Update Service Operator is installed.
139139
+
140140
[NOTE]
@@ -143,7 +143,7 @@ If you have not recently installed or updated the OpenShift Update Service Opera
143143
See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for more information about how to update your OLM catalog in a disconnected environment.
144144
====
145145

146-
After you configure your cluster to use the locally-installed OpenShift Update Service and local mirror registry, you can use any of the following update methods:
146+
After you configure your cluster to use the installed OpenShift Update Service and local mirror registry, you can use any of the following update methods:
147147

148148
** xref:../../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console]
149149
** xref:../../../updating/updating_a_cluster/updating-cluster-cli.adoc#updating-cluster-cli[Updating a cluster using the CLI]

0 commit comments

Comments
 (0)