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

Document how to enable the bare metal operator in MCE/ACM

XMLWordPrintable

    • False
    • None
    • False
    • No
    • Low

      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: 

      The bare metal operator is installed by default on all platforms but is not enabled.  We need to clarify this in the documentation, as well as describe how to enable it.  Instructions for that can be seen in this blog post:
      https://cloud.redhat.com/blog/multicluster-engine-and-assisted-installer-integration-deploy-and-expand-clusters-easily see "Enable the Bare Metal Operator (and Metal3)".

                  
             - [x] Add Required access level for the user to complete the task here:

      cluster admin
             

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

      None
           
             - [ ] 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:

      The changes are in clusters/cluster_lifecycle/cim_enable.adoc.

      First, the prerequisite "You need a bare metal host custom resource definition."  has instructions on how to determine if it is installed or how to install it.

      To determine if it exists, run "oc get crd baremetalhosts.metal3.io".  If it exists, the output will look like:

      NAME                       CREATED AT
      baremetalhosts.metal3.io   2023-11-16T14:26:23Z

      If it doesn't exist, the output will look like:

      Error from server (NotFound): customresourcedefinitions.apiextensions.k8s.io "baremetalhosts.metal3.io" not found

      In that case, the user should install the CRD by downloading the following YAML file and running "oc apply -f" on it: https://raw.githubusercontent.com/openshift/baremetal-operator/master/config/crd/bases/metal3.io_baremetalhosts.yaml

       

      Second, the section "Modifying the Provisioning resource", contains information that isn't accurate.  The provisioning resource that it says to modify may not exist.  Therefore, the instructions should read:

      • Check if the provisioning resource exists by running "oc get provisioning".
      • If it returns "No resources found", apply the following YAML:
        apiVersion: metal3.io/v1alpha1
        kind: Provisioning
        metadata:
          name: provisioning-configuration
        spec:
          provisioningNetwork: "Disabled"
          watchAllNamespaces: true
      • Otherwise, if it found a provisioning resource, then modify it to watch all namespaces:
        oc patch provisioning provisioning-configuration --type merge -p '{"spec":{"watchAllNamespaces": true }}'

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

              Created:
              Updated:
              Resolved: