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

CIM docs don't include the baremetal operator installation

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

      The first step in the section on enabling CIM mentions:

      Modify the Provisioning resource to allow the Bare Metal Operator to watch all namespaces by running the following command

      This step assumes that the Bare Metal Operator is installed on the cluster.  While this is true in some cases, such as if the cluster was installed with the baremetal platform specified, it is not always the case.  If this operator is not installed, the user will have an error returned at this step.

      We should instruct the user to check if the operator is installed, and if not, how to install it.

      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. - [ ] Mandatory for GA content:
                  
             - [ ] Add steps and/or other important conceptual information here: 
             
                  
             - [ ] Add Required access level for the user to complete the task here:
             

             - [ ] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
           
           
             - [ ] Add link to dev story here:

      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:

      Instruct the user that if they would like to manage bare-metal hosts programmatically via the Bare Metal Operator, they will need to:

      1. Check if the operator is installed
      2. If not, install the operator
      3. Modify the Provisioning resource as currently described

        1. screenshot-1.png
          16 kB
          Christopher Dawson

              rh-ee-ofischer Oliver Fischer
              atraeger Avishay Traeger
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated:
                Resolved: