Chapter 3. Enabling the Bare Metal Provisioning service (ironic)

Procedure

1. Access the remote shell for the OpenStackClient pod from your workstation:

   $ oc rsh -n openstack openstackclient

   Copy to Clipboard Toggle word wrap

2. Create the network over which to provision bare-metal instances:

   $ openstack network create \
     --provider-network-type <network_type> \
     [--provider-segment <vlan_id>] \
     --provider-physical-network <provider_physical_network> \
     --share <network_name>

   Copy to Clipboard Toggle word wrap
   • Replace <network_type> with the type of network, either flat or vlan.
   • Optional: If your network type is vlan then specify the --provider-segment.
   • Replace <provider_physical_network> with the name of the physical network over which you implement the virtual network, which is the bridge mapping configured for the OVN service on the control plane.
   • Replace <network_name> with a name for this network.

3. Create the subnet on the network:

   $ openstack subnet create \
     --network <network_name> \
     --subnet-range <network_cidr> \
     --ip-version 4 \
     --gateway <gateway_ip> \
     --allocation-pool start=<start_ip>,end=<end_ip> \
     --dhcp <subnet_name>
     --dns-nameserver <dns_ip>

   Copy to Clipboard Toggle word wrap
   • Replace <network_name> with the name of the provisioning network that you created in the previous step.
   • Replace <network_cidr> with the CIDR representation of the block of IP addresses that the subnet represents. The block of IP addresses that you specify in the range starting with <start_ip> and ending with <end_ip> must be within the block of IP addresses specified by <network_cidr>.
   • Replace <gateway_ip> with the IP address or host name of the router interface that acts as the gateway for the new subnet. This address must be within the block of IP addresses specified by <network_cidr>, but outside of the block of IP addresses specified by the range that starts with <start_ip> and ends with <end_ip>.
   • Replace <start_ip> with the IP address that denotes the start of the range of IP addresses within the new subnet from which floating IP addresses are allocated.
   • Replace <end_ip> with the IP address that denotes the end of the range of IP addresses within the new subnet from which floating IP addresses are allocated.
   • Replace <subnet_name> with a name for the subnet.
   • Replace <dns_ip> with the IP address of the load balancer configured for the DNS service on the control plane.

4. Create a router for the network and subnet to ensure that the Networking service serves metadata requests:

   $ openstack router create <router_name>

   Copy to Clipboard Toggle word wrap
   • Replace <router_name> with a name for the router.

5. Attach the subnet to the new router to enable the metadata requests from cloud-init to be served and the node to be configured:

   $ openstack router add subnet <router_name> <subnet>

   Copy to Clipboard Toggle word wrap
   • Replace <router_name> with the name of your router.
   • Replace <subnet> with the ID or name of the bare-metal subnet that you created in step 3.

6. Exit the openstackclient pod:

   $ exit

   Copy to Clipboard Toggle word wrap

Procedure

1. Open your OpenStackControlPlane custom resource (CR) file, openstack_control_plane.yaml, on your workstation.

2. Add the following cellTemplates configuration to the nova service configuration:

     nova:
       apiOverride:
         route: {}
       template:
         ...
         secret: osp-secret
         cellTemplates:
           cell0:
             cellDatabaseAccount: nova-cell0
             hasAPIAccess: true
           cell1:
             cellDatabaseAccount: nova-cell1
             cellDatabaseInstance: openstack-cell1
             cellMessageBusInstance: rabbitmq-cell1
             hasAPIAccess: true
             novaComputeTemplates:
               compute-ironic: 

   1

   
                 computeDriver: ironic.IronicDriver

   Copy to Clipboard Toggle word wrap

   1

   The name of the Compute service. The name has a limit of 20 characters, and must contain only lowercase alphanumeric characters and the - symbol.

3. Enable the ironic service and specify the networks to connect to:

   spec:
     ...
     ironic:
       enabled: true
       template:
         rpcTransport: oslo
         databaseInstance: openstack
         ironicAPI:
           replicas: 1
           override:
             service:
               internal:
                 metadata:
                   annotations:
                     metallb.universe.tf/address-pool: ctlplane
                     metallb.universe.tf/allow-shared-ip: ctlplane
                     metallb.universe.tf/loadBalancerIPs: 192.168.122.80
                 spec:
                   type: LoadBalancer
         ironicConductors:
         - replicas: 1
           storageRequest: 10G
           networkAttachments:
           - baremetal 

   1

   
           provisionNetwork: baremetal 

   2

   
         ironicInspector:
           replicas: 0 

   3

   
           networkAttachments:
           - baremetal 

   4

   
           inspectionNetwork: baremetal 

   5

   
         ironicNeutronAgent:
           replicas: 1
         secret: osp-secret

   Copy to Clipboard Toggle word wrap

   1

   The name of the NetworkAttachmentDefinition CR you created for your isolated bare-metal network in Preparing RHOCP for bare-metal networks to use for the ironicConductor pods.

   2

   The name of the Networking service (neutron) network you created for use as the provisioning network in Creating the bare-metal network.

   3

   You can deploy the Bare Metal Provisioning service without the ironicInspector service. To deploy the service, set the number of replicas to 1.

   4

   The name of the NetworkAttachmentDefinition CR you created for your isolated bare-metal network in Preparing RHOCP for bare-metal networks to use for the ironicInspector pod.

   5

   The name of the Networking service (neutron) network you created for use as the inspection network in Creating the bare-metal network. The Ironic Inspector API listens on port 5050.

