diff --git a/modules/update-service-configure-cvo.adoc b/modules/update-service-configure-cvo.adoc index 4000c48638c7..a1b46d06b2f2 100644 --- a/modules/update-service-configure-cvo.adoc +++ b/modules/update-service-configure-cvo.adoc @@ -1,12 +1,12 @@ [id="update-service-configure-cvo"] = Configuring the Cluster Version Operator (CVO) -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. +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. .Prerequisites * The OpenShift Update Service Operator has been installed. -* The Openshift Update Service graph-data container image has been created and pushed to a repository accessible to the OpenShift Update Service. +* The Openshift Update Service graph-data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service. * The current release and update target releases have been mirrored to a locally accessible registry. * The OpenShift Update Service application has been created. @@ -33,10 +33,16 @@ $ NAME=service $ POLICY_ENGINE_GRAPH_URI="$(oc -n "${NAMESPACE}" get -o jsonpath='{.status.policyEngineURI}/api/upgrades_info/v1/graph{"\n"}' updateservice "${NAME}")" ---- -. Patch the CVO ClusterVersion to use the local OpenShift Update Service: +. Set the patch for the pull graph data: + [source,terminal] ---- $ PATCH="{\"spec\":{\"upstream\":\"${POLICY_ENGINE_GRAPH_URI}\"}}" +---- ++ +. Patch the CVO to use the local OpenShift Update Service: ++ +[source,terminal] +---- $ oc patch clusterversion version -p $PATCH --type merge ---- diff --git a/modules/update-service-create-service-cli.adoc b/modules/update-service-create-service-cli.adoc index 263c035baf3d..6dbc5d04b1e5 100644 --- a/modules/update-service-create-service-cli.adoc +++ b/modules/update-service-create-service-cli.adoc @@ -1,18 +1,16 @@ [id="update-service-create-service-cli_{context}"] = Creating an OpenShift Update Service application by using the CLI -You can use the {product-title} CLI to create an OpenShift Update Service application. +You can use the OpenShift CLI (`oc`) to create an OpenShift Update Service application. .Prerequisites -* The OpenShift Update Service Operator has already been installed. -* The Openshift Update Service graph-data container image has already been created and pushed to a repository accessible to the OpenShift Update Service. -* The current release and update target releases have already been mirrored to a locally accessible registry. +* The OpenShift Update Service Operator has been installed. +* The Openshift Update Service graph-data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service. +* The current release and update target releases have been mirrored to a locally accessible registry. .Procedure -To create an OpenShift Update Service application by using the {product-title} CLI: - . Configure the OpenShift Update Service target namespace, for example, `openshift-update-service`: + [source,terminal] @@ -20,7 +18,7 @@ To create an OpenShift Update Service application by using the {product-title} C $ NAMESPACE=openshift-update-service ---- + -The namespace must match the `targetNamespaces` value from the OperatorGroup. +The namespace must match the `targetNamespaces` value from the operator group. . Configure the name of the OpenShift Update Service application, for example, `service`: + @@ -72,11 +70,11 @@ $ while sleep 1; do POLICY_ENGINE_GRAPH_URI="$(oc -n "${NAMESPACE}" get -o jsonp + You might need to poll until the command succeeds. -.. 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}*: +.. 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}`: + [source,terminal] ---- $ 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 ---- + -This polls until the graph request succeeds, although depending on which release images you have mirrored, the resulting graph might be empty. +This polls until the graph request succeeds; however, the resulting graph might be empty depending on which release images you have mirrored. diff --git a/modules/update-service-create-service-web-console.adoc b/modules/update-service-create-service-web-console.adoc index 7107dbb5732d..287d32fc25ec 100644 --- a/modules/update-service-create-service-web-console.adoc +++ b/modules/update-service-create-service-web-console.adoc @@ -1,19 +1,17 @@ [id="update-service-create-service-web-console_{context}"] = Creating an OpenShift Update Service application by using the web console -You can use the {product-title} web console to create an Update Service application by using the OpenShift Update Service Operator. +You can use the {product-title} web console to create an OpenShift Update Service application by using the OpenShift Update Service Operator. .Prerequisites -* The OpenShift Update Service Operator has already been installed. -* The Openshift Update Service graph-data container image has already been created and pushed to a repository accessible to the OpenShift Update Service. -* The current release and update target releases have already been mirrored to a locally accessible registry. +* The OpenShift Update Service Operator has been installed. +* The Openshift Update Service graph-data container image has been created and pushed to a repository that is accessible to the OpenShift Update Service. +* The current release and update target releases have been mirrored to a locally accessible registry. .Procedure -To create an OpenShift Update Service application by using the {product-title} web console: - -. In the {product-title} web console, click *Operators* -> *Installed Operators*. +. In the web console, click *Operators* -> *Installed Operators*. . Choose *OpenShift Update Service* from the list of installed Operators. @@ -39,4 +37,4 @@ To create an OpenShift Update Service application by using the {product-title} w ** Click the *Resources* tab. -** Verify each application resource has status *Created*. +** Verify each application resource has a status of *Created*. diff --git a/modules/update-service-delete-service-cli.adoc b/modules/update-service-delete-service-cli.adoc index 1c6c37fef1a4..91ce5c3fd746 100644 --- a/modules/update-service-delete-service-cli.adoc +++ b/modules/update-service-delete-service-cli.adoc @@ -1,12 +1,10 @@ [id="update-service-delete-service-cli_{context}"] = Deleting an OpenShift Update Service application by using the CLI -You can use the {product-title} CLI to delete an OpenShift Update Service application. +You can use the OpenShift CLI (`oc`) to delete an OpenShift Update Service application. .Procedure -To delete an OpenShift Update Service application by using the {product-title} CLI: - . Get the OpenShift Update Service application name using the namespace the OpenShift Update Service application was created in, for example, `openshift-update-service`: + [source,terminal] @@ -21,7 +19,7 @@ NAME AGE service 6s ---- -. 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`: +. 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`: + [source,terminal] ---- diff --git a/modules/update-service-delete-service-web-console.adoc b/modules/update-service-delete-service-web-console.adoc index 94f81d611f98..15be4be50fd4 100644 --- a/modules/update-service-delete-service-web-console.adoc +++ b/modules/update-service-delete-service-web-console.adoc @@ -5,18 +5,16 @@ You can use the {product-title} web console to delete an OpenShift Update Servic .Prerequisites -* The OpenShift Update Service Operator has already been installed. +* The OpenShift Update Service Operator has been installed. .Procedure -To delete an OpenShift Update Service application by using the {product-title} web console: - -. In the {product-title} web console, click *Operators* -> *Installed Operators*. +. In the web console, click *Operators* -> *Installed Operators*. . Choose *OpenShift Update Service* from the list of installed Operators. . Click the *Update Service* tab. -. 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*. +. From the list of installed OpenShift Update Service applications, select the application to be deleted and then click *Delete UpdateService*. -. From the *Delete UpdateService?* pop up click the *Delete* button to confirm the deletion. +. From the *Delete UpdateService?* confirmation dialog, click *Delete* to confirm the deletion. diff --git a/modules/update-service-graph-data.adoc b/modules/update-service-graph-data.adoc index b3c3db15b174..f1e5e4ba13aa 100644 --- a/modules/update-service-graph-data.adoc +++ b/modules/update-service-graph-data.adoc @@ -1,7 +1,7 @@ [id="update-service-graph-data_{context}"] = Creating the OpenShift Update Service graph data container image -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. +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. .Procedure @@ -23,7 +23,7 @@ CMD exec /bin/bash -c "tar xvzf cincinnati-graph-data.tar.gz -C /var/lib/cincinn $ podman build -f ./Dockerfile -t registry.example.com/openshift/graph-data:latest ---- -. 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`: +. 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`: + [source,terminal] ---- diff --git a/modules/update-service-install-cli.adoc b/modules/update-service-install-cli.adoc index 417e65fadb55..dd0c6c0227c5 100644 --- a/modules/update-service-install-cli.adoc +++ b/modules/update-service-install-cli.adoc @@ -1,15 +1,13 @@ [id="update-service-install-cli_{context}"] = Installing the OpenShift Update Service Operator by using the CLI -You can use the {product-title} CLI to install the OpenShift Update Service Operator. +You can use the OpenShift CLI (`oc`) to install the OpenShift Update Service Operator. .Procedure -To install the OpenShift Update Service Operator by using the {product-title} CLI: +. Create a namespace for the OpenShift Update Service Operator: -. Create a Namespace for the OpenShift Update Service Operator: - -.. Create a Namespace object YAML file, for example, `update-service-namespace.yaml`, for the OpenShift Update Service Operator: +.. Create a `Namespace` object YAML file, for example, `update-service-namespace.yaml`, for the OpenShift Update Service Operator: + [source,yaml] ---- @@ -22,13 +20,13 @@ metadata: labels: openshift.io/cluster-monitoring: "true" <1> ---- -<1> Set the `openshift.io/cluster-monitoring` label to enable operator recommended cluster monitoring on this namespace. +<1> Set the `openshift.io/cluster-monitoring` label to enable Operator-recommended cluster monitoring on this namespace. -.. Create the Namespace: +.. Create the namespace: + [source,terminal] ---- -$ oc create -f .yaml +$ oc create -f .yaml ---- + For example: @@ -40,7 +38,7 @@ $ oc create -f update-service-namespace.yaml . Install the OpenShift Update Service Operator by creating the following objects: -.. Create an Operator Group object YAML file, for example, `update-service-operator-group.yaml`: +.. Create an `OperatorGroup` object YAML file, for example, `update-service-operator-group.yaml`: + [source,yaml] ---- @@ -53,11 +51,11 @@ spec: - openshift-update-service ---- -.. Create an Operator Group object: +.. Create an `OperatorGroup` object: + [source,terminal] ---- -$ oc -n openshift-update-service create -f .yaml +$ oc -n openshift-update-service create -f .yaml ---- + For example: @@ -67,7 +65,7 @@ For example: $ oc -n openshift-update-service create -f update-service-operator-group.yaml ---- -.. Create a Subscription object YAML file, for example, `update-service-subscription.yaml`: +.. Create a `Subscription` object YAML file, for example, `update-service-subscription.yaml`: + .Example Subscription [source,yaml] @@ -83,13 +81,13 @@ spec: sourceNamespace: "openshift-marketplace" name: "cincinnati-operator" ---- -<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). +<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). -.. Create the Subscription object: +.. Create the `Subscription` object: + [source,terminal] ---- -$ oc create -f .yaml +$ oc create -f .yaml ---- + For example: @@ -116,4 +114,4 @@ update-service-operator.v4.6.0 OpenShift Update Service 4.6.0 ... ---- + -If the OpenShift Update Service Operator is listed, installation succeeded. The version number might be different than shown. +If the OpenShift Update Service Operator is listed, the installation was successful. The version number might be different than shown. diff --git a/modules/update-service-install-web-console.adoc b/modules/update-service-install-web-console.adoc index 3314e7424946..a9b45a676a52 100644 --- a/modules/update-service-install-web-console.adoc +++ b/modules/update-service-install-web-console.adoc @@ -1,22 +1,20 @@ [id="update-service-install-web-console_{context}"] = Installing the OpenShift Update Service Operator by using the web console -You can use the {product-title} web console to install the OpenShift Update Service Operator. +You can use the web console to install the OpenShift Update Service Operator. .Procedure -To install the OpenShift Update Service Operator using the {product-title} web console: - -. In the {product-title} web console, click *Operators* -> *OperatorHub*. +. In the web console, click *Operators* -> *OperatorHub*. + [NOTE] ==== -Enter `Update Service` into the *Filter by keyword...* field to find the operator faster. +Enter `Update Service` into the *Filter by keyword...* field to find the Operator faster. ==== . Choose *OpenShift Update Service* from the list of available Operators, and click *Install*. -.. `v1` will be selected as the *Update Channel* since it is the only channel available in this release. +.. Channel `v1` is selected as the *Update Channel* since it is the only channel available in this release. .. Select *A specific namespace on the cluster* under *Installation Mode*. diff --git a/modules/update-service-mirror-release.adoc b/modules/update-service-mirror-release.adoc index 222808f55436..cb37c0c87e0b 100644 --- a/modules/update-service-mirror-release.adoc +++ b/modules/update-service-mirror-release.adoc @@ -10,7 +10,7 @@ To avoid excessive memory usage by the OpenShift Update Service application, it .Prerequisites -* 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*. +* 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*. //TODO: Add xref to preceding step when allowed. * You configured a mirror registry to use in your restricted network and can access the certificate and credentials that you configured. ifndef::openshift-origin[] @@ -117,10 +117,10 @@ $ ARCHITECTURE= ---- $ REMOVABLE_MEDIA_PATH= <1> ---- -<1> Specify the full path, including the initial forward slash (/) character. +<1> Specify the full path, including the initial forward slash (`/`) character. . Mirror the version images to the internal container registry: -** If your mirror host does not have Internet access, take the following actions: +** If your mirror host does not have internet access, take the following actions: ... Connect the removable media to a system that is connected to the Internet. ... Review the images and configuration manifests to mirror: + @@ -146,11 +146,15 @@ $ TEMP_REPOSITORY='' + For ``, specify the name of a temporary repository to create in your registry, such as `ocp4/temp`. -... 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. +... 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. + [source,terminal] ---- $ oc image mirror -a ${LOCAL_SECRET_JSON} --from-dir=${REMOVABLE_MEDIA_PATH}/mirror "file://openshift/release:${OCP_RELEASE}*" ${LOCAL_REGISTRY}/${TEMP_REPOSITORY} <1> +---- ++ +[source,terminal] +---- $ oc adm release mirror -a ${LOCAL_SECRET_JSON} \ --from=${LOCAL_REGISTRY}/${TEMP_REPOSITORY} \ --to=${LOCAL_REGISTRY}/${LOCAL_REPOSITORY} \ @@ -159,8 +163,7 @@ $ oc adm release mirror -a ${LOCAL_SECRET_JSON} \ + <1> For `REMOVABLE_MEDIA_PATH`, you must use the same path that you specified when you mirrored the images. -** If the local container registry is connected to the mirror host, take the following actions: -... Directly push the release images to the local registry by using following command: +** If the local container registry is connected to the mirror host, push the release images directly to the local registry: + [source,terminal] ---- diff --git a/modules/update-service-overview.adoc b/modules/update-service-overview.adoc index f7b72dab3835..8b53d74ea763 100644 --- a/modules/update-service-overview.adoc +++ b/modules/update-service-overview.adoc @@ -11,34 +11,36 @@ [id="update-service-overview_{context}"] = About the OpenShift Update Service -The OpenShift Update Service (OSUS) is the service that provides over-the-air updates to both {product-title} and {op-system-first}. It provides a graph, or diagram, that contains _vertices_ and the _edges_ that connect them, of component Operators. The edges in the graph show which versions you can safely update to, and the vertices are update payloads that specify the intended state of the managed cluster components. +The OpenShift Update Service (OSUS) provides over-the-air updates to both {product-title} and {op-system-first}. It provides a graph, or diagram, that contains the _vertices_ of component Operators and the _edges_ that connect them. The edges in the graph show which versions you can safely update to. The vertices are update payloads that specify the intended state of the managed cluster components. -The Cluster Version Operator (CVO) in your cluster checks with the OpenShift Update Service to see the valid updates and update paths based on current component versions and information in the graph. When you request an update, the {product-title} CVO uses the release image for that update to upgrade your cluster. The release artifacts are hosted in Quay as container images. +The Cluster Version Operator (CVO) in your cluster checks with the OpenShift Update Service to see the valid updates and update paths based on current component versions and information in the graph. When you request an update, the CVO uses the release image for that update to upgrade your cluster. The release artifacts are hosted in Quay as container images. //// By accepting automatic updates, you can automatically keep your cluster up to date with the most recent compatible components. //// -To allow the OpenShift Update Service to provide only compatible updates, a release verification pipeline exists to drive automation. Each release artifact is verified for compatibility with supported cloud platforms and system architectures as well as other component packages. After the pipeline confirms the suitability of a release, the OpenShift Update Service notifies you that it is available. +To allow the OpenShift Update Service to provide only compatible updates, a release verification pipeline drives automation. Each release artifact is verified for compatibility with supported cloud platforms and system architectures, as well as other component packages. After the pipeline confirms the suitability of a release, the OpenShift Update Service notifies you that it is available. [IMPORTANT] ==== -Because the OpenShift Update Service displays all valid updates, you must not force an update to a version that the OpenShift Update Service does not display. +The OpenShift Update Service displays all valid updates. Do not force an update to a version that the OpenShift Update Service does not display. ==== //// The interaction between the registry and the OpenShift Update Service is different during bootstrap and continuous update modes. When you bootstrap the initial infrastructure, the Cluster Version Operator finds the fully qualified image name for the shortname of the images that it needs to apply to the server during installation. It looks at the imagestream that it needs to apply and renders it to disk. It calls bootkube and waits for a temporary minimal control plane to come up and load the Cluster Version Operator. //// -During continuous update mode, two controllers run. One continuously updates the payload manifests, applies them to the cluster, and outputs the status of the controlled rollout of the Operators, whether they are available, upgrading, or failed. The second controller polls the OpenShift Update Service to determine if updates are available. +Two controllers run during continuous update mode. The first controller continuously updates the payload manifests, applies the manifests to the cluster, and outputs the controlled rollout status of the Operators to indicate whether they are available, upgrading, or failed. The second controller polls the OpenShift Update Service to determine if updates are available. [IMPORTANT] ==== -Reverting your cluster to a previous version, or a rollback, is not supported. -Only upgrading to a newer version is supported. -If your upgrade fails, contact Red Hat support. +Only upgrading to a newer version is supported. Reverting or rolling back your cluster to a previous version is not supported. If your upgrade fails, contact Red Hat support. ==== -During the upgrade process, the Machine Config Operator (MCO) applies the new configuration to your cluster machines. It cordons the number of nodes that is specified by the `maxUnavailable` field on the machine configuration pool and marks them as unavailable. By default, this value is set to `1`. It then applies the new configuration and reboots the machine. If you use Red Hat Enterprise Linux (RHEL) machines as workers, the MCO does not update the kubelet on these machines because you must update the OpenShift API on them first. Because the specification for the new version is applied to the old kubelet, the RHEL machine cannot return to the `Ready` state. You cannot complete the update until the machines are available. However, the maximum number of nodes that are unavailable is set to ensure that normal cluster operations are likely to continue with that number of machines out of service. +During the upgrade process, the Machine Config Operator (MCO) applies the new configuration to your cluster machines. The MCO cordons the number of nodes as specified by the `maxUnavailable` field on the machine configuration pool and marks them as unavailable. By default, this value is set to `1`. The MCO then applies the new configuration and reboots the machine. + +If you use {op-system-base-full} machines as workers, the MCO does not update the kubelet because you must update the OpenShift API on the machines first. + +With the specification for the new version applied to the old kubelet, the {op-system-base} machine cannot return to the `Ready` state. You cannot complete the update until the machines are available. However, the maximum number of unavailable nodes is set to ensure that normal cluster operations can continue with that number of machines out of service. The OpenShift Update Service is composed of an Operator and one or more application instances. diff --git a/modules/update-service-uninstall-cli.adoc b/modules/update-service-uninstall-cli.adoc index afcef7ae3704..4766e43f90a8 100644 --- a/modules/update-service-uninstall-cli.adoc +++ b/modules/update-service-uninstall-cli.adoc @@ -1,17 +1,15 @@ [id="update-service-uninstall-cli_{context}"] = Uninstalling the OpenShift Update Service Operator by using the CLI -You can use the {product-title} CLI to uninstall the OpenShift Update Service Operator. +You can use the OpenShift CLI (`oc`) to uninstall the OpenShift Update Service Operator. .Prerequisites -- All OpenShift Update Service applications have been deleted. +* All OpenShift Update Service applications have been deleted. .Procedure -To uninstall the OpenShift Update Service Operator by using the {product-title} CLI: - -. Change to the project containing the OpenShift Update Service Operator (for example, `openshift-update-service`). +. Change to the project containing the OpenShift Update Service Operator, for example, `openshift-update-service`: + [source,terminal] ---- @@ -24,7 +22,7 @@ $ oc project openshift-update-service Now using project "openshift-update-service" on server "https://example.com:6443". ---- -. Get the name of the OpenShift Update Service Operator operatorgroup: +. Get the name of the OpenShift Update Service Operator operator group: + [source,terminal] ---- @@ -38,7 +36,7 @@ NAME AGE openshift-update-service-fprx2 4m41s ---- -. Delete the operatorgroup (for example, `openshift-update-service-fprx2`): +. Delete the operator group, for example, `openshift-update-service-fprx2`: + [source,terminal] ---- @@ -78,7 +76,7 @@ $ oc get subscription update-service-operator -o yaml | grep " currentCSV" currentCSV: update-service-operator.v0.0.1 ---- -. Delete the subscription (for example, `update-service-operator`): +. Delete the subscription, for example, `update-service-operator`: + [source,terminal] ---- diff --git a/modules/update-service-uninstall-web-console.adoc b/modules/update-service-uninstall-web-console.adoc index cb98d6271c22..8776880891e8 100644 --- a/modules/update-service-uninstall-web-console.adoc +++ b/modules/update-service-uninstall-web-console.adoc @@ -5,14 +5,12 @@ You can use the {product-title} web console to uninstall the OpenShift Update Se .Prerequisites -- All OpenShift Update Service applications have been deleted. +* All OpenShift Update Service applications have been deleted. .Procedure -To uninstall the OpenShift Update Service Operator using the {product-title} web console: +. In the web console, click *Operators* -> *Installed Operators*. -. In the {product-title} web console, click *Operators* -> *Installed Operators*. +. Select *OpenShift Update Service* from the list of installed Operators and click *Uninstall Operator*. -. Click *Uninstall Operator* from the menu of *OpenShift Update Service* from the list of installed Operators. - -. From the *Uninstall Operator?* confirmation dialog, click *Uninstall* to confirm the uninstall. +. From the *Uninstall Operator?* confirmation dialog, click *Uninstall* to confirm the uninstallation. diff --git a/updating/installing-update-service.adoc b/updating/installing-update-service.adoc index ca881f903b41..8a153aa15b86 100644 --- a/updating/installing-update-service.adoc +++ b/updating/installing-update-service.adoc @@ -10,7 +10,11 @@ toc::[] // modules required to cover the user story. You can also include other // assemblies. -For clusters with internet accessibility, Red Hat provides over-the-air updates through an OpenShift Container Platform update service as a hosted service located behind public APIs. However, for clusters in a restricted network, there’s no way to access these public APIs to obtain this information. In order to provide a similar user upgrade experience in a restricted network users can install and configure the OpenShift Update Service locally, i.e. accessible within their disconnected network, to provide over-the-air updates for your cluster and its underlying operating system as described in the following sections. +For clusters with internet accessibility, Red Hat provides over-the-air updates through an OpenShift Container Platform update service as a hosted service located behind public APIs. However, clusters in a restricted network have no way to access public APIs for update information. + +To provide a similar upgrade experience in a restricted network, you can install and configure the OpenShift Update Service locally so that it is available within a disconnected environment. + +The following sections describe how to provide over-the-air updates for your disconnected cluster and its underlying operating system. include::modules/update-service-overview.adoc[leveloffset=+1] @@ -18,12 +22,12 @@ include::modules/update-service-overview.adoc[leveloffset=+1] == Prerequisites * For more information on installing Operators, see xref:../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Installing Operators in your namespace]. -* If the release images are contained in a secure registry, complete steps in xref:../registry/configuring-registry-operator.adoc#images-configuration-cas_configuring-registry-operator[Configuring additional trust stores for image registry access]. +* If the release images are contained in a secure registry, complete the steps in xref:../registry/configuring-registry-operator.adoc#images-configuration-cas_configuring-registry-operator[Configuring additional trust stores for image registry access]. [id="update-service-install"] == Installing the OpenShift Update Service Operator -The OpenShift Update Service is installed by first installing the OpenShift Update Service Operator by using the {product-title} web console or CLI. +To install the OpenShift Update Service, you must first install the OpenShift Update Service Operator by using the {product-title} web console or CLI. [NOTE] ==== @@ -61,7 +65,7 @@ include::modules/update-service-delete-service-cli.adoc[leveloffset=+2] [id="update-service-uninstall"] == Uninstalling the OpenShift Update Service Operator -The OpenShift Update Service is uninstalled by first deleting all OpenShift Update Service applications by using the {product-title} web console or CLI. +To uninstall the OpenShift Update Service, you must first delete all OpenShift Update Service applications by using the {product-title} web console or CLI. include::modules/update-service-uninstall-web-console.adoc[leveloffset=+2] diff --git a/updating/understanding-the-update-service.adoc b/updating/understanding-the-update-service.adoc index e230d084da9b..cd51ffd77ce4 100644 --- a/updating/understanding-the-update-service.adoc +++ b/updating/understanding-the-update-service.adoc @@ -1,15 +1,15 @@ [id="understanding-the-update-service"] -= Understanding the update service += Understanding the OpenShift Update Service include::modules/common-attributes.adoc[] :context: understanding-the-update-service toc::[] -For clusters with internet accessibility, Red Hat provides over-the-air updates through an {product-title} update service as a hosted service located behind public APIs. +For clusters with internet accessibility, Red Hat provides over-the-air updates through an {product-title} update service as a hosted service located behind public APIs. [NOTE] ==== -Because clusters cannot access public APIs in a restricted network, you can install the OpenShift Update Service locally if you are in a disconnected network. See xref:../updating/installing-update-service.adoc#installing-update-service[Installing and configuring the OpenShift Update Service]. +If you are on a restricted network where disconnected clusters cannot access the public APIs, you can install the OpenShift Update Service locally. See xref:../updating/installing-update-service.adoc#installing-update-service[Installing and configuring the OpenShift Update Service]. ==== include::modules/update-service-overview.adoc[leveloffset=+1]