Chapter 3. Deploying an Overcloud with the Bare Metal Service
For full details about overcloud deployment with the director, see Director Installation and Usage. This chapter only covers deployment steps specific to ironic.
3.1. Creating the Ironic Template
Use an environment file to deploy the overcloud with the Bare Metal service enabled. A template is located on the director node at /usr/share/openstack-tripleo-heat-templates/environments/services-docker/ironic.yaml.
Filling in the template
Additional configuration can be specified either in the provided template or in an additional yaml file, for example ~/templates/ironic.yaml.
For a hybrid deployment with both bare metal and virtual instances, you must add
AggregateInstanceExtraSpecsFilterto the list ofNovaSchedulerDefaultFilters. If you have not setNovaSchedulerDefaultFiltersanywhere, you can do so in ironic.yaml. For an example, see Section 3.3, “Example Templates”.NoteIf you are using SR-IOV, NovaSchedulerDefaultFilters is already set in
tripleo-heat-templates/environments/neutron-sriov.yaml. AppendAggregateInstanceExtraSpecsFilterto this list.-
The type of cleaning that occurs before and between deployments is set by
IronicCleaningDiskErase. By default, this is set to ‘full’ bypuppet/services/ironic-conductor.yaml. Setting this to ‘metadata’ can substantially speed up the process, as it only cleans the partition table, however, since the deployment will be less secure in a multi-tenant environment, you should only do this in a trusted tenant environment. -
You can add drivers with the
IronicEnabledDriversparameter. By default,pxe_ipmitool,pxe_dracandpxe_iloare enabled.
For a full list of configuration parameters, see the section Bare Metal in the Overcloud Parameters guide.
3.2. Network Configuration
Create a bridge called br-baremetal for ironic to use. You can specify this in an additional template:
~/templates/network-environment.yaml
parameter_defaults: NeutronBridgeMappings: datacentre:br-ex,baremetal:br-baremetal NeutronFlatNetworks: datacentre,baremetal
You can either configure this bridge in the provisioning network (control plane) of the controllers, so you can reuse this network as the bare metal network, or add a dedicated network. The configuration requirements are the same, however the bare metal network cannot be VLAN-tagged, as it is used for provisioning.
~/templates/nic-configs/controller.yaml
network_config:
-
type: ovs_bridge
name: br-baremetal
use_dhcp: false
members:
-
type: interface
name: eth13.3. Example Templates
The following is an example template file. This file may not meet the requirements of your environment. Before using this example, make sure it does not interfere with any existing configuration in your environment.
~/templates/ironic.yaml
parameter_defaults:
NovaSchedulerDefaultFilters:
- RetryFilter
- AggregateInstanceExtraSpecsFilter
- AvailabilityZoneFilter
- RamFilter
- DiskFilter
- ComputeFilter
- ComputeCapabilitiesFilter
- ImagePropertiesFilter
IronicCleaningDiskErase: metadataIn this example:
-
The
AggregateInstanceExtraSpecsFilterallows both virtual and bare metal instances, for a hybrid deployment. - Disk cleaning that is done before and between deployments only erases the partition table (metadata).
3.4. Deploying the Overcloud
To enable the Bare Metal service, include your ironic environment files with -e when deploying or redeploying the overcloud, along with the rest of your overcloud configuration.
For example:
$ openstack overcloud deploy \ --templates \ -e ~/templates/node-info.yaml \ -e /usr/share/openstack-tripleo-heat-templates/environments/network-isolation.yaml \ -e ~/templates/network-environment.yaml \ -e /usr/share/openstack-tripleo-heat-templates/environments/services/ironic.yaml \ -e ~/templates/ironic.yaml \
For more information about deploying the overcloud, see Creating the Overcloud with the CLI Tools and Including Environment Files in Overcloud Creation.
3.5. Testing the Bare Metal Service
You can use the OpenStack Integration Test Suite to validate your Red Hat OpenStack deployment. For more information, see the OpenStack Integration Test Suite Guide.
Additional Ways to Verify the Bare Metal Service:
Set up the shell to access Identity as the administrative user:
$ source ~/overcloudrc
Check that the
nova-computeservice is running on the controller nodes:$ openstack compute service list -c Binary -c Host -c Status
If you have changed the default ironic drivers, make sure the required drivers are enabled:
$ openstack baremetal driver list
Ensure that the ironic endpoints are listed:
$ openstack catalog list
== Configuring for the Bare Metal Service After Deployment
This section describes the steps necessary to configure your overcloud after deployment.
3.6. Configuring OpenStack Networking
Configure OpenStack Networking to communicate with the Bare Metal service for DHCP, PXE boot, and other requirements. The procedure below configures OpenStack Networking for a single, flat network use case for provisioning onto bare metal. The configuration uses the ML2 plug-in and the Open vSwitch agent. Only flat networks are supported.
This procedure creates a bridge using the bare metal network interface, and drops any remote connections.
All steps in the following procedure must be performed on the server hosting OpenStack Networking, while logged in as the root user.
Configuring OpenStack Networking to Communicate with the Bare Metal Service
Set up the shell to access Identity as the administrative user:
$ source ~/overcloudrc
Create the flat network over which to provision bare metal instances:
$ openstack network create \ --provider-network-type flat \ --provider-physical-network baremetal \ --share NETWORK_NAME
Replace NETWORK_NAME with a name for this network. The name of the physical network over which the virtual network is implemented, (in this case
baremetal), was set earlier in~/templates/network-environment.yaml, with the parameterNeutronBridgeMappings.Create the subnet on the flat 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
Replace the following values:
- Replace SUBNET_NAME with a name for the subnet.
- Replace NETWORK_NAME with the name of the provisioning network you created in the previous step.
- Replace NETWORK_CIDR with the Classless Inter-Domain Routing (CIDR) representation of the block of IP addresses the subnet represents. The block of IP addresses specified by the range started by START_IP and ended by END_IP must fall 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 will act 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 started by START_IP and ended by 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 will be 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 will be allocated.
Attach the network and subnet to the router to ensure the metadata requests are served by the OpenStack Networking service.
$ openstack router create ROUTER_NAMEReplace
ROUTER_NAMEwith a name for the router.Add the Bare Metal subnet to this router:
$ openstack router add subnet ROUTER_NAME BAREMETAL_SUBNET
Replace ROUTER_NAME with the name of your router and BAREMETAL_SUBNET with the ID or subnet name that you previously created. This allows the metadata requests from
cloud-initto be served and the node configured.
3.7. Configuring Node Cleaning
By default, the Bare Metal service is set to use a network named provisioning for node cleaning. However, network names are not unique in OpenStack Networking, so it is possible for a tenant to create a network with the same name, causing a conflict with the Bare Metal service. Therefore, it is recommended to use the network UUID instead.
Configure cleaning by providing the provider network UUID on the controller running the Bare Metal Service:
~/templates/ironic.yamlparameter_defaults: IronicCleaningNetwork: UUIDReplace UUID with the UUID of the bare metal network created in the previous steps.
You can find the UUID using
openstack network show:openstack network show NETWORK_NAME -f value -c idNoteThis configuration must be done after the initial overcloud deployment, because the UUID for the network isn’t available beforehand.
-
Apply the changes by redeploying the overcloud with the
openstack overcloud deploycommand as described in Section 3.4, “Deploying the Overcloud”. Uncomment the following line and replace
<None>with the UUID of the bare metal network:cleaning_network = <None>
Restart the Bare Metal service:
# systemctl restart openstack-ironic-conductor.service
Redeploying the overcloud with openstack overcloud deploy will revert any manual changes, so make sure you have added the cleaning configuration to ~/templates/ironic.yaml (described in the previous step) before the next time you use openstack overcloud deploy.
3.7.1. Manual Node Cleaning
To manually initiate node cleaning, the node must be in the manageable state.
Node cleaning has two modes:
Metadata only clean - Removes partitions from all disks on a given node. This is a faster clean cycle, but less secure since it only erases partition tables. Only use this mode on trusted tenant environments.
Full clean - Removes all data from all disks, using either ATA secure erase or by shredding. This can take several hours to complete.
To initiate a metadata clean:
$ openstack baremetal node clean UUID \ --clean-steps [{"interface": "deploy", "step": "erase_devices_metadata"}]
To initiate a full clean:
$ openstack baremetal node clean UUID \ --clean-steps [{"interface": "deploy", "step": "erase_devices"}]
Replace UUID with the UUID of the node you would like cleaned.
After a successful cleaning, the node state returns to manageable. If the state is clean failed, check the last_error field for the cause of failure.
3.8. Creating the Bare Metal Flavor
You need to create a flavor to use as a part of the deployment. The specifications (memory, CPU, and disk) of this flavor must be equal to or less than what your bare metal node provides.
Set up the shell to access Identity as the administrative user:
$ source ~/overcloudrc
List existing flavors:
$ openstack flavor list
Create a new flavor for the Bare Metal service:
$ openstack flavor create \ --id auto --ram RAM \ --vcpus VCPU --disk DISK \ --property baremetal=true \ --public baremetal
Replace
RAMwith the amount of memory,VCPUwith the number of vCPUs andDISKwith the disk storage value. The propertybaremetalis used to distinguish bare metal from virtual instances.Verify that the new flavor is created with the respective values:
$ openstack flavor list
3.9. Creating the Bare Metal Images
The deployment requires two sets of images:
-
The deploy image is used by the Bare Metal service to boot the bare metal node and copy a user image onto the bare metal node. The deploy image consists of the
kernelimage and theramdiskimage. The user image is the image deployed onto the bare metal node. The user image also has a
kernelimage andramdiskimage, but additionally, the user image contains amainimage. The main image is either a root partition, or a whole-disk image.- A whole-disk image is an image that contains the partition table and boot loader. The Bare Metal service does not control the subsequent reboot of a node deployed with a whole-disk image as the node supports localboot.
- A root partition image only contains the root partition of the operating system. If using a root partition, after the deploy image is loaded into the Image service, you can set the deploy image as the node’s boot image in the node’s properties. A subsequent reboot of the node uses netboot to pull down the user image.
The examples in this section use a root partition image to provision bare metal nodes.
3.9.1. Preparing the Deploy Images
You do not have to create the deploy image as it was already used when the overcloud was deployed by the undercloud. The deploy image consists of two images - the kernel image and the ramdisk image as follows:
ironic-python-agent.kernel ironic-python-agent.initramfs
These images are often in the home directory, unless you have deleted them, or unpacked them elsewhere. If they are not in the home directory, and you still have the rhosp-director-images-ipa package installed, these images will be in the /usr/share/rhosp-director-images/ironic-python-agent*.tar file.
Extract the images and upload them to the Image service:
$ openstack image create \ --container-format aki \ --disk-format aki \ --public \ --file ./ironic-python-agent.kernel bm-deploy-kernel $ openstack image create \ --container-format ari \ --disk-format ari \ --public \ --file ./ironic-python-agent.initramfs bm-deploy-ramdisk
3.9.2. Preparing the User Image
The final image that you need is the user image that will be deployed on the bare metal node. User images also have a kernel and ramdisk, along with a main image. To download and install these packages, you must first configure whole disk image environment variables to suit your requirements.
3.9.2.1. Disk Image Environment Variables
As a part of the disk image building process, the director requires a base image and registration details to obtain packages for the new overcloud image. You define these aspects using Linux environment variables.
The image building process temporarily registers the image with a Red Hat subscription and unregisters the system once the image building process completes.
To build a disk image, set Linux environment variables that suit your environment and requirements:
- DIB_LOCAL_IMAGE
- Sets the local image to use as your basis.
- REG_ACTIVATION_KEY
- Use an activation key instead as part of the registration process.
- REG_AUTO_ATTACH
- Defines whether or not to automatically attach the most compatible subscription.
- REG_BASE_URL
-
The base URL of the content delivery server to pull packages. The default Customer Portal Subscription Management process uses
https://cdn.redhat.com. If using a Red Hat Satellite 6 server, this parameter should use the base URL of your Satellite server. - REG_ENVIRONMENT
- Registers to an environment within an organization.
- REG_METHOD
-
Sets the method of registration. Use
portalto register a system to the Red Hat Customer Portal. Usesatelliteto register a system with Red Hat Satellite 6. - REG_ORG
- The organization to register the images.
- REG_POOL_ID
- The pool ID of the product subscription information.
- REG_PASSWORD
- Gives the password for the user account registering the image.
- REG_REPOS
-
A string of repository names separated with commas (no spaces). Each repository in this string is enabled through
subscription-manager. - REG_SERVER_URL
-
Gives the hostname of the subscription service to use. The default is for the Red Hat Customer Portal at
subscription.rhn.redhat.com. If using a Red Hat Satellite 6 server, this parameter should use the hostname of your Satellite server. - REG_USER
- Gives the user name for the account registering the image.
3.9.3. Installing the User Image
- Download the Red Hat Enterprise Linux KVM guest image from the Customer Portal (requires login).
Define DIB_LOCAL_IMAGE as the downloaded image:
$ export DIB_LOCAL_IMAGE=rhel-server-7.4-x86_64-kvm.qcow2
Set your registration information. If you use Red Hat Customer Portal, you must configure the following information:
$ export REG_USER='USER_NAME' $ export REG_PASSWORD='PASSWORD' $ export REG_AUTO_ATTACH=true $ export REG_METHOD=portal $ export https_proxy='IP_address:port' (if applicable) $ export http_proxy='IP_address:port' (if applicable)
If you use Red Hat Satellite, you must configure the following information:
$ export REG_USER='USER_NAME' $ export REG_PASSWORD='PASSWORD' $ export REG_SAT_URL='<SATELLITE URL>' $ export REG_ORG='<SATELLITE ORG>' $ export REG_ENV='<SATELLITE ENV>' $ export REG_METHOD=<METHOD>
If you have any offline repositories, you can define DIB_YUM_REPO_CONF as local repository configuration:
$ export DIB_YUM_REPO_CONF=<path-to-local-repository-config-file>
Create the user images using the
diskimage-buildertool:$ disk-image-create rhel7 baremetal -o rhel-image
This extracts the kernel as
rhel-image.vmlinuzand initial ramdisk asrhel-image.initrd.Upload the images to the Image service:
$ KERNEL_ID=$(openstack image create \ --file rhel-image.vmlinuz --public \ --container-format aki --disk-format aki \ -f value -c id rhel-image.vmlinuz) $ RAMDISK_ID=$(openstack image create \ --file rhel-image.initrd --public \ --container-format ari --disk-format ari \ -f value -c id rhel-image.initrd) $ openstack image create \ --file rhel-image.qcow2 --public \ --container-format bare \ --disk-format qcow2 \ --property kernel_id=$KERNEL_ID \ --property ramdisk_id=$RAMDISK_ID \ rhel-image
3.10. Adding Physical Machines as Bare Metal Nodes
There are two methods to enroll a bare metal node:
- Prepare an inventory file with the node details, import the file into the Bare Metal service, then make the nodes available.
- Register a physical machine as a bare metal node, then manually add its hardware details and create ports for each of its Ethernet MAC addresses. These steps can be performed on any node which has your overcloudrc file.
Both methods are detailed in this section.
After enrolling the physical machines, Compute is not immediately notified of new resources, because Compute’s resource tracker synchronizes periodically. Changes will be visible after the next periodic task is run. This value, scheduler_driver_task_period, can be updated in /etc/nova/nova.conf. The default period is 60 seconds.
3.10.1. Enrolling a Bare Metal Node With an Inventory File
Create a file
overcloud-nodes.yaml, including the node details. Multiple nodes can be enrolled with one file.nodes: - name: node0 driver: pxe_ipmitool driver_info: ipmi_address: <IPMI_IP> ipmi_username: <USER> ipmi_password: <PASSWORD> properties: cpus: <CPU_COUNT> cpu_arch: <CPU_ARCHITECTURE> memory_mb: <MEMORY> local_gb: <ROOT_DISK> root_device: serial: <SERIAL> ports: - address: <PXE_NIC_MAC>Replace the following values:
-
<IPMI_IP>with the address of the Bare Metal controller. -
<USER>with your username. -
<PASSWORD>with your password. -
<CPU_COUNT>with the number of CPUs. -
<CPU_ARCHITECTURE>with the type of architecture of the CPUs. -
<MEMORY>with the amount of memory in MiB. -
<ROOT_DISK>with the size of the root disk in GiB. <MAC_ADDRESS>with the MAC address of the NIC used to PXE boot.You only need to include
root_deviceif the machine has multiple disks. Replace<SERIAL>with the serial number of the disk you would like used for deployment.
-
Set up the shell to use Identity as the administrative user:
$ source ~/overcloudrc
Import the inventory file into ironic:
$ openstack baremetal create overcloud-nodes.yaml
The nodes are now in the
enrollstate. Make them available by specifying the deploy kernel and deploy ramdisk on each node:$ openstack baremetal node set NODE_UUID \ --driver-info deploy_kernel=KERNEL_UUID \ --driver-info deploy_ramdisk=INITRAMFS_UUID
Replace the following values:
- Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
Replace KERNEL_UUID with the unique identifier for the kernel deploy image that was uploaded to the Image service. Find this value with:
$ openstack image show bm-deploy-kernel -f value -c id
Replace INITRAMFS_UUID with the unique identifier for the ramdisk image that was uploaded to the Image service. Find this value with:
$ openstack image show bm-deploy-ramdisk -f value -c id
Check that the nodes were successfully enrolled:
$ openstack baremetal node list
There may be a delay between enrolling a node and its state being shown.
3.10.2. Enrolling a Bare Metal Node Manually
Set up the shell to use Identity as the administrative user:
$ source ~/overcloudrc
Add a new node:
$ openstack baremetal node create --driver pxe_impitool --name NAMETo create a node you must specify the driver name. This example uses
pxe_impitool. To use a different driver, you must enable it by setting theIronicEnabledDriversparameter. For more information on supported drivers, see Appendix A, Bare Metal Drivers.ImportantNote the unique identifier for the node.
Update the node driver information to allow the Bare Metal service to manage the node:
$ openstack baremetal node set NODE_UUID \ --driver_info PROPERTY=VALUE \ --driver_info PROPERTY=VALUE
Replace the following values:
- Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
- Replace PROPERTY with a required property returned by the ironic driver-properties command.
- Replace VALUE with a valid value for that property.
Specify the deploy kernel and deploy ramdisk for the node driver:
$ openstack baremetal node set NODE_UUID \ --driver-info deploy_kernel=KERNEL_UUID \ --driver-info deploy_ramdisk=INITRAMFS_UUID
Replace the following values:
- Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
- Replace KERNEL_UUID with the unique identifier for the .kernel image that was uploaded to the Image service.
- Replace INITRAMFS_UUID with the unique identifier for the .initramfs image that was uploaded to the Image service.
Update the node’s properties to match the hardware specifications on the node:
$ openstack baremetal node set NODE_UUID \ --property cpus=CPU \ --property memory_mb=RAM_MB \ --property local_gb=DISK_GB \ --property cpu_arch=ARCH
Replace the following values:
- Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
- Replace CPU with the number of CPUs.
- Replace RAM_MB with the RAM (in MB).
- Replace DISK_GB with the disk size (in GB).
- Replace ARCH with the architecture type.
OPTIONAL: Configure the node to reboot after initial deployment from a local boot loader installed on the node’s disk, instead of using PXE from
ironic-conductor. The local boot capability must also be set on the flavor used to provision the node. To enable local boot, the image used to deploy the node must contain grub2. Configure local boot:$ openstack baremetal node set NODE_UUID \ --property capabilities="boot_option:local"Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
Inform the Bare Metal service of the node’s network card by creating a port with the MAC address of the NIC on the provisioning network:
$ openstack baremetal port create --node NODE_UUID MAC_ADDRESS
Replace NODE_UUID with the unique identifier for the node. Replace MAC_ADDRESS with the MAC address of the NIC used to PXE boot.
If you have multiple disks, set the root device hints. This informs the deploy ramdisk which disk it should use for deployment.
$ openstack baremetal node set NODE_UUID \ --property root_device={"PROPERTY": "VALUE"}
Replace with the following values:
- Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name.
Replace PROPERTY and VALUE with details about the disk you want used for deployment, for example
root_device='{"size": 128}'The following properties are supported:
-
model(String): Device identifier. -
vendor(String): Device vendor. -
serial(String): Disk serial number. -
hctl(String): Host:Channel:Target:Lun for SCSI. -
size(Integer): Size of the device in GB. -
wwn(String): Unique storage identifier. -
wwn_with_extension(String): Unique storage identifier with the vendor extension appended. -
wwn_vendor_extension(String): Unique vendor storage identifier. -
rotational(Boolean): True for a rotational device (HDD), otherwise false (SSD). name(String): The name of the device, for example: /dev/sdb1 Only use this for devices with persistent names.NoteIf you specify more than one property, the device must match all of those properties.
-
Validate the node’s setup:
$ openstack baremetal node validate NODE_UUID +------------+--------+---------------------------------------------+ | Interface | Result | Reason | +------------+--------+---------------------------------------------+ | boot | False | Cannot validate image information for node | | | | a02178db-1550-4244-a2b7-d7035c743a9b | | | | because one or more parameters are missing | | | | from its instance_info. Missing are: | | | | ['ramdisk', 'kernel', 'image_source'] | | console | None | not supported | | deploy | False | Cannot validate image information for node | | | | a02178db-1550-4244-a2b7-d7035c743a9b | | | | because one or more parameters are missing | | | | from its instance_info. Missing are: | | | | ['ramdisk', 'kernel', 'image_source'] | | inspect | None | not supported | | management | True | | | network | True | | | power | True | | | raid | True | | | storage | True | | +------------+--------+---------------------------------------------+Replace NODE_UUID with the unique identifier for the node. Alternatively, use the node’s logical name. The output of the command above should report either
TrueorNonefor each interface. Interfaces markedNoneare those that you have not configured, or those that are not supported for your driver.NoteInterfaces may fail validation due to missing 'ramdisk', 'kernel', and 'image_source' parameters. This result is fine, because the Compute service populates those missing parameters at the beginning of the deployment process.
3.11. Using Host Aggregates to Separate Physical and Virtual Machine Provisioning
OpenStack Compute uses host aggregates to partition availability zones, and group together nodes with specific shared properties. When an instance is provisioned, Compute’s scheduler compares properties on the flavor with the properties assigned to host aggregates, and ensures that the instance is provisioned in the correct aggregate and on the correct host: either on a physical machine or as a virtual machine.
The procedure below describes how to do the following:
-
Add the property
baremetalto your flavors, setting it to eithertrueorfalse. -
Create separate host aggregates for bare metal hosts and compute nodes with a matching
baremetalproperty. Nodes grouped into an aggregate inherit this property.
Creating a Host Aggregate
Set the
baremetalproperty totrueon the baremetal flavor.$ openstack flavor set baremetal --property baremetal=true
Set the
baremetalproperty tofalseon the flavors used for virtual instances.$ openstack flavor set FLAVOR_NAME --property baremetal=falseCreate a host aggregate called
baremetal-hosts:$ openstack aggregate create --property baremetal=true baremetal-hosts
Add each controller node to the
baremetal-hostsaggregate:$ openstack aggregate add host baremetal-hosts HOSTNAMENoteIf you have created a composable role with the
NovaIronicservice, add all the nodes with this service to thebaremetal-hostsaggregate. By default, only the controller nodes have theNovaIronicservice.Create a host aggregate called
virtual-hosts:$ openstack aggregate create --property baremetal=false virtual-hosts
Add each compute node to the
virtual-hostsaggregate:$ openstack aggregate add host virtual-hosts HOSTNAMEIf you did not add the following Compute filter scheduler when deploying the overcloud, add it now to the existing list under
scheduler_default_filtersin /etc/nova/nova.conf:AggregateInstanceExtraSpecsFilter