4. Specify the networks the Bare Metal Provisioning service uses for provisioning, cleaning, inspection, and rescuing bare-metal nodes:

   spec:
     ...
     ironic:
       ...
         ironicConductors:
         - replicas: 1
           storageRequest: 10G
           networkAttachments:
           - baremetal
           provisionNetwork: baremetal
           customServiceConfig: |
             [neutron]
             cleaning_network = <network_UUID>
             provisioning_network = <network_UUID>
             inspection_network = <network_UUID>
             rescuing_network = <network_UUID>

   Copy to Clipboard Toggle word wrap
   • Replace <network_UUID> with the UUID of the network you created in Creating the bare-metal network for the function.

5. Configure the OVN mappings:

     ovn:
       template:
         ovnController:
           ...
           nicMappings: 

   1

   
             datacentre: ocpbr
             baremetal: baremetal

   Copy to Clipboard Toggle word wrap

   1

   List of key-value pairs that map the physical network provider to the interface name defined in the NodeNetworkConfigurationPolicy (nncp) CR.

6. Update the control plane:

   $ oc apply -f openstack_control_plane.yaml -n openstack

   Copy to Clipboard Toggle word wrap

7. Wait until RHOCP creates the resources related to the OpenStackControlPlane CR. Run the following command to check the status:

   $ oc get openstackcontrolplane -n openstack
   NAME 						STATUS 	MESSAGE
   openstack-control-plane 	Unknown 	Setup started

   Copy to Clipboard Toggle word wrap

   The OpenStackControlPlane resources are created when the status is "Setup complete".

   Tip

   Append the -w option to the end of the get command to track deployment progress.

8. Confirm that the control plane is deployed by reviewing the pods in the openstack namespace:

   $ oc get pods -n openstack

   Copy to Clipboard Toggle word wrap

   The control plane is deployed when all the pods are either completed or running.

Verification

1. Open a remote shell connection to the OpenStackClient pod:

   $ oc rsh -n openstack openstackclient

   Copy to Clipboard Toggle word wrap

2. Confirm that the internal service endpoints are registered with each service:

   $ openstack endpoint list -c 'Service Name' -c Interface -c URL --service ironic
   +--------------+-----------+---------------------------------------------------------------+
   | Service Name | Interface | URL                                                           |
   +--------------+-----------+---------------------------------------------------------------+
   | ironic       | internal  | http://ironic-internal.openstack.svc:9292                     |
   | ironic       | public    | http://ironic-public-openstack.apps.ostest.test.metalkube.org |
   +--------------+-----------+---------------------------------------------------------------+

   Copy to Clipboard Toggle word wrap

3. Exit the openstackclient pod:

   $ exit

   Copy to Clipboard Toggle word wrap

Procedure

1. Open your OpenStackControlPlane custom resource (CR) file, openstack_control_plane.yaml, on your workstation.

2. Add the following configuration options to the customServiceConfig parameter in the ironicConductors template to configure how node event history records are managed:

   spec:
     ...
     ironic:
       enabled: true
       template:
         rpcTransport: oslo
         databaseInstance: openstack
         ironicAPI:
           ...
         ironicConductors:
         - replicas: 1
           storageRequest: 10G
           networkAttachments:
           - baremetal
           provisionNetwork: baremetal
           customServiceConfig: |
             ...
             [conductor]
             node_history_max_entries=<max_entries>
             node_history_cleanup_interval=<clean_interval>
             node_history_cleanup_batch_count=<max_purge>
             node_history_minimum_days=<min_days>
         ...
         secret: osp-secret

   Copy to Clipboard Toggle word wrap
   • Optional: Replace <max_entries> with the maximum number of event records that the Bare Metal Provisioning service records. The oldest recorded events are removed when the maximum number of entries is reached. By default, a maximum of 300 events are recorded. The minimum valid value is 0.
   • Optional: Replace <clean_interval> with the interval in seconds between scheduled cleanup of the node event history entries. By default, the cleanup is scheduled every 86400 seconds, which is once daily. Set to 0 to disable node event history cleanup.
   • Optional: Replace <max_purge> with the maximum number of entries to purge during each clean up operation. Defaults to 1000.
   • Optional: Replace <min_days> with the minimum number of days to explicitly keep the database history entries for nodes. Defaults to 0.

3. Update the control plane:

   $ oc apply -f openstack_control_plane.yaml -n openstack

   Copy to Clipboard Toggle word wrap

4. Wait until RHOCP creates the resources related to the OpenStackControlPlane CR. Run the following command to check the status:

   $ oc get openstackcontrolplane -n openstack
   NAME 						STATUS 	MESSAGE
   openstack-control-plane 	Unknown 	Setup started

   Copy to Clipboard Toggle word wrap

   The OpenStackControlPlane resources are created when the status is "Setup complete".

   Tip

   Append the -w option to the end of the get command to track deployment progress.

5. Confirm that the control plane is deployed by reviewing the pods in the openstack namespace:

   $ oc get pods -n openstack

   Copy to Clipboard Toggle word wrap

   The control plane is deployed when all the pods are either completed or running.