Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-10464

Update hosted control planes disconnected and agent document

XMLWordPrintable

    • False
    • None
    • False
    • No

      Create an informative issue (See each section, incomplete templates/issues won't be triaged)

      Using the current documentation as a model, please complete the issue template. 

      Note: Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address only high-priority, customer-reported issues for releases in support.

      Prerequisite: Start with what we have

      Always look at the current documentation to describe the change that is needed. Use the source or portal link for Step 4:

       - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes

       - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs 

      Describe the changes in the doc and link to your dev story

      Provide info for the following steps:

      1. - [x] Mandatory Add the required version to the Fix version/s field.

      2. - [x] Mandatory Choose the type of documentation change.

            - [ ] New topic in an existing section or new section
            - [x] Update to an existing topic

      3. - [x] Mandatory for GA content:
                  
             - [x] Add steps and/or other important conceptual information here: 
             (see section below)
                  
             - [x] Add Required access level for the user to complete the task here: Same as in already existing topic (see below)
             

             - [x] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?) (See below)
           
           
             - [x] Add link to dev story here: No dev story, but there was a case https://access.redhat.com/support/cases/#/case/03758600

      4. - [x] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:

      For https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#creating-a-hosted-cluster-bm

      Step 1 needs to highlight the flag "release-image" in the hcp create cluster command:
      --release-image=quay.io/openshift-release-dev/ocp-release:${OCP_RELEASE} \
      To say that this value needs to be replaced with the digest image of the openshift release if it's a disconnected environment

      Proposed change:
      ...
      export OCP_RELEASE=4.14.0-multi
      export OCP_RELEASE_IMAGE=quay.io/openshift-release-dev/ocp-release:${OCP_RELEASE} <2>
      ...
       --release-image=${OCP_RELEASE_IMAGE} \
      <2> If it's a disconnected environment, replace OCP_RELEASE_IMAGE with the digest image. See "["extracting the Openshift release digest image from the tagged image"]"(link to section below).

      Proposed new section (unless one like this exists already, then please use it)

      Extracting the Openshift Release Digest Image

      Prequisite: You know the Openshift tagged release image

      E.g. quay.io/openshift-release-dev/ocp-release:4.14.0-x8_64

      To obtain the digest image, do the following:

      1. Run this command to get the digest image

       

      oc adm release info quay.io/openshift-release-dev/ocp-release:4.14.15-x86_64 | grep "Pull From" 

      The output should look like this:

       

       

      Pull From: quay.io/openshift-release-dev/ocp-release@sha256:69d1292f64a2b67227c5592c1a7d499c7d00376e498634ff8e1946bc9ccdddfe 

      This is the digest image quay.io/openshift-release-dev/ocp-release@sha256:69d1292f64a2b67227c5592c1a7d499c7d00376e498634ff8e1946bc9ccdddfe 

       

      To learn more about image tag vs digest, see https://docs.openshift.com/container-platform/4.14/openshift_images/managing_images/tagging-images.html#images-referencing-images-imagestreams_tagging-images

      (There's only one instance of tags vs digest in the openshift docs, should this be another issue?)

            sdudhgao@redhat.com Servesha Dudhgaonkar
            cchun@redhat.com Crystal Chun
            David Huynh David Huynh
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated: