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

Document connecting to OCM with Service Account credentials

XMLWordPrintable

    • False
    • None
    • False
    • None

      Note: Doc team updates the current version of the documentation and the
      two previous versions (n-2), but we address *only high-priority, or
      customer-reported issues* for -2 releases in support.
      Describe the changes in the doc and link to your dev story:

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

      2. - [X] Mandatory: Choose the type of documentation change or review.

      • [X] We need to update to an existing topic
      • [ ] We need to add a new document to an existing section
      • [ ] We need a whole new section; this is a function not
        documented before and doesn't belong in any current section
      • [ ] We need an Operator Advisory review and approval
      • [ ] We need a z-Stream (Errata) Advisory and Release note
        for MCE and/or ACM

      3. - [ ] *Mandatory: *Use the following link to open the doc and find where the
      documentation update should go. Note: As the feature and doc is
      understood and developed, this placement decision may change:

      4. - [X] Mandatory for GA content:

      • [X] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:

      The documentation currently references console.redhat.com/openshift/token in two locations. Our OCM credential type has been updated to work with API tokens or with Service Accounts, because API tokens are expected to be deprecated next year.

      We might want to link directly to the documentation for each option:

      API tokens: https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html/managing_clusters/assembly-managing-clusters#downloading-ocm-api-token_downloading-and-updating-pull-secrets

      Service Accounts:

      https://docs.redhat.com/en/documentation/red_hat_hybrid_cloud_console/1-latest/html/creating_and_managing_service_accounts/proc-ciam-svc-acct-overview-creating-service-acct

       

      If using a Service Account, the user needs to enter the client ID and client secret in order to create the OCM credential in MCE.

       

      • [ ] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:
      • [ ] Add verification at the end of the task, how does the user
        verify success (a command to run or a result to see?)

      5. - [ ] Mandatory for bugs: What is the diff? Clearly define what the
      problem is, what the change is, and link to the current documentation. Only
      use this for a documentation bug.

              mdockery@redhat.com Mikela Jackson
              rh-ee-kcormier Kevin Cormier
              Atif Shafi Atif Shafi
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: