Chapter 3. Installing and configuring the OpenShift Update Service

Procedure

1. Optional: To append a new pull secret to the existing pull secret, complete the following steps:

   1. Enter the following command to download the pull secret:

      Copy to Clipboard Toggle word wrap

      $ oc get secret/pull-secret -n openshift-config --template='{{index .data ".dockerconfigjson" | base64decode}}' ><pull_secret_location> 

      1

      1

      Provide the path to the pull secret file.

   2. Enter the following command to add the new pull secret:

      Copy to Clipboard Toggle word wrap

      $ oc registry login --registry="<registry>" \ 

      1

      
      --auth-basic="<username>:<password>" \ 

      2

      
      --to=<pull_secret_location> 

      3

      1

      Provide the new registry. You can include multiple repositories within the same registry, for example: --registry="<registry/my-namespace/my-repository>".

      2

      Provide the credentials of the new registry.

      3

      Provide the path to the pull secret file.

      Alternatively, you can perform a manual update to the pull secret file.

2. Enter the following command to update the global pull secret for your cluster:

   Copy to Clipboard Toggle word wrap

   $ oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=<pull_secret_location> 

   1

   1

   Provide the path to the new pull secret file.

Procedure

1. In the web console, click Operators OperatorHub.

   Note

   Enter Update Service into the Filter by keyword…​ field to find the Operator faster.

2. Choose OpenShift Update Service from the list of available Operators, and click Install.

   1. Channel v1 is selected as the Update Channel since it is the only channel available in this release.
   2. Select A specific namespace on the cluster under Installation Mode.
   3. Select a namespace for Installed Namespace or accept the recommended namespace openshift-update-service.

   4. Select an Approval Strategy:

      • The Automatic strategy allows Operator Lifecycle Manager (OLM) to automatically update the Operator when a new version is available.
      • The Manual strategy requires a cluster administrator to approve the Operator update.
   5. Click Install.
3. Verify that the OpenShift Update Service Operator is installed by switching to the Operators Installed Operators page.
4. Ensure that OpenShift Update Service is listed in the selected namespace with a Status of Succeeded.

Procedure

1. Create a namespace for the OpenShift Update Service Operator:

   1. Create a Namespace object YAML file, for example, update-service-namespace.yaml, for the OpenShift Update Service Operator:

      Copy to Clipboard Toggle word wrap

      apiVersion: v1
      kind: Namespace
      metadata:
        name: openshift-update-service
        annotations:
          openshift.io/node-selector: ""
        labels:
          openshift.io/cluster-monitoring: "true" 

      1

      1

      Set the openshift.io/cluster-monitoring label to enable Operator-recommended cluster monitoring on this namespace.

   2. Create the namespace:

      Copy to Clipboard Toggle word wrap

      $ oc create -f <filename>.yaml

      For example:

      Copy to Clipboard Toggle word wrap

      $ oc create -f update-service-namespace.yaml

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

   1. Create an OperatorGroup object YAML file, for example, update-service-operator-group.yaml:

      Copy to Clipboard Toggle word wrap

      apiVersion: operators.coreos.com/v1
      kind: OperatorGroup
      metadata:
        name: update-service-operator-group
      spec:
        targetNamespaces:
        - openshift-update-service

   2. Create an OperatorGroup object:

      Copy to Clipboard Toggle word wrap

      $ oc -n openshift-update-service create -f <filename>.yaml

      For example:

      Copy to Clipboard Toggle word wrap

      $ oc -n openshift-update-service create -f update-service-operator-group.yaml

   3. Create a Subscription object YAML file, for example, update-service-subscription.yaml:

      Example Subscription

      Copy to Clipboard Toggle word wrap

      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: update-service-subscription
      spec:
        channel: v1
        installPlanApproval: "Automatic"
        source: "redhat-operators" 

      1

      
        sourceNamespace: "openshift-marketplace"
        name: "cincinnati-operator"

      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 OpenShift Container Platform 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).

   4. Create the Subscription object:

      Copy to Clipboard Toggle word wrap

      $ oc create -f <filename>.yaml

      For example:

      Copy to Clipboard Toggle word wrap

      $ oc -n openshift-update-service create -f update-service-subscription.yaml

      The OpenShift Update Service Operator is installed to the openshift-update-service namespace and targets the openshift-update-service namespace.

3. Verify the Operator installation:

   Copy to Clipboard Toggle word wrap

   $ oc -n openshift-update-service get clusterserviceversions

   Example output

   Copy to Clipboard Toggle word wrap

   NAME                             DISPLAY                    VERSION   REPLACES   PHASE
   update-service-operator.v4.6.0   OpenShift Update Service   4.6.0                Succeeded
   ...

   If the OpenShift Update Service Operator is listed, the installation was successful. The version number might be different than shown.

Procedure

1. Create a Dockerfile, for example, ./Dockerfile, containing the following:

   Copy to Clipboard Toggle word wrap

   FROM registry.access.redhat.com/ubi8/ubi:8.1
   
   RUN curl -L -o cincinnati-graph-data.tar.gz https://github.com/openshift/cincinnati-graph-data/archive/master.tar.gz
   
   CMD exec /bin/bash -c "tar xvzf cincinnati-graph-data.tar.gz -C /var/lib/cincinnati/graph-data/ --strip-components=1"

2. Use the docker file created in the above step to build a graph-data container image, for example, registry.example.com/openshift/graph-data:latest:

   Copy to Clipboard Toggle word wrap

   $ podman build -f ./Dockerfile -t registry.example.com/openshift/graph-data:latest

3. Push the graph-data container image created in the previous step to a repository that is accessible to the OpenShift Update Service, for example, registry.example.com/openshift/graph-data:latest:

   Copy to Clipboard Toggle word wrap

   $ podman push registry.example.com/openshift/graph-data:latest

   Note

   To push a graph data image to a local registry in a restricted network, 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.

1. Review the OpenShift Container Platform downloads page to determine the version of OpenShift Container Platform to which you want to update and determine the corresponding tag on the Repository Tags page.

2. Set the required environment variables:

   1. Export the release version:

      Copy to Clipboard Toggle word wrap

      $ OCP_RELEASE=<release_version>

      For <release_version>, specify the tag that corresponds to the version of OpenShift Container Platform to install, such as 4.6.4.

   2. Export the local registry name and host port:

      Copy to Clipboard Toggle word wrap

      $ LOCAL_REGISTRY='<local_registry_host_name>:<local_registry_host_port>'

      For <local_registry_host_name>, specify the registry domain name for your mirror repository, and for <local_registry_host_port>, specify the port that it serves content on.

   3. Export the local repository name:

      Copy to Clipboard Toggle word wrap

      $ LOCAL_REPOSITORY='<local_repository_name>'

      For <local_repository_name>, specify the name of the repository to create in your registry, such as ocp4/openshift4.

   4. Export an additional local repository name to contain the release images:

      Copy to Clipboard Toggle word wrap

      $ LOCAL_RELEASE_IMAGES_REPOSITORY='<local_release_images_repository_name>'

      For <local_release_images_repository_name>, specify the name of the repository to create in your registry, such as ocp4/openshift4-release-images.

   5. Export the name of the repository to mirror:

      Copy to Clipboard Toggle word wrap

      $ PRODUCT_REPO='openshift-release-dev'

      For a production release, you must specify openshift-release-dev.

   6. Export the path to your registry pull secret:

      Copy to Clipboard Toggle word wrap

      $ LOCAL_SECRET_JSON='<path_to_pull_secret>'

      For <path_to_pull_secret>, specify the absolute path to and file name of the pull secret for your mirror registry that you created.

   7. Export the release mirror:

      Copy to Clipboard Toggle word wrap

      $ RELEASE_NAME="ocp-release"

      For a production release, you must specify ocp-release.

   8. Export the type of architecture for your server, such as x86_64:

      Copy to Clipboard Toggle word wrap

      $ ARCHITECTURE=<server_architecture>

   9. Export the path to the directory to host the mirrored images:

      Copy to Clipboard Toggle word wrap

      $ REMOVABLE_MEDIA_PATH=<path> 

      1

      1

      Specify the full path, including the initial forward slash (/) character.

3. Mirror the version images to the mirror registry:

   • If your mirror host does not have internet access, take the following actions:

     1. Connect the removable media to a system that is connected to the Internet.

     2. Review the images and configuration manifests to mirror:

        Copy to Clipboard Toggle word wrap

        $ oc adm release mirror -a ${LOCAL_SECRET_JSON}  \
             --from=quay.io/${PRODUCT_REPO}/${RELEASE_NAME}:${OCP_RELEASE}-${ARCHITECTURE} \
             --to=${LOCAL_REGISTRY}/${LOCAL_REPOSITORY} \
             --to-release-image=${LOCAL_REGISTRY}/${LOCAL_RELEASE_IMAGES_REPOSITORY}:${OCP_RELEASE}-${ARCHITECTURE} --dry-run

     3. Mirror the images to a directory on the removable media:

        Copy to Clipboard Toggle word wrap

        $ oc adm release mirror -a ${LOCAL_SECRET_JSON} --to-dir=${REMOVABLE_MEDIA_PATH}/mirror quay.io/${PRODUCT_REPO}/${RELEASE_NAME}:${OCP_RELEASE}-${ARCHITECTURE}

     4. Take the media to the restricted network environment and upload the images to the local container registry:

        Copy to Clipboard Toggle word wrap

        $ oc image mirror -a ${LOCAL_SECRET_JSON} --from-dir=${REMOVABLE_MEDIA_PATH}/mirror "file://openshift/release:${OCP_RELEASE}*" ${LOCAL_REGISTRY}/${LOCAL_REPOSITORY} 

        1

        1

        For REMOVABLE_MEDIA_PATH, you must use the path where you mounted the removable media.

     5. Mirror the release image to a separate repository:

        Copy to Clipboard Toggle word wrap

        $ oc image mirror -a ${LOCAL_SECRET_JSON} ${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}:${OCP_RELEASE}-${ARCHITECTURE} ${LOCAL_REGISTRY}/${LOCAL_RELEASE_IMAGES_REPOSITORY}:${OCP_RELEASE}-${ARCHITECTURE}

   • If the local container registry is connected to the mirror host, push the release images directly to the local registry:

     Copy to Clipboard Toggle word wrap

     $ oc adm release mirror -a ${LOCAL_SECRET_JSON}  \
          --from=quay.io/${PRODUCT_REPO}/${RELEASE_NAME}:${OCP_RELEASE}-${ARCHITECTURE} \
          --to=${LOCAL_REGISTRY}/${LOCAL_REPOSITORY} \
          --to-release-image=${LOCAL_REGISTRY}/${LOCAL_RELEASE_IMAGES_REPOSITORY}:${OCP_RELEASE}-${ARCHITECTURE}

Procedure

1. In the web console, click Operators Installed Operators.
2. Choose OpenShift Update Service from the list of installed Operators.
3. Click the Update Service tab.
4. Click Create UpdateService.
5. Enter a name in the Name field, for example, service.
6. 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.
7. 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.
8. Enter 2 in the Replicas field.
9. Click Create to create the OpenShift Update Service application.

10. Verify the OpenShift Update Service application:

    • From the UpdateServices list in the Update Service tab, click the Update Service application just created.
    • Click the Resources tab.
    • Verify each application resource has a status of Created.

Procedure

1. Configure the OpenShift Update Service target namespace, for example, openshift-update-service:

   Copy to Clipboard Toggle word wrap

   $ NAMESPACE=openshift-update-service

   The namespace must match the targetNamespaces value from the operator group.

2. Configure the name of the OpenShift Update Service application, for example, service:

   Copy to Clipboard Toggle word wrap

   $ NAME=service

3. Configure the local registry and repository for the release images as configured in "Mirroring the OpenShift Container Platform image repository", for example, registry.example.com/ocp4/openshift4-release-images:

   Copy to Clipboard Toggle word wrap

   $ RELEASE_IMAGES=registry.example.com/ocp4/openshift4-release-images

4. Set the local pullspec for the graph-data image 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:

   Copy to Clipboard Toggle word wrap

   $ GRAPH_DATA_IMAGE=registry.example.com/openshift/graph-data:latest

5. Create an OpenShift Update Service application object:

   Copy to Clipboard Toggle word wrap

   $ oc -n "${NAMESPACE}" create -f - <<EOF
   apiVersion: updateservice.operator.openshift.io/v1
   kind: UpdateService
   metadata:
     name: ${NAME}
   spec:
     replicas: 2
     releases: ${RELEASE_IMAGES}
     graphDataImage: ${GRAPH_DATA_IMAGE}
   EOF

6. Verify the OpenShift Update Service application:

   1. Use the following command to obtain a policy engine route:

      Copy to Clipboard Toggle word wrap

      $ while sleep 1; do POLICY_ENGINE_GRAPH_URI="$(oc -n "${NAMESPACE}" get -o jsonpath='{.status.policyEngineURI}/api/upgrades_info/v1/graph{"\n"}' updateservice "${NAME}")"; SCHEME="${POLICY_ENGINE_GRAPH_URI%%:*}"; if test "${SCHEME}" = http -o "${SCHEME}" = https; then break; fi; done

      You might need to poll until the command succeeds.

   2. Retrieve a graph from the policy engine. Be sure to specify a valid version for channel. For example, if running in OpenShift Container Platform 4.6, use stable-4.6:

      Copy to Clipboard Toggle word wrap

      $ 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; however, the resulting graph might be empty depending on which release images you have mirrored.

Procedure

1. Set the OpenShift Update Service target namespace, for example, openshift-update-service:

   Copy to Clipboard Toggle word wrap

   $ NAMESPACE=openshift-update-service

2. Set the name of the OpenShift Update Service application, for example, service:

   Copy to Clipboard Toggle word wrap

   $ NAME=service

3. Obtain the policy engine route:

   Copy to Clipboard Toggle word wrap

   $ POLICY_ENGINE_GRAPH_URI="$(oc -n "${NAMESPACE}" get -o jsonpath='{.status.policyEngineURI}/api/upgrades_info/v1/graph{"\n"}' updateservice "${NAME}")"

4. Set the patch for the pull graph data:

   Copy to Clipboard Toggle word wrap

   $ PATCH="{\"spec\":{\"upstream\":\"${POLICY_ENGINE_GRAPH_URI}\"}}"

5. Patch the CVO to use the local OpenShift Update Service:

   Copy to Clipboard Toggle word wrap

   $ oc patch clusterversion version -p $PATCH --type merge

Procedure

1. In the web console, click Operators Installed Operators.
2. Choose OpenShift Update Service from the list of installed Operators.
3. Click the Update Service tab.
4. From the list of installed OpenShift Update Service applications, select the application to be deleted and then click Delete UpdateService.
5. From the Delete UpdateService? confirmation dialog, click Delete to confirm the deletion.

Procedure

1. Get the OpenShift Update Service application name using the namespace the OpenShift Update Service application was created in, for example, openshift-update-service:

   Copy to Clipboard Toggle word wrap

   $ oc get updateservice -n openshift-update-service

   Example output

   Copy to Clipboard Toggle word wrap

   NAME      AGE
   service   6s

2. 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:

   Copy to Clipboard Toggle word wrap

   $ oc delete updateservice service -n openshift-update-service

   Example output

   Copy to Clipboard Toggle word wrap

   updateservice.updateservice.operator.openshift.io "service" deleted

Procedure

1. In the web console, click Operators Installed Operators.
2. Select OpenShift Update Service from the list of installed Operators and click Uninstall Operator.
3. From the Uninstall Operator? confirmation dialog, click Uninstall to confirm the uninstallation.

Procedure

1. Change to the project containing the OpenShift Update Service Operator, for example, openshift-update-service:

   Copy to Clipboard Toggle word wrap

   $ oc project openshift-update-service

   Example output

   Copy to Clipboard Toggle word wrap

   Now using project "openshift-update-service" on server "https://example.com:6443".

2. Get the name of the OpenShift Update Service Operator operator group:

   Copy to Clipboard Toggle word wrap

   $ oc get operatorgroup

   Example output

   Copy to Clipboard Toggle word wrap

   NAME                             AGE
   openshift-update-service-fprx2   4m41s

3. Delete the operator group, for example, openshift-update-service-fprx2:

   Copy to Clipboard Toggle word wrap

   $ oc delete operatorgroup openshift-update-service-fprx2

   Example output

   Copy to Clipboard Toggle word wrap

   operatorgroup.operators.coreos.com "openshift-update-service-fprx2" deleted

4. Get the name of the OpenShift Update Service Operator subscription:

   Copy to Clipboard Toggle word wrap

   $ oc get subscription

   Example output

   Copy to Clipboard Toggle word wrap

   NAME                      PACKAGE                   SOURCE                        CHANNEL
   update-service-operator   update-service-operator   updateservice-index-catalog   v1

5. Using the Name value from the previous step, check the current version of the subscribed OpenShift Update Service Operator in the currentCSV field:

   Copy to Clipboard Toggle word wrap

   $ oc get subscription update-service-operator -o yaml | grep " currentCSV"

   Example output

   Copy to Clipboard Toggle word wrap

     currentCSV: update-service-operator.v0.0.1

6. Delete the subscription, for example, update-service-operator:

   Copy to Clipboard Toggle word wrap

   $ oc delete subscription update-service-operator

   Example output

   Copy to Clipboard Toggle word wrap

   subscription.operators.coreos.com "update-service-operator" deleted

7. Delete the CSV for the OpenShift Update Service Operator using the currentCSV value from the previous step:

   Copy to Clipboard Toggle word wrap

   $ oc delete clusterserviceversion update-service-operator.v0.0.1

   Example output

   Copy to Clipboard Toggle word wrap

   clusterserviceversion.operators.coreos.com "update-service-operator.v0.0.1" deleted