Jump to contentJump to page navigation: previous page [access key p]/next page [access key n]
ContentsContents
Deployment Guide using Cloud Lifecycle Manager
  1. I Planning an Installation using Cloud Lifecycle Manager
    1. 1 Registering SLES
    2. 2 Hardware and Software Support Matrix
    3. 3 Recommended Hardware Minimums for the Example Configurations
    4. 4 High Availability
  2. II Cloud Lifecycle Manager Overview
    1. 5 Input Model
    2. 6 Configuration Objects
    3. 7 Other Topics
    4. 8 Configuration Processor Information Files
    5. 9 Example Configurations
    6. 10 Modifying Example Configurations for Compute Nodes
    7. 11 Modifying Example Configurations for Object Storage using Swift
    8. 12 Alternative Configurations
  3. III Pre-Installation
    1. 13 Overview
    2. 14 Pre-Installation Checklist
    3. 15 Installing the Cloud Lifecycle Manager server
    4. 16 Installing and Setting Up an SMT Server on the Cloud Lifecycle Manager server (Optional)
    5. 17 Software Repository Setup
    6. 18 Boot from SAN and Multipath Configuration
  4. IV Cloud Installation
    1. 19 Overview
    2. 20 Preparing for Stand-Alone Deployment
    3. 21 Installing with the Install UI
    4. 22 Using Git for Configuration Management
    5. 23 Installing a Stand-Alone Cloud Lifecycle Manager
    6. 24 Installing Mid-scale and Entry-scale KVM
    7. 25 DNS Service Installation Overview
    8. 26 Magnum Overview
    9. 27 Installing ESX Computes and OVSvAPP
    10. 28 Integrating NSX for vSphere
    11. 29 Installing Baremetal (Ironic)
    12. 30 Installation for SUSE OpenStack Cloud Entry-scale Cloud with Swift Only
    13. 31 Installing SLES Compute
    14. 32 Installing manila and Creating manila Shares
    15. 33 Installing SUSE CaaS Platform heat Templates
    16. 34 Installing SUSE CaaS Platform v4 using terraform
    17. 35 Integrations
    18. 36 Troubleshooting the Installation
    19. 37 Troubleshooting the ESX
  5. V Post-Installation
    1. 38 Post Installation Tasks
    2. 39 UI Verification
    3. 40 Installing OpenStack Clients
    4. 41 Configuring Transport Layer Security (TLS)
    5. 42 Configuring Availability Zones
    6. 43 Configuring Load Balancer as a Service
    7. 44 Other Common Post-Installation Tasks
  6. VI Support
    1. 45 FAQ
    2. 46 Support
    3. 47 Applying PTFs (Program Temporary Fixes) Provided by SUSE L3 Support
    4. 48 Testing PTFs (Program Temporary Fixes) on a Single Node
Navigation
Applies to SUSE OpenStack Cloud 9

29 Installing Baremetal (Ironic) Edit source

Bare Metal as a Service is enabled in this release for deployment of nova instances on bare metal nodes using flat networking.

29.1 Installation for SUSE OpenStack Cloud Entry-scale Cloud with Ironic Flat Network Edit source

This page describes the installation step requirements for the SUSE OpenStack Cloud Entry-scale Cloud with ironic Flat Network.

29.1.1 Configure Your Environment Edit source

Prior to deploying an operational environment with ironic, operators need to be aware of the nature of TLS certificate authentication. As pre-built deployment agent ramdisks images are supplied, these ramdisk images will only authenticate known third-party TLS Certificate Authorities in the interest of end-to-end security. As such, uses of self-signed certificates and private certificate authorities will be unable to leverage ironic without modifying the supplied ramdisk images.

  1. Set up your configuration files, as follows:

    1. See the sample sets of configuration files in the ~/openstack/examples/ directory. Each set will have an accompanying README.md file that explains the contents of each of the configuration files.

    2. Copy the example configuration files into the required setup directory and edit them to contain the details of your environment:

      cp -r ~/openstack/examples/entry-scale-ironic-flat-network/* \
        ~/openstack/my_cloud/definition/
  2. (Optional) You can use the ardanaencrypt.py script to encrypt your IPMI passwords. This script uses OpenSSL.

    1. Change to the Ansible directory:

      ardana > cd ~/openstack/ardana/ansible
    2. Put the encryption key into the following environment variable:

      export ARDANA_USER_PASSWORD_ENCRYPT_KEY=<encryption key>
    3. Run the python script below and follow the instructions. Enter a password that you want to encrypt.

      ardana > ./ardanaencrypt.py
    4. Take the string generated and place it in the ilo-password field in your ~/openstack/my_cloud/definition/data/servers.yml file, remembering to enclose it in quotes.

    5. Repeat the above for each server.

      Note
      Note

      Before you run any playbooks, remember that you need to export the encryption key in the following environment variable: export ARDANA_USER_PASSWORD_ENCRYPT_KEY=<encryption key>

  3. Commit your configuration to the local git repo (Chapter 22, Using Git for Configuration Management), as follows:

    ardana > cd ~/openstack/ardana/ansible
    ardana > git add -A
    ardana > git commit -m "My config or other commit message"
    Important
    Important

    This step needs to be repeated any time you make changes to your configuration files before you move on to the following steps. See Chapter 22, Using Git for Configuration Management for more information.

29.1.2 Provisioning Your Baremetal Nodes Edit source

To provision the baremetal nodes in your cloud deployment you can either use the automated operating system installation process provided by SUSE OpenStack Cloud or you can use the 3rd party installation tooling of your choice. We will outline both methods below:

29.1.2.1 Using Third Party Baremetal Installers Edit source

If you do not wish to use the automated operating system installation tooling included with SUSE OpenStack Cloud then the requirements that have to be met using the installation tooling of your choice are:

  • The operating system must be installed via the SLES ISO provided on the SUSE Customer Center.

  • Each node must have SSH keys in place that allows the same user from the Cloud Lifecycle Manager node who will be doing the deployment to SSH to each node without a password.

  • Passwordless sudo needs to be enabled for the user.

  • There should be a LVM logical volume as /root on each node.

  • If the LVM volume group name for the volume group holding the root LVM logical volume is ardana-vg, then it will align with the disk input models in the examples.

  • Ensure that openssh-server, python, python-apt, and rsync are installed.

If you chose this method for installing your baremetal hardware, skip forward to the step Running the Configuration Processor.

29.1.2.2 Using the Automated Operating System Installation Provided by SUSE OpenStack Cloud Edit source

If you would like to use the automated operating system installation tools provided by SUSE OpenStack Cloud, complete the steps below.

29.1.2.2.1 Deploying Cobbler Edit source

This phase of the install process takes the baremetal information that was provided in servers.yml and installs the Cobbler provisioning tool and loads this information into Cobbler. This sets each node to netboot-enabled: true in Cobbler. Each node will be automatically marked as netboot-enabled: false when it completes its operating system install successfully. Even if the node tries to PXE boot subsequently, Cobbler will not serve it. This is deliberate so that you cannot reimage a live node by accident.

The cobbler-deploy.yml playbook prompts for a password - this is the password that will be encrypted and stored in Cobbler, which is associated with the user running the command on the Cloud Lifecycle Manager, that you will use to log in to the nodes via their consoles after install. The username is the same as the user set up in the initial dialogue when installing the Cloud Lifecycle Manager from the ISO, and is the same user that is running the cobbler-deploy play.

Note
Note

When imaging servers with your own tooling, it is still necessary to have ILO/IPMI settings for all nodes. Even if you are not using Cobbler, the username and password fields in servers.yml need to be filled in with dummy settings. For example, add the following to servers.yml:

ilo-user: manual
ilo-password: deployment
  1. Run the following playbook which confirms that there is IPMI connectivity for each of your nodes so that they are accessible to be re-imaged in a later step:

    ardana > cd ~/openstack/ardana/ansible
    ardana > ansible-playbook -i hosts/localhost bm-power-status.yml
  2. Run the following playbook to deploy Cobbler:

    ardana > cd ~/openstack/ardana/ansible
    ardana > ansible-playbook -i hosts/localhost cobbler-deploy.yml
29.1.2.2.2 Imaging the Nodes Edit source

This phase of the install process goes through a number of distinct steps:

  1. Powers down the nodes to be installed

  2. Sets the nodes hardware boot order so that the first option is a network boot.

  3. Powers on the nodes. (The nodes will then boot from the network and be installed using infrastructure set up in the previous phase)

  4. Waits for the nodes to power themselves down (this indicates a successful install). This can take some time.

  5. Sets the boot order to hard disk and powers on the nodes.

  6. Waits for the nodes to be reachable by SSH and verifies that they have the signature expected.

Deploying nodes has been automated in the Cloud Lifecycle Manager and requires the following:

  • All of your nodes using SLES must already be installed, either manually or via Cobbler.

  • Your input model should be configured for your SLES nodes.

  • You should have run the configuration processor and the ready-deployment.yml playbook.

Execute the following steps to re-image one or more nodes after you have run the ready-deployment.yml playbook.

  1. Run the following playbook, specifying your SLES nodes using the nodelist. This playbook will reconfigure Cobbler for the nodes listed.

    ardana > cd ~/openstack/ardana/ansible
    ardana > ansible-playbook prepare-sles-grub2.yml -e \
          nodelist=node1[,node2,node3]
  2. Re-image the node(s) with the following command:

    ardana > cd ~/openstack/ardana/ansible
    ardana > ansible-playbook -i hosts/localhost bm-reimage.yml \
          -e nodelist=node1[,node2,node3]

If a nodelist is not specified then the set of nodes in Cobbler with netboot-enabled: True is selected. The playbook pauses at the start to give you a chance to review the set of nodes that it is targeting and to confirm that it is correct.

You can use the command below which will list all of your nodes with the netboot-enabled: True flag set:

sudo cobbler system find --netboot-enabled=1

29.1.3 Running the Configuration Processor Edit source

Once you have your configuration files setup, you need to run the configuration processor to complete your configuration.

When you run the configuration processor, you will be prompted for two passwords. Enter the first password to make the configuration processor encrypt its sensitive data, which consists of the random inter-service passwords that it generates and the ansible group_vars and host_vars that it produces for subsequent deploy runs. You will need this password for subsequent Ansible deploy and configuration processor runs. If you wish to change an encryption password that you have already used when running the configuration processor then enter the new password at the second prompt, otherwise just press Enter to bypass this.

Run the configuration processor with this command:

ardana > cd ~/openstack/ardana/ansible
ardana > ansible-playbook -i hosts/localhost config-processor-run.yml

For automated installation (for example CI), you can specify the required passwords on the ansible command line. For example, the command below will disable encryption by the configuration processor:

ardana > ansible-playbook -i hosts/localhost config-processor-run.yml \
  -e encrypt="" -e rekey=""

If you receive an error during this step, there is probably an issue with one or more of your configuration files. Verify that all information in each of your configuration files is correct for your environment. Then commit those changes to Git using the instructions in the previous section before re-running the configuration processor again.

For any troubleshooting information regarding these steps, see Section 36.2, “Issues while Updating Configuration Files”.

29.1.4 Deploying the Cloud Edit source

  1. Use the playbook below to create a deployment directory:

    cd ~/openstack/ardana/ansible
    ansible-playbook -i hosts/localhost ready-deployment.yml
  2. [OPTIONAL] - Run the wipe_disks.yml playbook to ensure all of your non-OS partitions on your nodes are completely wiped before continuing with the installation. The wipe_disks.yml playbook is only meant to be run on systems immediately after running bm-reimage.yml. If used for any other case, it may not wipe all of the expected partitions.

    If you are using fresh machines this step may not be necessary.

    ardana > cd ~/scratch/ansible/next/ardana/ansible
    ardana > ansible-playbook -i hosts/verb_hosts wipe_disks.yml

    If you have used an encryption password when running the configuration processor use the command below and enter the encryption password when prompted:

    ardana > ansible-playbook -i hosts/verb_hosts wipe_disks.yml --ask-vault-pass
  3. Run the site.yml playbook below:

    ardana > cd ~/scratch/ansible/next/ardana/ansible
    ardana > ansible-playbook -i hosts/verb_hosts site.yml

    If you have used an encryption password when running the configuration processor use the command below and enter the encryption password when prompted:

    ardana > ansible-playbook -i hosts/verb_hosts site.yml --ask-vault-pass
    Note
    Note

    The step above runs osconfig to configure the cloud and ardana-deploy to deploy the cloud. Therefore, this step may run for a while, perhaps 45 minutes or more, depending on the number of nodes in your environment.

  4. Verify that the network is working correctly. Ping each IP in the /etc/hosts file from one of the controller nodes.

For any troubleshooting information regarding these steps, see Section 36.3, “Issues while Deploying the Cloud”.

29.1.5 Ironic configuration Edit source

Run the ironic-cloud-configure.yml playbook below:

cd ~/scratch/ansible/next/ardana/ansible
ansible-playbook -i hosts/verb_hosts ironic-cloud-configure.yml

This step configures ironic flat network, uploads glance images and sets the ironic configuration.

To see the images uploaded to glance, run:

$ source ~/service.osrc
$ openstack image list

This will produce output like the following example, showing three images that have been added by ironic:

+--------------------------------------+--------------------------+
| ID                                   | Name                     |
+--------------------------------------+--------------------------+
| d4e2a0ff-9575-4bed-ac5e-5130a1553d93 | ir-deploy-iso-HOS3.0     |
| b759a1f0-3b33-4173-a6cb-be5706032124 | ir-deploy-kernel-HOS3.0  |
| ce5f4037-e368-46f2-941f-c01e9072676c | ir-deploy-ramdisk-HOS3.0 |
+--------------------------------------+--------------------------+

To see the network created by ironic, run:

$ openstack network list

This returns details of the "flat-net" generated by the ironic install:

 +---------------+----------+-------------------------------------------------------+
 | id            | name     | subnets                                               |
 +---------------+----------+-------------------------------------------------------+
 | f9474...11010 | flat-net | ca8f8df8-12c8-4e58-b1eb-76844c4de7e8 192.168.245.0/24 |
 +---------------+----------+-------------------------------------------------------+

29.1.6 Node Configuration Edit source

29.1.6.1 DHCP Edit source

Once booted, nodes obtain network configuration via DHCP. If multiple interfaces are to be utilized, you may want to pre-build images with settings to execute DHCP on all interfaces. An easy way to build custom images is with KIWI, the command line utility to build Linux system appliances.

For information about building custom KIWI images, see Section 29.3.13, “Building glance Images Using KIWI”. For more information, see the KIWI documentation at https://osinside.github.io/kiwi/.

29.1.6.2 Configuration Drives Edit source

Warning
Warning

Configuration Drives are stored unencrypted and should not include any sensitive data.

You can use Configuration Drives to store metadata for initial boot setting customization. Configuration Drives are extremely useful for initial machine configuration. However, as a general security practice, they should not include any sensitive data. Configuration Drives should only be trusted upon the initial boot of an instance. cloud-init utilizes a lock file for this purpose. Custom instance images should not rely upon the integrity of a Configuration Drive beyond the initial boot of a host as an administrative user within a deployed instance can potentially modify a configuration drive once written to disk and released for use.

For more information about Configuration Drives, see http://docs.openstack.org/user-guide/cli_config_drive.html.

29.1.7 TLS Certificates with Ironic Python Agent (IPA) Images Edit source

As part of SUSE OpenStack Cloud 9, ironic Python Agent, better known as IPA in the OpenStack community, images are supplied and loaded into glance. Two types of image exist. One is a traditional boot ramdisk which is used by the agent_ipmitool, pxe_ipmitool, and pxe_ilo drivers. The other is an ISO image that is supplied as virtual media to the host when using the agent_ilo driver.

As these images are built in advance, they are unaware of any private certificate authorities. Users attempting to utilize self-signed certificates or a private certificate authority will need to inject their signing certificate(s) into the image in order for IPA to be able to boot on a remote node, and ensure that the TLS endpoints being connected to in SUSE OpenStack Cloud can be trusted. This is not an issue with publicly signed certificates.

As two different types of images exist, below are instructions for disassembling the image ramdisk file or the ISO image. Once this has been done, you will need to re-upload the files to glance, and update any impacted node's driver_info, for example, the deploy_ramdisk and ilo_deploy_iso settings that were set when the node was first defined. Respectively, this can be done with the

ironic node-update <node> replace driver_info/deploy_ramdisk=<glance_id>

or

ironic node-update <node> replace driver_info/ilo_deploy_iso=<glance_id>

29.1.7.1 Add New Trusted CA Certificate Into Deploy Images Edit source

Perform the following steps.

  1. To upload your trusted CA certificate to the Cloud Lifecycle Manager, follow the directions in Section 41.7, “Upload to the Cloud Lifecycle Manager”.

  2. Delete the deploy images.

    ardana > openstack image delete ir-deploy-iso-ARDANA5.0
    ardana > openstack image delete ir-deploy-ramdisk-ARDANA5.0
  3. On the deployer, run ironic-reconfigure.yml playbook to re-upload the images that include the new trusted CA bundle.

    ardana > cd /var/lib/ardana/scratch/ansible/next/ardana/ansible
    ardana > ansible-playbook -i hosts/verb_hosts ironic-reconfigure.yml
  4. Update the existing ironic nodes with the new image IDs accordingly. For example,

    ardana > openstack baremetal node set --driver-info \
    deploy_ramdisk=NEW_RAMDISK_ID NODE_ID

29.2 ironic in Multiple Control Plane Edit source

SUSE OpenStack Cloud 9 introduces the concept of multiple control planes - see the Input Model documentation for the relevant Section 5.2.2.1, “Control Planes and Regions” and Section 6.2.3, “Multiple Control Planes”. This document covers the use of an ironic region in a multiple control plane cloud model in SUSE OpenStack Cloud.

29.2.1 Networking for Baremetal in Multiple Control Plane Edit source

IRONIC-FLAT-NET is the network configuration for baremetal control plane.

You need to set the environment variable OS_REGION_NAME to the ironic region in baremetal control plane. This will set up the ironic flat networking in neutron.

export OS_REGION_NAME=<ironic_region>

To see details of the IRONIC-FLAT-NETWORK created during configuration, use the following command:

openstack network list

Referring to the diagram below, the Cloud Lifecycle Manager is a shared service that runs in a Core API Controller in a Core API Cluster. ironic Python Agent (IPA) must be able to make REST API calls to the ironic API (the connection is represented by the green line to Internal routing). The IPA connect to swift to get user images (the gray line connecting to swift routing).

Architecture of Multiple Control Plane with ironic
Figure 29.1: Architecture of Multiple Control Plane with ironic

29.2.2 Handling Optional swift Service Edit source

swift is resource-intensive and as a result, it is now optional in the SUSE OpenStack Cloud control plane. A number of services depend on swift, and if it is not present, they must provide a fallback strategy. For example, glance can use the filesystem in place of swift for its backend store.

In ironic, agent-based drivers require swift. If it is not present, it is necessary to disable access to this ironic feature in the control plane. The enable_agent_driver flag has been added to the ironic configuration data and can have values of true or false. Setting this flag to false will disable swift configurations and the agent based drivers in the ironic control plane.

29.2.3 Instance Provisioning Edit source

In a multiple control plane cloud setup, changes for glance container name in the swift namespace of ironic-conductor.conf introduces a conflict with the one in glance-api.conf. Provisioning with agent-based drivers requires the container name to be the same in ironic and glance. Hence, on instance provisioning with agent-based drivers (swift-enabled), the agent is not able to fetch the images from glance store and fails at that point.

You can resolve this issue using the following steps:

  1. Copy the value of swift_store_container from the file /opt/stack/service/glance-api/etc/glance-api.conf

  2. Log in to the Cloud Lifecycle Manager and use the value for swift_container in glance namespace of ~/scratch/ansible/next/ardana/ansible/roles/ironic-common/templates/ironic-conductor.conf.j2

  3. Run the following playbook:

    cd ~/scratch/ansible/next/ardana/ansible
    ansible-playbook -i hosts/verb_hosts ironic-reconfigure.yml

29.3 Provisioning Bare-Metal Nodes with Flat Network Model Edit source

Warning
Warning

Providing bare-metal resources to an untrusted third party is not advised as a malicious user can potentially modify hardware firmware.

Important
Important

The steps outlined in Section 29.1.7, “TLS Certificates with Ironic Python Agent (IPA) Images” must be performed.

A number of drivers are available to provision and manage bare-metal machines. The drivers are named based on the deployment mode and the power management interface. SUSE OpenStack Cloud has been tested with the following drivers:

  • agent_ilo

  • agent_ipmi

  • pxe_ilo

  • pxe_ipmi

  • Redfish

Before you start, you should be aware that:

  1. Node Cleaning is enabled for all the drivers in SUSE OpenStack Cloud 9.

  2. Node parameter settings must have matching flavors in terms of cpus, local_gb, and memory_mb, boot_mode and cpu_arch.

  3. It is advisable that nodes enrolled for ipmitool drivers are pre-validated in terms of BIOS settings, in terms of boot mode, prior to setting capabilities.

  4. Network cabling and interface layout should also be pre-validated in any given particular boot mode or configuration that is registered.

  5. The use of agent_ drivers is predicated upon glance images being backed by a swift image store, specifically the need for the temporary file access features. Using the file system as a glance back-end image store means that the agent_ drivers cannot be used.

  6. Manual Cleaning (RAID) and Node inspection is supported by ilo drivers (agent_ilo and pxe_ilo)

29.3.1 Redfish Protocol Support Edit source

Redfish is a successor to the Intelligent Platform Management Interface (IPMI) with the ability to scale to larger and more diverse cloud deployments. It has an API that allows users to collect performance data from heterogeneous server installations and more data sources than could be handled previously. It is based on an industry standard protocol with a RESTful interface for managing cloud assets that are compliant with the Redfish protocol.

Note
Note

There are two known limitations to using Redfish.

  • RAID configuration does not work due to missing HPE Smart Storage Administrator CLI (HPE SSACLI) in the default deploy RAM disk. This is a licensing issue.

  • The ironic inspector inspect interface is not supported.

Enable the Redfish driver with the following steps:

  1. Install the Sushy library on the ironic-conductor nodes. Sushy is a Python library for communicating with Redfish-based systems with ironic. More information is available at https://opendev.org/openstack/sushy/.

    sudo pip install sushy
  2. Add redfish to the list of enabled_hardware_types, enabled_power_interfaces and enabled_management_interfaces in /etc/ironic/ironic.conf as shown below:

    [DEFAULT]
    ...
    enabled_hardware_types = ipmi,redfish
    enabled_power_interfaces = ipmitool,redfish
    enabled_management_interfaces = ipmitool,redfish
  3. Restart the ironic-conductor service:

    sudo systemctl restart openstack-ironic-conductor

To continue with Redfish, see Section 29.3.4, “Registering a Node with the Redfish Driver”.

29.3.2 Supplied Images Edit source

As part of the SUSE OpenStack Cloud Entry-scale ironic Cloud installation, ironic Python Agent (IPA) images are supplied and loaded into glance. To see the images that have been loaded, execute the following commands on the deployer node:

$ source ~/service.osrc
openstack image list

This will display three images that have been added by ironic:

Deploy_iso : openstack-ironic-image.x86_64-8.0.0.kernel.4.4.120-94.17-default
Deploy_kernel : openstack-ironic-image.x86_64-8.0.0.xz
Deploy_ramdisk : openstack-ironic-image.x86_64-8.0.0.iso

The ir-deploy-ramdisk image is a traditional boot ramdisk used by the agent_ipmitool, pxe_ipmitool, and pxe_ilo drivers while ir-deploy-iso is an ISO image that is supplied as virtual media to the host when using the agent_ilo driver.

29.3.3 Provisioning a Node Edit source

The information required to provision a node varies slightly depending on the driver used. In general the following details are required.

  • Network access information and credentials to connect to the management interface of the node.

  • Sufficient properties to allow for nova flavor matching.

  • A deployment image to perform the actual deployment of the guest operating system to the bare-metal node.

A combination of the ironic node-create and ironic node-update commands are used for registering a node's characteristics with the ironic service. In particular, ironic node-update <nodeid> add and ironic node-update <nodeid> replace can be used to modify the properties of a node after it has been created while ironic node-update <nodeid> remove will remove a property.

29.3.4 Registering a Node with the Redfish Driver Edit source

Nodes configured to use the Redfish driver should have the driver property set to redfish.

The following properties are specified in the driver_info field of the node:

redfish_address (required)

The URL address to the Redfish controller. It must include the authority portion of the URL, and can optionally include the scheme. If the scheme is missing, HTTPS is assumed.

redfish_system_id (required)

The canonical path to the system resource that the driver interacts with. It should include the root service, version and the unique path to the system resource. For example, /redfish/v1/Systems/1.

redfish_user name (recommended)

User account with admin and server-profile access privilege.

redfish_password (recommended)

User account password.

redfish_verify_ca (optional)

If redfish_address has the HTTPS scheme, the driver will use a secure (TLS) connection when talking to the Redfish controller. By default (if this is not set or set to True), the driver will try to verify the host certificates. This can be set to the path of a certificate file or directory with trusted certificates that the driver will use for verification. To disable verifying TLS, set this to False.

The openstack baremetal node create command is used to enroll a node with the Redfish driver. For example:

openstack baremetal node create --driver redfish --driver-info \
redfish_address=https://example.com --driver-info \
redfish_system_id=/redfish/v1/Systems/CX34R87 --driver-info \
redfish_username=admin --driver-info redfish_password=password

29.3.5 Creating a Node Using agent_ilo Edit source

If you want to use a boot mode of BIOS as opposed to UEFI, then you need to ensure that the boot mode has been set correctly on the IPMI:

While the iLO driver can automatically set a node to boot in UEFI mode via the boot_mode defined capability, it cannot set BIOS boot mode once UEFI mode has been set.

Use the ironic node-create command to specify the agent_ilo driver, network access and credential information for the IPMI, properties of the node and the glance ID of the supplied ISO IPA image. Note that memory size is specified in megabytes while disk size is specified in gigabytes.

ironic node-create -d agent_ilo -i ilo_address=IP_ADDRESS -i \
  ilo_username=Administrator -i ilo_password=PASSWORD \
  -p cpus=2 -p cpu_arch=x86_64 -p memory_mb=64000 -p local_gb=99 \
  -i ilo_deploy_iso=DEPLOY_UUID

This will generate output similar to the following:

+--------------+---------------------------------------------------------------+
| Property     | Value                                                         |
+--------------+---------------------------------------------------------------+
| uuid         | NODE_UUID                                                     |
| driver_info  | {u'ilo_address': u'IP_ADDRESS', u'ilo_password': u'******',   |
|              | u'ilo_deploy_iso': u'DEPLOY_UUID',                            |
|              | u'ilo_username': u'Administrator'}                            |
| extra        | {}                                                            |
| driver       | agent_ilo                                                     |
| chassis_uuid |                                                               |
| properties   | {u'memory_mb': 64000, u'local_gb': 99, u'cpus': 2,            |
|              | u'cpu_arch': u'x86_64'}                                       |
| name         | None                                                          |
+--------------+---------------------------------------------------------------+

Now update the node with boot_mode and boot_option properties:

ironic node-update NODE_UUID add \
  properties/capabilities="boot_mode:bios,boot_option:local"

The ironic node-update command returns details for all of the node's characteristics.

+------------------------+------------------------------------------------------------------+
| Property               | Value                                                            |
+------------------------+------------------------------------------------------------------+
| target_power_state     | None                                                             |
| extra                  | {}                                                               |
| last_error             | None                                                             |
| updated_at             | None                                                             |
| maintenance_reason     | None                                                             |
| provision_state        | available                                                        |
| clean_step             | {}                                                               |
| uuid                   | NODE_UUID                                                        |
| console_enabled        | False                                                            |
| target_provision_state | None                                                             |
| provision_updated_at   | None                                                             |
| maintenance            | False                                                            |
| inspection_started_at  | None                                                             |
| inspection_finished_at | None                                                             |
| power_state            | None                                                             |
| driver                 | agent_ilo                                                        |
| reservation            | None                                                             |
| properties             | {u'memory_mb': 64000, u'cpu_arch': u'x86_64', u'local_gb': 99,   |
|                        | u'cpus': 2, u'capabilities': u'boot_mode:bios,boot_option:local'}|
| instance_uuid          | None                                                             |
| name                   | None                                                             |
| driver_info            | {u'ilo_address': u'10.1.196.117', u'ilo_password': u'******',    |
|                        | u'ilo_deploy_iso': u'DEPLOY_UUID',                               |
|                        | u'ilo_username': u'Administrator'}                               |
| created_at             | 2016-03-11T10:17:10+00:00                                        |
| driver_internal_info   | {}                                                               |
| chassis_uuid           |                                                                  |
| instance_info          | {}                                                               |
+------------------------+------------------------------------------------------------------+

29.3.6 Creating a Node Using agent_ipmi Edit source

Use the ironic node-create command to specify the agent_ipmi driver, network access and credential information for the IPMI, properties of the node and the glance IDs of the supplied kernel and ramdisk images. Note that memory size is specified in megabytes while disk size is specified in gigabytes.

ironic node-create -d agent_ipmitool \
  -i ipmi_address=IP_ADDRESS \
  -i ipmi_username=Administrator -i ipmi_password=PASSWORD \
  -p cpus=2 -p memory_mb=64000 -p local_gb=99 -p cpu_arch=x86_64 \
  -i deploy_kernel=KERNEL_UUID \
  -i deploy_ramdisk=RAMDISK_UUID

This will generate output similar to the following:

+--------------+-----------------------------------------------------------------------+
| Property     | Value                                                                 |
+--------------+-----------------------------------------------------------------------+
| uuid         | NODE2_UUID                                                            |
| driver_info  | {u'deploy_kernel': u'KERNEL_UUID',                                    |
|              | u'ipmi_address': u'IP_ADDRESS', u'ipmi_username': u'Administrator',   |
|              | u'ipmi_password': u'******',                                          |
|              | u'deploy_ramdisk': u'RAMDISK_UUID'}                                   |
| extra        | {}                                                                    |
| driver       | agent_ipmitool                                                        |
| chassis_uuid |                                                                       |
| properties   | {u'memory_mb': 64000, u'cpu_arch': u'x86_64', u'local_gb': 99,        |
|              | u'cpus': 2}                                                           |
| name         | None                                                                  |
+--------------+-----------------------------------------------------------------------+

Now update the node with boot_mode and boot_option properties:

ironic node-update NODE_UUID add \
  properties/capabilities="boot_mode:bios,boot_option:local"

The ironic node-update command returns details for all of the node's characteristics.

+------------------------+-----------------------------------------------------------------+
| Property               | Value                                                           |
+------------------------+-----------------------------------------------------------------+
| target_power_state     | None                                                            |
| extra                  | {}                                                              |
| last_error             | None                                                            |
| updated_at             | None                                                            |
| maintenance_reason     | None                                                            |
| provision_state        | available                                                       |
| clean_step             | {}                                                              |
| uuid                   | NODE2_UUID                                                      |
| console_enabled        | False                                                           |
| target_provision_state | None                                                            |
| provision_updated_at   | None                                                            |
| maintenance            | False                                                           |
| inspection_started_at  | None                                                            |
| inspection_finished_at | None                                                            |
| power_state            | None                                                            |
| driver                 | agent_ipmitool                                                  |
| reservation            | None                                                            |
| properties             | {u'memory_mb': 64000, u'cpu_arch': u'x86_64',                   |
|                        | u'local_gb': 99, u'cpus': 2,                                    |
|                        | u'capabilities': u'boot_mode:bios,boot_option:local'}           |
| instance_uuid          | None                                                            |
| name                   | None                                                            |
| driver_info            | {u'ipmi_password': u'******', u'ipmi_address': u'IP_ADDRESS',   |
|                        | u'ipmi_username': u'Administrator', u'deploy_kernel':           |
|                        | u'KERNEL_UUID',                                                 |
|                        | u'deploy_ramdisk': u'RAMDISK_UUID'}                             |
| created_at             | 2016-03-11T14:19:18+00:00                                       |
| driver_internal_info   | {}                                                              |
| chassis_uuid           |                                                                 |
| instance_info          | {}                                                              |
+------------------------+-----------------------------------------------------------------+

For more information on node enrollment, see the OpenStack documentation at http://docs.openstack.org/developer/ironic/deploy/install-guide.html#enrollment.

29.3.7 Creating a Flavor Edit source

nova uses flavors when fulfilling requests for bare-metal nodes. The nova scheduler attempts to match the requested flavor against the properties of the created ironic nodes. So an administrator needs to set up flavors that correspond to the available bare-metal nodes using the command openstack flavor create:

openstack flavor create bmtest auto 64000  99 2

+----------------+--------+--------+------+-----------+------+-------+-------------+-----------+
| ID             | Name   | Mem_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
+----------------+--------+--------+------+-----------+------+-------+-------------+-----------+
| 645de0...b1348 | bmtest | 64000  | 99   | 0         |      | 2     | 1.0         | True      |
+----------------+--------+--------+------+-----------+------+-------+-------------+-----------+

To see a list of all the available flavors, run openstack flavor list:

openstack flavor list

+-------------+--------------+--------+------+-----------+------+-------+--------+-----------+
| ID          | Name         | Mem_MB | Disk | Ephemeral | Swap | VCPUs |  RXTX  | Is_Public |
|             |              |        |      |           |      |       | Factor |           |
+-------------+--------------+--------+------+-----------+------+-------+--------+-----------+
| 1           | m1.tiny      | 512    | 1    | 0         |      | 1     | 1.0    | True      |
| 2           | m1.small     | 2048   | 20   | 0         |      | 1     | 1.0    | True      |
| 3           | m1.medium    | 4096   | 40   | 0         |      | 2     | 1.0    | True      |
| 4           | m1.large     | 8192   | 80   | 0         |      | 4     | 1.0    | True      |
| 5           | m1.xlarge    | 16384  | 160  | 0         |      | 8     | 1.0    | True      |
| 6           | m1.baremetal | 4096   | 80   | 0         |      | 2     | 1.0    | True      |
| 645d...1348 | bmtest       | 64000  | 99   | 0         |      | 2     | 1.0    | True      |
+-------------+--------------+--------+------+-----------+------+-------+--------+-----------+

Now set the CPU architecture and boot mode and boot option capabilities:

openstack flavor set 645de08d-2bc6-43f1-8a5f-2315a75b1348 set cpu_arch=x86_64
openstack flavor set 645de08d-2bc6-43f1-8a5f-2315a75b1348 set capabilities:boot_option="local"
openstack flavor set 645de08d-2bc6-43f1-8a5f-2315a75b1348 set capabilities:boot_mode="bios"

For more information on flavor creation, see the OpenStack documentation at http://docs.openstack.org/developer/ironic/deploy/install-guide.html#flavor-creation.

29.3.8 Creating a Network Port Edit source

Register the MAC addresses of all connected physical network interfaces intended for use with the bare-metal node.

ironic port-create -a 5c:b9:01:88:f0:a4 -n ea7246fd-e1d6-4637-9699-0b7c59c22e67

29.3.9 Creating a glance Image Edit source

You can create a complete disk image using the instructions at Section 29.3.13, “Building glance Images Using KIWI”.

The image you create can then be loaded into glance:

openstack image create --name='leap' --disk-format=raw \
  --container-format=bare \
  --file /tmp/myimage/LimeJeOS-Leap-42.3.x86_64-1.42.3.raw

+------------------+--------------------------------------+
| Property         | Value                                |
+------------------+--------------------------------------+
| checksum         | 45a4a06997e64f7120795c68beeb0e3c     |
| container_format | bare                                 |
| created_at       | 2018-02-17T10:42:14Z                 |
| disk_format      | raw                                  |
| id               | 17e4915a-ada0-4b95-bacf-ba67133f39a7 |
| min_disk         | 0                                    |
| min_ram          | 0                                    |
| name             | leap                                 |
| owner            | 821b7bb8148f439191d108764301af64     |
| protected        | False                                |
| size             | 372047872                            |
| status           | active                               |
| tags             | []                                   |
| updated_at       | 2018-02-17T10:42:23Z                 |
| virtual_size     | None                                 |
| visibility       | private                              |
+------------------+--------------------------------------+

This image will subsequently be used to boot the bare-metal node.

29.3.10 Generating a Key Pair Edit source

Create a key pair that you will use when you login to the newly booted node:

openstack keypair create ironic_kp > ironic_kp.pem

29.3.11 Determining the neutron Network ID Edit source

openstack network list

+---------------+----------+----------------------------------------------------+
| id            | name     | subnets                                            |
+---------------+----------+----------------------------------------------------+
| c0102...1ca8c | flat-net | 709ee2a1-4110-4b26-ba4d-deb74553adb9 192.3.15.0/24 |
+---------------+----------+----------------------------------------------------+

29.3.12 Booting the Node Edit source

Before booting, it is advisable to power down the node:

ironic node-set-power-state ea7246fd-e1d6-4637-9699-0b7c59c22e67 off

You can now boot the bare-metal node with the information compiled in the preceding steps, using the neutron network ID, the whole disk image ID, the matching flavor and the key name:

openstack server create --nic net-id=c010267c-9424-45be-8c05-99d68531ca8c \
  --image 17e4915a-ada0-4b95-bacf-ba67133f39a7 \
  --flavor 645de08d-2bc6-43f1-8a5f-2315a75b1348 \
  --key-name ironic_kp leap

This command returns information about the state of the node that is booting:

+--------------------------------------+------------------------+
| Property                             | Value                  |
+--------------------------------------+------------------------+
| OS-EXT-AZ:availability_zone          |                        |
| OS-EXT-SRV-ATTR:host                 | -                      |
| OS-EXT-SRV-ATTR:hypervisor_hostname  | -                      |
| OS-EXT-SRV-ATTR:instance_name        | instance-00000001      |
| OS-EXT-STS:power_state               | 0                      |
| OS-EXT-STS:task_state                | scheduling             |
| OS-EXT-STS:vm_state                  | building               |
| OS-SRV-USG:launched_at               | -                      |
| OS-SRV-USG:terminated_at             | -                      |
| accessIPv4                           |                        |
| accessIPv6                           |                        |
| adminPass                            | adpHw3KKTjHk           |
| config_drive                         |                        |
| created                              | 2018-03-11T11:00:28Z   |
| flavor                               | bmtest (645de...b1348) |
| hostId                               |                        |
| id                                   | a9012...3007e          |
| image                                | leap (17e49...f39a7)   |
| key_name                             | ironic_kp              |
| metadata                             | {}                     |
| name                                 | leap                   |
| os-extended-volumes:volumes_attached | []                     |
| progress                             | 0                      |
| security_groups                      | default                |
| status                               | BUILD                  |
| tenant_id                            | d53bcaf...baa60dd      |
| updated                              | 2016-03-11T11:00:28Z   |
| user_id                              | e580c64...4aaf990      |
+--------------------------------------+------------------------+

The boot process can take up to 10 minutes. Monitor the progress with the IPMI console or with openstack server list, openstack server show <nova_node_id>, and ironic node-show <ironic_node_id> commands.

openstack server list

+---------------+--------+--------+------------+-------------+----------------------+
| ID            | Name   | Status | Task State | Power State | Networks             |
+---------------+--------+--------+------------+-------------+----------------------+
| a9012...3007e | leap   | BUILD  | spawning   | NOSTATE     | flat-net=192.3.15.12 |
+---------------+--------+--------+------------+-------------+----------------------+

During the boot procedure, a login prompt will appear for SLES:

Ignore this login screen and wait for the login screen of your target operating system to appear:

If you now run the command openstack server list, it should show the node in the running state:

openstack server list
+---------------+--------+--------+------------+-------------+----------------------+
| ID            | Name   | Status | Task State | Power State | Networks             |
+---------------+--------+--------+------------+-------------+----------------------+
| a9012...3007e | leap   | ACTIVE | -          | Running     | flat-net=192.3.15.14 |
+---------------+--------+--------+------------+-------------+----------------------+

You can now log in to the booted node using the key you generated earlier. (You may be prompted to change the permissions of your private key files, so that they are not accessible by others).

ssh leap@192.3.15.14 -i ironic_kp.pem

29.3.13 Building glance Images Using KIWI Edit source

The following sections show you how to create your own images using KIWI, the command line utility to build Linux system appliances. For information on installing KIWI, see https://osinside.github.io/kiwi/installation.html.

KIWI creates images in a two-step process:

  1. The prepare operation generates an unpacked image tree using the information provided in the image description.

  2. The create operation creates the packed image based on the unpacked image and the information provided in the configuration file (config.xml).

Instructions for installing KIWI are available at https://osinside.github.io/kiwi/installation.html.

Image creation with KIWI is automated and does not require any user interaction. The information required for the image creation process is provided by the image description.

To use and run KIWI requires:

  • A recent Linux distribution such as:

    • openSUSE Leap 42.3

    • SUSE Linux Enterprise 12 SP4

    • openSUSE Tumbleweed

  • Enough free disk space to build and store the image (a minimum of 10 GB is recommended).

  • Python version 2.7, 3.4 or higher. KIWI supports both Python 2 and 3 versions

  • Git (package git-core) to clone a repository.

  • Virtualization technology to start the image (QEMU is recommended).

29.3.14 Creating an openSUSE Image with KIWI Edit source

The following example shows how to build an openSUSE Leap image that is ready to run in QEMU.

  1. Retrieve the example image descriptions.

    git clone https://github.com/SUSE/kiwi-descriptions
  2. Build the image with KIWI:

    sudo kiwi-ng --type vmx system build \
      --description kiwi-descriptions/suse/x86_64/suse-leap-42.3-JeOS \
      --target-dir /tmp/myimage

    A .raw image will be built in the /tmp/myimage directory.

  3. Test the live image with QEMU:

    qemu \
      -drive file=LimeJeOS-Leap-42.3.x86_64-1.42.3.raw,format=raw,if=virtio \
      -m 4096
  4. With a successful test, the image is complete.

By default, KIWI generates a file in the .raw format. The .raw file is a disk image with a structure equivalent to a physical hard disk. .raw images are supported by any hypervisor, but are not compressed and do not offer the best performance.

Virtualization systems support their own formats (such as qcow2 or vmdk) with compression and improved I/O performance. To build an image in a format other than .raw, add the format attribute to the type definition in the preferences section of config.xml. Using qcow2 for example:

<image ...>
  <preferences>
    <type format="qcow2" .../>
    ...
  </preferences>
  ...
</image

More information about KIWI is at https://osinside.github.io/kiwi/.

29.4 Provisioning Baremetal Nodes with Multi-Tenancy Edit source

To enable ironic multi-tenancy, you must first manually install the python-networking-generic-switch package along with all its dependents on all neutron nodes.

To manually enable the genericswitch mechanism driver in neutron, the networking-generic-switch package must be installed first. Do the following steps in each of the controllers where neutron is running.

  1. Comment out the multi_tenancy_switch_config section in ~/openstack/my_cloud/definition/data/ironic/ironic_config.yml.

  2. SSH into the controller node

  3. Change to root

    ardana > sudo -i
  4. Activate the neutron venv

    tux > sudo . /opt/stack/venv/neutron-20180528T093206Z/bin/activate
  5. Install netmiko package

    tux > sudo pip install netmiko
  6. Clone the networking-generic-switch source code into /tmp

    tux > sudo cd /tmp
    tux > sudo git clone
       https://github.com/openstack/networking-generic-switch.git
  7. Install networking_generic_switch package

    tux > sudo python setup.py install

After the networking_generic_switch package is installed, the genericswitch settings must be enabled in the input model. The following process must be run again any time a maintenance update is installed that updates the neutron venv.

  1. SSH into the deployer node as the user ardana.

  2. Edit the ironic configuration data in the input model ~/openstack/my_cloud/definition/data/ironic/ironic_config.yml. Make sure the multi_tenancy_switch_config: section is uncommented and has the appropriate settings. driver_type should be genericswitch and device_type should be netmiko_hp_comware.

    multi_tenancy_switch_config:
      -
        id: switch1
        driver_type: genericswitch
        device_type: netmiko_hp_comware
        ip_address: 192.168.75.201
        username: IRONICSHARE
        password: 'k27MwbEDGzTm'
  3. Run the configure process to generate the model

    ardana > cd ~/openstack/ardana/ansible
    ardana > ansible-playbook -i hosts/localhost config-processor-run.yml
    ardana > ansible-playbook -i hosts/localhost ready-deployment.yml
  4. Run neutron-reconfigure.yml

    ardana > cd ~/scratch/ansible/next/ardana/ansible
    ardana > ansible-playbook -i hosts/localhost neutron-reconfigure.yml
  5. Run neutron-status.yml to make sure everything is OK

    ardana > ansible-playbook -i hosts/verb_hosts neutron-status.yml

With the networking-generic-switch package installed and enabled, you can proceed with provisioning baremetal nodes with multi-tenancy.

  1. Create a network and a subnet:

    $ openstack network create guest-net-1
    Created a new network:
    +---------------------------+--------------------------------------+
    | Field                     | Value                                |
    +---------------------------+--------------------------------------+
    | admin_state_up            | True                                 |
    | availability_zone_hints   |                                      |
    | availability_zones        |                                      |
    | created_at                | 2017-06-10T02:49:56Z                 |
    | description               |                                      |
    | id                        | 256d55a6-9430-4f49-8a4c-cc5192f5321e |
    | ipv4_address_scope        |                                      |
    | ipv6_address_scope        |                                      |
    | mtu                       | 1500                                 |
    | name                      | guest-net-1                          |
    | project_id                | 57b792cdcdd74d16a08fc7a396ee05b6     |
    | provider:network_type     | vlan                                 |
    | provider:physical_network | physnet1                             |
    | provider:segmentation_id  | 1152                                 |
    | revision_number           | 2                                    |
    | router:external           | False                                |
    | shared                    | False                                |
    | status                    | ACTIVE                               |
    | subnets                   |                                      |
    | tags                      |                                      |
    | tenant_id                 | 57b792cdcdd74d16a08fc7a396ee05b6     |
    | updated_at                | 2017-06-10T02:49:57Z                 |
    +---------------------------+--------------------------------------+
    
    $ openstack subnet create guest-net-1 200.0.0.0/24
    Created a new subnet:
    +-------------------+----------------------------------------------+
    | Field             | Value                                        |
    +-------------------+----------------------------------------------+
    | allocation_pools  | {"start": "200.0.0.2", "end": "200.0.0.254"} |
    | cidr              | 200.0.0.0/24                                 |
    | created_at        | 2017-06-10T02:53:08Z                         |
    | description       |                                              |
    | dns_nameservers   |                                              |
    | enable_dhcp       | True                                         |
    | gateway_ip        | 200.0.0.1                                    |
    | host_routes       |                                              |
    | id                | 53accf35-ae02-43ae-95d8-7b5efed18ae9         |
    | ip_version        | 4                                            |
    | ipv6_address_mode |                                              |
    | ipv6_ra_mode      |                                              |
    | name              |                                              |
    | network_id        | 256d55a6-9430-4f49-8a4c-cc5192f5321e         |
    | project_id        | 57b792cdcdd74d16a08fc7a396ee05b6             |
    | revision_number   | 2                                            |
    | service_types     |                                              |
    | subnetpool_id     |                                              |
    | tenant_id         | 57b792cdcdd74d16a08fc7a396ee05b6             |
    | updated_at        | 2017-06-10T02:53:08Z                         |
    +-------------------+----------------------------------------------+
  2. Review glance image list

    $ openstack image list
    +--------------------------------------+--------------------------+
    | ID                                   | Name                     |
    +--------------------------------------+--------------------------+
    | 0526d2d7-c196-4c62-bfe5-a13bce5c7f39 | cirros-0.4.0-x86_64      |
    +--------------------------------------+--------------------------+
  3. Create ironic node

    $ ironic --ironic-api-version 1.22 node-create -d agent_ipmitool \
      -n test-node-1 -i ipmi_address=192.168.9.69 -i ipmi_username=ipmi_user \
      -i ipmi_password=XXXXXXXX --network-interface neutron -p  memory_mb=4096 \
      -p cpu_arch=x86_64 -p local_gb=80 -p cpus=2 \
      -p capabilities=boot_mode:bios,boot_option:local \
      -p root_device='{"name":"/dev/sda"}' \
      -i deploy_kernel=db3d131f-2fb0-4189-bb8d-424ee0886e4c \
      -i deploy_ramdisk=304cae15-3fe5-4f1c-8478-c65da5092a2c
    
    +-------------------+-------------------------------------------------------------------+
    | Property          | Value                                                             |
    +-------------------+-------------------------------------------------------------------+
    | chassis_uuid      |                                                                   |
    | driver            | agent_ipmitool                                                    |
    | driver_info       | {u'deploy_kernel': u'db3d131f-2fb0-4189-bb8d-424ee0886e4c',       |
    |                   | u'ipmi_address': u'192.168.9.69',                                 |
    |                   | u'ipmi_username': u'gozer', u'ipmi_password': u'******',          |
    |                   | u'deploy_ramdisk': u'304cae15-3fe5-4f1c-8478-c65da5092a2c'}       |
    | extra             | {}                                                                |
    | name              | test-node-1                                                       |
    | network_interface | neutron                                                           |
    | properties        | {u'cpu_arch': u'x86_64', u'root_device': {u'name': u'/dev/sda'},  |
    |                   | u'cpus': 2, u'capabilities': u'boot_mode:bios,boot_option:local', |
    |                   | u'memory_mb': 4096, u'local_gb': 80}                              |
    | resource_class    | None                                                              |
    | uuid              | cb4dda0d-f3b0-48b9-ac90-ba77b8c66162                              |
    +-------------------+-------------------------------------------------------------------+

    ipmi_address, ipmi_username and ipmi_password are IPMI access parameters for baremetal ironic node. Adjust memory_mb, cpus, local_gb to your node size requirements. They also need to be reflected in flavor setting (see below). Use capabilities boot_mode:bios for baremetal nodes operating in Legacy BIOS mode. For UEFI baremetal nodes, use boot_mode:uefi lookup deploy_kernel and deploy_ramdisk in glance image list output above.

    Important
    Important

    Since we are using ironic API version 1.22, node is created initial state enroll. It needs to be explicitly moved to available state. This behavior changed in API version 1.11

  4. Create port

    $ ironic --ironic-api-version 1.22 port-create --address f0:92:1c:05:6c:40 \
      --node cb4dda0d-f3b0-48b9-ac90-ba77b8c66162 -l switch_id=e8:f7:24:bf:07:2e -l \
      switch_info=hp59srv1-a-11b -l port_id="Ten-GigabitEthernet 1/0/34" \
      --pxe-enabled true
    +-----------------------+--------------------------------------------+
    | Property              | Value                                      |
    +-----------------------+--------------------------------------------+
    | address               | f0:92:1c:05:6c:40                          |
    | extra                 | {}                                         |
    | local_link_connection | {u'switch_info': u'hp59srv1-a-11b',        |
    |                       | u'port_id': u'Ten-GigabitEthernet 1/0/34', |
    |                       | u'switch_id': u'e8:f7:24:bf:07:2e'}        |
    | node_uuid             | cb4dda0d-f3b0-48b9-ac90-ba77b8c66162       |
    | pxe_enabled           | True                                       |
    | uuid                  | a49491f3-5595-413b-b4a7-bb6f9abec212       |
    +-----------------------+--------------------------------------------+
    • for --address, use MAC of 1st NIC of ironic baremetal node, which will be used for PXE boot

    • for --node, use ironic node uuid (see above)

    • for -l switch_id, use switch management interface MAC address. It can be retrieved by pinging switch management IP and looking up MAC address in 'arp -l -n' command output.

    • for -l switch_info, use switch_id from data/ironic/ironic_config.yml file. If you have several switch config definitions, use the right switch your baremetal node is connected to.

    • for -l port_id, use port ID on the switch

  5. Move ironic node to manage and then available state

    $ ironic node-set-provision-state test-node-1 manage
    $ ironic node-set-provision-state test-node-1 provide
  6. Once node is successfully moved to available state, its resources should be included into nova hypervisor statistics

    $ openstack hypervisor stats show
    +----------------------+-------+
    | Property             | Value |
    +----------------------+-------+
    | count                | 1     |
    | current_workload     | 0     |
    | disk_available_least | 80    |
    | free_disk_gb         | 80    |
    | free_ram_mb          | 4096  |
    | local_gb             | 80    |
    | local_gb_used        | 0     |
    | memory_mb            | 4096  |
    | memory_mb_used       | 0     |
    | running_vms          | 0     |
    | vcpus                | 2     |
    | vcpus_used           | 0     |
    +----------------------+-------+
  7. Prepare a keypair, which will be used for logging into the node

    $ openstack keypair create ironic_kp > ironic_kp.pem
  8. Obtain user image and upload it to glance. Please refer to OpenStack documentation on user image creation: https://docs.openstack.org/project-install-guide/baremetal/draft/configure-glance-images.html.

    Note
    Note

    Deployed images are already populated by SUSE OpenStack Cloud installer.

    $ openstack image create --name='Ubuntu Trusty 14.04' --disk-format=qcow2 \
      --container-format=bare --file ~/ubuntu-trusty.qcow2
    +------------------+--------------------------------------+
    | Property         | Value                                |
    +------------------+--------------------------------------+
    | checksum         | d586d8d2107f328665760fee4c81caf0     |
    | container_format | bare                                 |
    | created_at       | 2017-06-13T22:38:45Z                 |
    | disk_format      | qcow2                                |
    | id               | 9fdd54a3-ccf5-459c-a084-e50071d0aa39 |
    | min_disk         | 0                                    |
    | min_ram          | 0                                    |
    | name             | Ubuntu Trusty 14.04                  |
    | owner            | 57b792cdcdd74d16a08fc7a396ee05b6     |
    | protected        | False                                |
    | size             | 371508736                            |
    | status           | active                               |
    | tags             | []                                   |
    | updated_at       | 2017-06-13T22:38:55Z                 |
    | virtual_size     | None                                 |
    | visibility       | private                              |
    +------------------+--------------------------------------+
    
    $ openstack image list
    +--------------------------------------+---------------------------+
    | ID                                   | Name                      |
    +--------------------------------------+---------------------------+
    | 0526d2d7-c196-4c62-bfe5-a13bce5c7f39 | cirros-0.4.0-x86_64       |
    | 83eecf9c-d675-4bf9-a5d5-9cf1fe9ee9c2 | ir-deploy-iso-EXAMPLE     |
    | db3d131f-2fb0-4189-bb8d-424ee0886e4c | ir-deploy-kernel-EXAMPLE  |
    | 304cae15-3fe5-4f1c-8478-c65da5092a2c | ir-deploy-ramdisk- EXAMPLE |
    | 9fdd54a3-ccf5-459c-a084-e50071d0aa39 | Ubuntu Trusty 14.04       |
    +--------------------------------------+---------------------------+
  9. Create a baremetal flavor and set flavor keys specifying requested node size, architecture and boot mode. A flavor can be re-used for several nodes having the same size, architecture and boot mode

    $ openstack flavor create m1.ironic auto 4096 80 2
    +-------------+-----------+--------+------+---------+------+-------+-------------+-----------+
    | ID          | Name      | Mem_MB | Disk | Ephemrl | Swap | VCPUs | RXTX_Factor | Is_Public |
    +-------------+-----------+--------+------+---------+------+-------+-------------+-----------+
    | ab69...87bf | m1.ironic | 4096   | 80   | 0       |      | 2     | 1.0         | True      |
    +-------------+-----------+--------+------+---------+------+-------+-------------+-----------+
    
    $ openstack flavor set ab6988...e28694c87bf set cpu_arch=x86_64
    $ openstack flavor set ab6988...e28694c87bf set capabilities:boot_option="local"
    $ openstack flavor set ab6988...e28694c87bf set capabilities:boot_mode="bios"

    Parameters must match parameters of ironic node above. Use capabilities:boot_mode="bios" for Legacy BIOS nodes. For UEFI nodes, use capabilities:boot_mode="uefi"

  10. Boot the node

    $ openstack server create --flavor m1.ironic --image 9fdd54a3-ccf5-459c-a084-e50071d0aa39 \
      --key-name ironic_kp --nic net-id=256d55a6-9430-4f49-8a4c-cc5192f5321e \
      test-node-1
    +--------------------------------------+-------------------------------------------------+
    | Property                             | Value                                           |
    +--------------------------------------+-------------------------------------------------+
    | OS-DCF:diskConfig                    | MANUAL                                          |
    | OS-EXT-AZ:availability_zone          |                                                 |
    | OS-EXT-SRV-ATTR:host                 | -                                               |
    | OS-EXT-SRV-ATTR:hypervisor_hostname  | -                                               |
    | OS-EXT-SRV-ATTR:instance_name        |                                                 |
    | OS-EXT-STS:power_state               | 0                                               |
    | OS-EXT-STS:task_state                | scheduling                                      |
    | OS-EXT-STS:vm_state                  | building                                        |
    | OS-SRV-USG:launched_at               | -                                               |
    | OS-SRV-USG:terminated_at             | -                                               |
    | accessIPv4                           |                                                 |
    | accessIPv6                           |                                                 |
    | adminPass                            | XXXXXXXXXXXX                                    |
    | config_drive                         |                                                 |
    | created                              | 2017-06-14T21:25:18Z                            |
    | flavor                               | m1.ironic (ab69881...5a-497d-93ae-6e28694c87bf) |
    | hostId                               |                                                 |
    | id                                   | f1a8c63e-da7b-4d9a-8648-b1baa6929682            |
    | image                                | Ubuntu Trusty 14.04 (9fdd54a3-ccf5-4a0...0aa39) |
    | key_name                             | ironic_kp                                       |
    | metadata                             | {}                                              |
    | name                                 | test-node-1                                     |
    | os-extended-volumes:volumes_attached | []                                              |
    | progress                             | 0                                               |
    | security_groups                      | default                                         |
    | status                               | BUILD                                           |
    | tenant_id                            | 57b792cdcdd74d16a08fc7a396ee05b6                |
    | updated                              | 2017-06-14T21:25:17Z                            |
    | user_id                              | cc76d7469658401fbd4cf772278483d9                |
    +--------------------------------------+-------------------------------------------------+
    • for --image, use the ID of user image created at previous step

    • for --nic net-id, use ID of the tenant network created at the beginning

    Note
    Note

    During the node provisioning, the following is happening in the background:

    neutron connects to switch management interfaces and assigns provisioning VLAN to baremetal node port on the switch. ironic powers up the node using IPMI interface. Node is booting IPA image via PXE. IPA image is writing provided user image onto specified root device (/dev/sda) and powers node down. neutron connects to switch management interfaces and assigns tenant VLAN to baremetal node port on the switch. A VLAN ID is selected from provided range. ironic powers up the node using IPMI interface. Node is booting user image from disk.

  11. Once provisioned, node will join the private tenant network. Access to private network from other networks is defined by switch configuration.

29.5 View Ironic System Details Edit source

29.5.1 View details about the server using openstack server show <nova-node-id> Edit source

openstack server show a90122ce-bba8-496f-92a0-8a7cb143007e

+--------------------------------------+-----------------------------------------------+
| Property                             | Value                                         |
+--------------------------------------+-----------------------------------------------+
| OS-EXT-AZ:availability_zone          | nova                                          |
| OS-EXT-SRV-ATTR:host                 | ardana-cp1-ir-compute0001-mgmt                |
| OS-EXT-SRV-ATTR:hypervisor_hostname  | ea7246fd-e1d6-4637-9699-0b7c59c22e67          |
| OS-EXT-SRV-ATTR:instance_name        | instance-0000000a                             |
| OS-EXT-STS:power_state               | 1                                             |
| OS-EXT-STS:task_state                | -                                             |
| OS-EXT-STS:vm_state                  | active                                        |
| OS-SRV-USG:launched_at               | 2016-03-11T12:26:25.000000                    |
| OS-SRV-USG:terminated_at             | -                                             |
| accessIPv4                           |                                               |
| accessIPv6                           |                                               |
| config_drive                         |                                               |
| created                              | 2016-03-11T12:17:54Z                          |
| flat-net network                     | 192.3.15.14                                   |
| flavor                               | bmtest (645de08d-2bc6-43f1-8a5f-2315a75b1348) |
| hostId                               | ecafa4f40eb5f72f7298...3bad47cbc01aa0a076114f |
| id                                   | a90122ce-bba8-496f-92a0-8a7cb143007e          |
| image                                | ubuntu (17e4915a-ada0-4b95-bacf-ba67133f39a7) |
| key_name                             | ironic_kp                                     |
| metadata                             | {}                                            |
| name                                 | ubuntu                                        |
| os-extended-volumes:volumes_attached | []                                            |
| progress                             | 0                                             |
| security_groups                      | default                                       |
| status                               | ACTIVE                                        |
| tenant_id                            | d53bcaf15afb4cb5aea3adaedbaa60dd              |
| updated                              | 2016-03-11T12:26:26Z                          |
| user_id                              | e580c645bfec4faeadef7dbd24aaf990              |
+--------------------------------------+-----------------------------------------------+

29.5.2 View detailed information about a node using ironic node-show <ironic-node-id> Edit source

ironic node-show  ea7246fd-e1d6-4637-9699-0b7c59c22e67

+------------------------+--------------------------------------------------------------------------+
| Property               | Value                                                                    |
+------------------------+--------------------------------------------------------------------------+
| target_power_state     | None                                                                     |
| extra                  | {}                                                                       |
| last_error             | None                                                                     |
| updated_at             | 2016-03-11T12:26:25+00:00                                                |
| maintenance_reason     | None                                                                     |
| provision_state        | active                                                                   |
| clean_step             | {}                                                                       |
| uuid                   | ea7246fd-e1d6-4637-9699-0b7c59c22e67                                     |
| console_enabled        | False                                                                    |
| target_provision_state | None                                                                     |
| provision_updated_at   | 2016-03-11T12:26:25+00:00                                                |
| maintenance            | False                                                                    |
| inspection_started_at  | None                                                                     |
| inspection_finished_at | None                                                                     |
| power_state            | power on                                                                 |
| driver                 | agent_ilo                                                                |
| reservation            | None                                                                     |
| properties             | {u'memory_mb': 64000, u'cpu_arch': u'x86_64', u'local_gb': 99,           |
|                        | u'cpus': 2, u'capabilities': u'boot_mode:bios,boot_option:local'}        |
| instance_uuid          | a90122ce-bba8-496f-92a0-8a7cb143007e                                     |
| name                   | None                                                                     |
| driver_info            | {u'ilo_address': u'10.1.196.117', u'ilo_password': u'******',            |
|                        | u'ilo_deploy_iso': u'b9499494-7db3-4448-b67f-233b86489c1f',              |
|                        | u'ilo_username': u'Administrator'}                                       |
| created_at             | 2016-03-11T10:17:10+00:00                                                |
| driver_internal_info   | {u'agent_url': u'http://192.3.15.14:9999',                               |
|                        | u'is_whole_disk_image': True, u'agent_last_heartbeat': 1457699159}       |
| chassis_uuid           |                                                                          |
| instance_info          | {u'root_gb': u'99', u'display_name': u'ubuntu', u'image_source': u       |
|                        | '17e4915a-ada0-4b95-bacf-ba67133f39a7', u'capabilities': u'{"boot_mode": |
|                        | "bios", "boot_option": "local"}', u'memory_mb': u'64000', u'vcpus':      |
|                        | u'2', u'image_url': u'http://192.168.12.2:8080/v1/AUTH_ba121db7732f4ac3a |
|                        | 50cc4999a10d58d/glance/17e4915a-ada0-4b95-bacf-ba67133f39a7?temp_url_sig |
|                        | =ada691726337805981ac002c0fbfc905eb9783ea&temp_url_expires=1457699878',  |
|                        | u'image_container_format': u'bare', u'local_gb': u'99',                  |
|                        | u'image_disk_format': u'qcow2', u'image_checksum':                       |
|                        | u'2d7bb1e78b26f32c50bd9da99102150b', u'swap_mb': u'0'}                   |
+------------------------+--------------------------------------------------------------------------+

29.5.3 View detailed information about a port using ironic port-show <ironic-port-id> Edit source

ironic port-show a17a4ef8-a711-40e2-aa27-2189c43f0b67

+------------+-----------------------------------------------------------+
| Property   | Value                                                     |
+------------+-----------------------------------------------------------+
| node_uuid  | ea7246fd-e1d6-4637-9699-0b7c59c22e67                      |
| uuid       | a17a4ef8-a711-40e2-aa27-2189c43f0b67                      |
| extra      | {u'vif_port_id': u'82a5ab28-76a8-4c9d-bfb4-624aeb9721ea'} |
| created_at | 2016-03-11T10:40:53+00:00                                 |
| updated_at | 2016-03-11T12:17:56+00:00                                 |
| address    | 5c:b9:01:88:f0:a4                                         |
+------------+-----------------------------------------------------------+

29.5.4 View detailed information about a hypervisor using openstack hypervisor list and openstack hypervisor show Edit source

openstack hypervisor list

+-----+--------------------------------------+-------+---------+
| ID  | Hypervisor hostname                  | State | Status  |
+-----+--------------------------------------+-------+---------+
| 541 | ea7246fd-e1d6-4637-9699-0b7c59c22e67 | up    | enabled |
+-----+--------------------------------------+-------+---------+
openstack hypervisor show ea7246fd-e1d6-4637-9699-0b7c59c22e67

+-------------------------+--------------------------------------+
| Property                | Value                                |
+-------------------------+--------------------------------------+
| cpu_info                |                                      |
| current_workload        | 0                                    |
| disk_available_least    | 0                                    |
| free_disk_gb            | 0                                    |
| free_ram_mb             | 0                                    |
| host_ip                 | 192.168.12.6                         |
| hypervisor_hostname     | ea7246fd-e1d6-4637-9699-0b7c59c22e67 |
| hypervisor_type         | ironic                               |
| hypervisor_version      | 1                                    |
| id                      | 541                                  |
| local_gb                | 99                                   |
| local_gb_used           | 99                                   |
| memory_mb               | 64000                                |
| memory_mb_used          | 64000                                |
| running_vms             | 1                                    |
| service_disabled_reason | None                                 |
| service_host            | ardana-cp1-ir-compute0001-mgmt       |
| service_id              | 25                                   |
| state                   | up                                   |
| status                  | enabled                              |
| vcpus                   | 2                                    |
| vcpus_used              | 2                                    |
+-------------------------+--------------------------------------+

29.5.5 View a list of all running services using openstack compute service list Edit source

openstack compute service list

+----+------------------+-----------------------+----------+---------+-------+------------+----------+
| Id | Binary           | Host                  | Zone     | Status  | State | Updated_at | Disabled |
|    |                  |                       |          |         |       |            | Reason   |
+----+------------------+-----------------------+----------+---------+-------+------------+----------+
| 1  | nova-conductor   | ardana-cp1-c1-m1-mgmt | internal | enabled | up    | date:time  | -        |
| 7  | nova-conductor   |  " -cp1-c1-m2-mgmt    | internal | enabled | up    | date:time  | -        |
| 10 | nova-conductor   |  " -cp1-c1-m3-mgmt    | internal | enabled | up    | date:time  | -        |
| 13 | nova-scheduler   |  " -cp1-c1-m1-mgmt    | internal | enabled | up    | date:time  | -        |
| 16 | nova-scheduler   |  " -cp1-c1-m3-mgmt    | internal | enabled | up    | date:time  | -        |
| 19 | nova-scheduler   |  " -cp1-c1-m2-mgmt    | internal | enabled | up    | date:time  | -        |
| 25 | nova-compute     |  " -cp1-ir- | nova    |          | enabled | up    | date:time  | -        |
|    |                  |      compute0001-mgmt |          |         |       |            |          |
+----+------------------+-----------------------+----------+---------+-------+------------+----------+

29.6 Troubleshooting ironic Installation Edit source

Sometimes the openstack server create command does not succeed and when you do a openstack server list, you will see output like the following:

ardana > openstack server list

+------------------+--------------+--------+------------+-------------+----------+
| ID               | Name         | Status | Task State | Power State | Networks |
+------------------+--------------+--------+------------+-------------+----------+
| ee08f82...624e5f | OpenSUSE42.3 | ERROR  | -          | NOSTATE     |          |
+------------------+--------------+--------+------------+-------------+----------+

You should execute the openstack server show <nova-node-id> and ironic node-show <ironic-node-id> commands to get more information about the error.

29.6.1 Error: No valid host was found. Edit source

The error No valid host was found. There are not enough hosts. is typically seen when performing the openstack server create where there is a mismatch between the properties set on the node and the flavor used. For example, the output from a openstack server show command may look like this:

ardana > openstack server show ee08f82e-8920-4360-be51-a3f995624e5f

+------------------------+------------------------------------------------------------------------------+
| Property               | Value                                                                        |
+------------------------+------------------------------------------------------------------------------+
| OS-EXT-AZ:             |                                                                              |
|   availability_zone    |                                                                              |
| OS-EXT-SRV-ATTR:host   | -                                                                            |
| OS-EXT-SRV-ATTR:       |                                                                              |
|   hypervisor_hostname  | -                                                                            |
| OS-EXT-SRV-ATTR:       |                                                                              |
|   instance_name        | instance-00000001                                                            |
| OS-EXT-STS:power_state | 0                                                                            |
| OS-EXT-STS:task_state  | -                                                                            |
| OS-EXT-STS:vm_state    | error                                                                        |
| OS-SRV-USG:launched_at | -                                                                            |
| OS-SRV-USG:            |                                                                              |
|    terminated_at       | -                                                                            |
| accessIPv4             |                                                                              |
| accessIPv6             |                                                                              |
| config_drive           |                                                                              |
| created                | 2016-03-11T11:00:28Z                                                         |
| fault                  | {"message": "No valid host was found. There are not enough hosts             |
|                        |  available.", "code": 500, "details": "  File \"/opt/stack/                  |
|                        |  venv/nova-20160308T002421Z/lib/python2.7/site-packages/nova/                |
|                        |  conductor/manager.py\", line 739, in build_instances                        |
|                        |     request_spec, filter_properties)                                         |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/nova/scheduler/utils.py\", line 343, in wrapped              |
|                        |     return func(*args, **kwargs)                                             |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/nova/scheduler/client/__init__.py\", line 52,                |
|                        |     in select_destinations context, request_spec, filter_properties)         |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/nova/scheduler/client/__init__.py\",line 37,in __run_method  |
|                        |     return getattr(self.instance, __name)(*args, **kwargs)                   |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/nova/scheduler/client/query.py\", line 34,                   |
|                        |     in select_destinations context, request_spec, filter_properties)         |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/nova/scheduler/rpcapi.py\", line 120, in select_destinations |
|                        |     request_spec=request_spec, filter_properties=filter_properties)          |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/oslo_messaging/rpc/client.py\", line 158, in call            |
|                        |     retry=self.retry)                                                        |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/oslo_messaging/transport.py\", line 90, in _send             |
|                        |     timeout=timeout, retry=retry)                                            |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/oslo_messaging/_drivers/amqpdriver.py\", line 462, in send   |
|                        |     retry=retry)                                                             |
|                        |   File \"/opt/stack/venv/nova-20160308T002421Z/lib/python2.7/                |
|                        |   site-packages/oslo_messaging/_drivers/amqpdriver.py\", line 453, in _send  |
|                        |     raise result                                                             |
|                        | ", "created": "2016-03-11T11:00:29Z"}                                        |
| flavor                 | bmtest (645de08d-2bc6-43f1-8a5f-2315a75b1348)                                |
| hostId                 |                                                                              |
| id                     | ee08f82e-8920-4360-be51-a3f995624e5f                                         |
| image                  | opensuse (17e4915a-ada0-4b95-bacf-ba67133f39a7)                              |
| key_name               | ironic_kp                                                                    |
| metadata               | {}                                                                           |
| name                   | opensuse                                                                     |
| os-extended-volumes:   |                                                                              |
|    volumes_attached    | []                                                                           |
| status                 | ERROR                                                                        |
| tenant_id              | d53bcaf15afb4cb5aea3adaedbaa60dd                                             |
| updated                | 2016-03-11T11:00:28Z                                                         |
| user_id                | e580c645bfec4faeadef7dbd24aaf990                                             |
+------------------------+------------------------------------------------------------------------------+

You can find more information about the error by inspecting the log file at /var/log/nova/nova-scheduler.log or alternatively by viewing the error location in the source files listed in the stack-trace (in bold above).

To find the mismatch, compare the properties of the ironic node:

+------------------------+---------------------------------------------------------------------+
| Property               | Value                                                               |
+------------------------+---------------------------------------------------------------------+
| target_power_state     | None                                                                |
| extra                  | {}                                                                  |
| last_error             | None                                                                |
| updated_at             | None                                                                |
| maintenance_reason     | None                                                                |
| provision_state        | available                                                           |
| clean_step             | {}                                                                  |
| uuid                   | ea7246fd-e1d6-4637-9699-0b7c59c22e67                                |
| console_enabled        | False                                                               |
| target_provision_state | None                                                                |
| provision_updated_at   | None                                                                |
| maintenance            | False                                                               |
| inspection_started_at  | None                                                                |
| inspection_finished_at | None                                                                |
| power_state            | None                                                                |
| driver                 | agent_ilo                                                           |
| reservation            | None                                                                |
| properties             | {u'memory_mb': 64000, u'local_gb': 99, u'cpus': 2, u'capabilities': |
|                        | u'boot_mode:bios,boot_option:local'}                                |
| instance_uuid          | None                                                                |
| name                   | None                                                                |
| driver_info            | {u'ilo_address': u'10.1.196.117', u'ilo_password': u'******',       |
|                        | u'ilo_deploy_iso': u'b9499494-7db3-4448-b67f-233b86489c1f',         |
|                        | u'ilo_username': u'Administrator'}                                  |
| created_at             | 2016-03-11T10:17:10+00:00                                           |
| driver_internal_info   | {}                                                                  |
| chassis_uuid           |                                                                     |
| instance_info          | {}                                                                  |
+------------------------+---------------------------------------------------------------------+

with the flavor characteristics:

ardana > openstack flavor show

+----------------------------+-------------------------------------------------------------------+
| Property                   | Value                                                             |
+----------------------------+-------------------------------------------------------------------+
| OS-FLV-DISABLED:disabled   | False                                                             |
| OS-FLV-EXT-DATA:ephemeral  | 0                                                                 |
| disk                       | 99                                                                |
| extra_specs                | {"capabilities:boot_option": "local", "cpu_arch": "x86_64",       |
|                            | "capabilities:boot_mode": "bios"}                                 |
| id                         | 645de08d-2bc6-43f1-8a5f-2315a75b1348                              |
| name                       | bmtest                                                            |
| os-flavor-access:is_public | True                                                              |
| ram                        | 64000                                                             |
| rxtx_factor                | 1.0                                                               |
| swap                       |                                                                   |
| vcpus                      | 2                                                                 |
+----------------------------+-------------------------------------------------------------------+

In this instance, the problem is caused by the absence of the "cpu_arch": "x86_64" property on the ironic node. This can be resolved by updating the ironic node, adding the missing property:

ardana > ironic node-update ea7246fd-e1d6-4637-9699-0b7c59c22e67 \
  add properties/cpu_arch=x86_64

and then re-running the openstack server create command.

29.6.2 Node fails to deploy because it has timed out Edit source

Possible cause: The neutron API session timed out before port creation was completed.

Resolution: Switch response time varies by vendor; the value of url_timeout must be increased to allow for switch response.

Check ironic Conductor logs (/var/log/ironic/ironic-conductor.log) for ConnectTimeout errors while connecting to neutron for port creation. For example:

19-03-20 19:09:14.557 11556 ERROR ironic.conductor.utils
[req-77f3a7b...1b10c5b - default default] Unexpected error while preparing
to deploy to node 557316...84dbdfbe8b0: ConnectTimeout: Request to
https://192.168.75.1:9696/v2.0/ports timed out

Use the following steps to increase the value of url_timeout.

  1. Log in to the deployer node.

  2. Edit ./roles/ironic-common/defaults/main.yml, increasing the value of url_timeout.

    ardana > cd /var/lib/ardana/scratch/ansible/next/ardana/ansible
    ardana > vi ./roles/ironic-common/defaults/main.yml

    Increase the value of the url_timeout parameter in the ironic_neutron: section. Increase the parameter from the default (60 seconds) to 120 and then in increments of 60 seconds until the node deploys successfully.

  3. Reconfigure ironic.

    ardana > ansible-playbook -i hosts/verb_hosts ironic-reconfigure.yml

29.6.3 Deployment to a node fails and in "ironic node-list" command, the power_state column for the node is shown as "None" Edit source

Possible cause: The IPMI commands to the node take longer to change the power state of the server.

Resolution: Check if the node power state can be changed using the following command

ardana > ironic node-set-power-state $NODEUUID on

If the above command succeeds and the power_state column is updated correctly, then the following steps are required to increase the power sync interval time.

On the first controller, reconfigure ironic to increase the power sync interval time. In the example below, it is set to 120 seconds. This value may have to be tuned based on the setup.

  1. Go to the ~/openstack/my_cloud/config/ironic/ directory and edit ironic-conductor.conf.j2 to set the sync_power_state_interval value:

    [conductor]
    sync_power_state_interval = 120
  2. Save the file and then run the following playbooks:

    ardana > cd ~/openstack/ardana/ansible
    ardana > ansible-playbook -i hosts/localhost config-processor-run.yml
    ardana > ansible-playbook -i hosts/localhost ready-deployment.yml
    ardana > cd ~/scratch/ansible/next/ardana/ansible
    ardana > ansible-playbook -i hosts/verb_hosts ironic-reconfigure.yml

29.6.4 Error Downloading Image Edit source

If you encounter the error below during the deployment:

"u'message': u'Error downloading image: Download of image id 77700...96551 failed:
Image download failed for all URLs.',
u'code': 500,
u'type': u'ImageDownloadError',
u'details': u'Download of image id 77700b53-9e15-406c-b2d5-13e7d9b96551 failed:
Image download failed for all URLs.'"

you should visit the Single Sign-On Settings in the Security page of IPMI and change the Single Sign-On Trust Mode setting from the default of "Trust None (SSO disabled)" to "Trust by Certificate".

29.6.5 Using node-inspection can cause temporary claim of IP addresses Edit source

Possible cause: Running node-inspection on a node discovers all the NIC ports including the NICs that do not have any connectivity. This causes a temporary consumption of the network IPs and increased usage of the allocated quota. As a result, other nodes are deprived of IP addresses and deployments can fail.

Resolution:You can add node properties manually added instead of using the inspection tool.

Note: Upgrade ipmitool to a version >= 1.8.15 or it may not return detailed information about the NIC interface for node-inspection.

29.6.6 Node permanently stuck in deploying state Edit source

Possible causes:

  • ironic conductor service associated with the node could go down.

  • There might be a properties mismatch. MAC address registered for the node could be incorrect.

Resolution: To recover from this condition, set the provision state of the node to Error and maintenance to True. Delete the node and re-register again.

29.6.7 The NICs in the baremetal node should come first in boot order Edit source

Possible causes: By default, the boot order of baremetal node is set as NIC1, HDD and NIC2. If NIC1 fails, the nodes starts booting from HDD and the provisioning fails.

Resolution: Set boot order so that all the NICs appear before the hard disk of the baremetal as NIC1, NIC2…, HDD.

29.6.8 Increase in the number of nodes can cause power commands to fail Edit source

Possible causes:ironic periodically performs a power state sync with all the baremetal nodes. When the number of nodes increase, ironic does not get sufficient time to perform power operations.

Resolution: The following procedure gives a way to increase sync_power_state_interval:

  1. Edit the file ~/openstack/my_cloud/config/ironic/ironic-conductor.conf.j2 and navigate to the section for [conductor]

  2. Increase the sync_power_state_interval. For example, for 100 nodes, set sync_power_state_interval = 90 and save the file.

  3. Execute the following set of commands to reconfigure ironic:

    ardana > cd ~/openstack/ardana/ansible
    ardana > ansible-playbook -i hosts/localhost config-processor-run.yml
    ardana > ansible-playbook -i hosts/localhost ready-deployment.yml
    ardana > cd ~/scratch/ansible/next/ardana/ansible
    ardana > ansible-playbook -i hosts/verb_hosts ironic-reconfigure.yml

29.6.9 DHCP succeeds with PXE but times out with iPXE Edit source

If you see DHCP error "No configuration methods succeeded" in iPXE right after successful DHCP performed by embedded NIC firmware, there may be an issue with Spanning Tree Protocol on the switch.

To avoid this error, Rapid Spanning Tree Protocol needs to be enabled on the switch. If this is not an option due to conservative loop detection strategies, use the steps outlined below to install the iPXE binary with increased DHCP timeouts.

  1. Clone iPXE source code

    tux > git clone git://git.ipxe.org/ipxe.git
    tux > cd ipxe/src
  2. Modify lines 22-25 in file config/dhcp.h, which declare reduced DHCP timeouts (1-10 secs). Comment out lines with reduced timeouts and uncomment normal PXE timeouts (4-32)

    //#define DHCP_DISC_START_TIMEOUT_SEC     1
    //#define DHCP_DISC_END_TIMEOUT_SEC       10
    #define DHCP_DISC_START_TIMEOUT_SEC   4       /* as per PXE spec */
    #define DHCP_DISC_END_TIMEOUT_SEC     32      /* as per PXE spec */
  3. Make undionly.kpxe (BIOS) and ipxe.efi (UEFI) images

    tux > make bin/undionly.kpxe
    tux > make bin-x86_64-efi/ipxe.efi
  4. Copy iPXE images to Cloud Lifecycle Manager

    tux > scp bin/undionly.kpxe bin-x86_64-efi/ipxe.efi stack@10.0.0.4:
    stack@10.0.0.4's password:
    undionly.kpxe                                    100%   66KB  65.6KB/s   00:00
    ipxe.efi                                         100%  918KB 918.2KB/s   00:00
  5. From deployer, distribute image files onto all 3 controllers

    stack@ardana-cp1-c1-m1-mgmt:ardana > cd ~/scratch/ansible/next/ardana/ansible/
    
    stack@ardana-cp1-c1-m1-mgmt:ardana > ~/scratch/ansible/next/ardana/ansible$ ansible -i hosts/verb_hosts \
    IRN-CND -m copy -b -a 'src=~/ipxe.efi dest=/tftpboot'
    ...
    stack@ardana-cp1-c1-m1-mgmt:ardana > ~/scratch/ansible/next/ardana/ansible$ ansible -i hosts/verb_hosts \
    IRN-CND -m copy -b -a 'src=~/undionly.kpxe dest=/tftpboot'
    ...

There is no need to restart services. With next PXE boot attempt, iPXE binary with the increased timeout will be downloaded to the target node via TFTP.

29.6.9.1 ironic Support and Limitations Edit source

The following drivers are supported and tested:

  • pxe_ipmitool (UEFI and Legacy BIOS mode, flat-network)

  • pxe_ipmitool (UEFI and Legacy BIOS mode, flat-network)

  • pxe_ilo (UEFI and Legacy BIOS mode, flat-network)

  • agent_ipmitool (UEFI and Legacy BIOS mode, flat-network)

  • agent_ilo (UEFI and Legacy BIOS mode, flat-network)

ISO Image Exceeds Free Space

When using the agent_ilo driver, provisioning will fail if the size of the user ISO image exceeds the free space available on the ramdisk partition. This will produce an error in the ironic Conductor logs that may look like as follows:

"ERROR root [-] Command failed: prepare_image, error: Error downloading
image: Download of image id 0c4d74e4-58f1-4f8d-8c1d-8a49129a2163 failed: Unable
to write image to /tmp/0c4d74e4-58f1-4f8d-8c1d-8a49129a2163. Error: [Errno 28]
No space left on device: ImageDownloadError: Error downloading image: Download
of image id 0c4d74e4-58f1-4f8d-8c1d-8a49129a2163 failed: Unable to write image
to /tmp/0c4d74e4-58f1-4f8d-8c1d-8a49129a2163. Error: [Errno 28] No space left
on device"

By default, the total amount of space allocated to ramdisk is 4GB. To increase the space allocated for the ramdisk, you can update the deploy ISO image using the following workaround.

  1. Save the deploy ISO to a file:

    tux > openstack image save --file deploy.isoIMAGE_ID

    Replace IMAGE_ID with the ID of the deploy ISO stored in glance. The ID can be obtained using the openstack image list.

  2. Mount the saved ISO:

    tux > mkdir /tmp/mnt
    tux > sudo mount -t iso9660 -o loop deploy.iso /tmp/mnt

    Since the mount directory is read-only, it is necessary to copy its content to be able to make modifications.

  3. Copy the content of the mount directory to a custom directory:

    tux > mkdir /tmp/custom
    tux > cp -aRvf /tmp/mnt/* /tmp/custom/
  4. Modify the bootloader files to increase the size of the ramdisk:

    /tmp/custom/boot/x86_64/loader/isolinux.cfg
    /tmp/custom/EFI/BOOT/grub.cfg
    /tmp/custom/boot/grub2/grub.cfg

    Find the openstack-ironic-image label and modify the ramdisk_size parameter in the append property. The ramdisk_size value must be specified in Kilobytes.

    label openstack-ironic-image
      kernel linux
      append initrd=initrd ramdisk_size=10485760 ramdisk_blocksize=4096 \
    boot_method=vmedia showopts

    Make sure that your baremetal node has the amount of RAM that equals or exceeds the ramdisk_size value.

  5. Repackage the ISO using the genisoimage tool:

    tux > cd /tmp/custom
    tux > genisoimage -b boot/x86_64/loader/isolinux.bin -R -J -pad -joliet-long \
    -iso-level 4 -A '0xaa2dab53' -no-emul-boot -boot-info-table \
    -boot-load-size 4 -c boot/x86_64/boot.catalog -hide boot/x86_64/boot.catalog \
    -hide-joliet boot/x86_64/boot.catalog -eltorito-alt-boot -b boot/x86_64/efi \
    -no-emul-boot -joliet-long -hide glump -hide-joliet glump -o /tmp/custom_deploy.iso ./
    Important
    Important

    When repackaging the ISO, make sure that you use the same label. You can find the label file in the /tmp/custom/boot/ directory. The label begins with 0x. For example, 0x51e568cb.

  6. Delete the existing deploy ISO in glance:

    tux > openstack image delete IMAGE_ID
  7. Create a new image with custom_deploy.iso:

    tux > openstack image create --container-format bare \
    --disk-format iso --public --file custom_deploy.iso ir-deploy-iso-ARDANA5.0
  8. Re-deploy the ironic node.

Partition Image Exceeds Free Space

The previous procedure applies to ISO images. It does not apply to partition images, although there will be a similar error in the ironic logs. However the resolution is different. An option must be added to the PXE line in the main.yml file to increase the /tmp disk size with the following workaround:

  1. Edit /openstack/ardana/ansible/roles/ironic-common/defaults/main.yml.

  2. Add suse.tmpsize=4G to pxe_append_params. Adjust the size of suse.tmpsize as needed for the partition image.

    pxe_append_params : "nofb nomodeset vga=normal elevator=deadline
                         security=apparmor crashkernel=256M console=tty0
                         console=ttyS0 suse.tmpsize=4G"
  3. Update Git and run playbooks:

    ardana > git add -A
    ardana > git commit -m "Add suse.tmpsize variable"
    ardana > ansible-playbook -i hosts/localhost config-processor-run.yml
    ardana > ansible-playbook -i hosts/localhost ready-deployment.yml
    ardana > cd /var/lib/ardana/scratch/ansible/next/ardana/ansible
    ardana > ansible-playbook -i hosts/verb_hosts ironic-reconfigure.yml
  4. Re-deploy the ironic node.

29.7 Node Cleaning Edit source

Cleaning is the process by which data is removed after a previous tenant has used the node. Cleaning requires use of ironic's agent_ drivers. It is extremely important to note that if the pxe_ drivers are utilized, no node cleaning operations will occur, and a previous tenant's data could be found on the node. The same risk of a previous tenant's data possibly can occur if cleaning is explicitly disabled as part of the installation.

By default, cleaning attempts to utilize ATA secure erase to wipe the contents of the disk. If secure erase is unavailable, the cleaning functionality built into the ironic Python Agent falls back to an operation referred to as "shred" where random data is written over the contents of the disk, and then followed up by writing "0"s across the disk. This can be a time-consuming process.

An additional feature of cleaning is the ability to update firmware or potentially assert new hardware configuration, however, this is an advanced feature that must be built into the ironic Python Agent image. Due to the complex nature of such operations, and the fact that no one size fits all, this requires a custom ironic Python Agent image to be constructed with an appropriate hardware manager. For more information on hardware managers, see http://docs.openstack.org/developer/ironic-python-agent/#hardware-managers

ironic's upstream documentation for cleaning may be found here: http://docs.openstack.org/developer/ironic/deploy/cleaning.html

29.7.1 Setup Edit source

Cleaning is enabled by default in ironic when installed via the Cloud Lifecycle Manager. You can verify this by examining the ironic-conductor.conf file. Look for:

[conductor]
clean_nodes=true

29.7.2 In use Edit source

When enabled, cleaning will be run automatically when nodes go from active to available state or from manageable to available. To monitor what step of cleaning the node is in, run ironic node-show:

stack@ardana-cp1-c1-m1-mgmt:~$ ironic node-show 4e6d4273-2535-4830-a826-7f67e71783ed
+------------------------+-----------------------------------------------------------------------+
| Property               | Value                                                                 |
+------------------------+-----------------------------------------------------------------------+
| target_power_state     | None                                                                  |
| extra                  | {}                                                                    |
| last_error             | None                                                                  |
| updated_at             | 2016-04-15T09:33:16+00:00                                             |
| maintenance_reason     | None                                                                  |
| provision_state        | cleaning                                                              |
| clean_step             | {}                                                                    |
| uuid                   | 4e6d4273-2535-4830-a826-7f67e71783ed                                  |
| console_enabled        | False                                                                 |
| target_provision_state | available                                                             |
| provision_updated_at   | 2016-04-15T09:33:16+00:00                                             |
| maintenance            | False                                                                 |
| inspection_started_at  | None                                                                  |
| inspection_finished_at | None                                                                  |
| power_state            | power off                                                             |
| driver                 | agent_ilo                                                             |
| reservation            | ardana-cp1-c1-m1-mgmt                                                 |
| properties             | {u'memory_mb': 4096, u'cpu_arch': u'amd64', u'local_gb': 80,          |
|                        | u'cpus': 2, u'capabilities': u'boot_mode:uefi,boot_option:local'}     |
| instance_uuid          | None                                                                  |
| name                   | None                                                                  |
| driver_info            | {u'ilo_deploy_iso': u'249bf095-e741-441d-bc28-0f44a9b8cd80',          |
|                        | u'ipmi_username': u'Administrator', u'deploy_kernel':                 |
|                        | u'3a78c0a9-3d8d-4764-9300-3e9c00e167a1', u'ilo_address':              |
|                        | u'10.1.196.113', u'ipmi_address': u'10.1.196.113', u'deploy_ramdisk': |
|                        | u'd02c811c-e521-4926-9f26-0c88bbd2ee6d', u'ipmi_password': u'******', |
|                        | u'ilo_password': u'******', u'ilo_username': u'Administrator'}        |
| created_at             | 2016-04-14T08:30:08+00:00                                             |
| driver_internal_info   | {u'clean_steps': None,                      |
|                        | u'hardware_manager_version': {u'generic_hardware_manager': u'1.0'},   |
|                        | u'is_whole_disk_image': True, u'agent_erase_devices_iterations': 1,   |
|                        | u'agent_url': u'http://192.168.246.245:9999',                         |
|                        | u'agent_last_heartbeat': 1460633166}                                  |
| chassis_uuid           |                                                                       |
| instance_info          | {}                                                                    |
+------------------------+-----------------------------------------------------------------------+

The status will be in the driver_internal_info field. You will also be able to see the clean_steps list there.

29.7.3 Troubleshooting Edit source

If an error occurs during the cleaning process, the node will enter the clean failed state so that it is not deployed. The node remains powered on for debugging purposes. The node can be moved to the manageable state to attempt a fix using the following command:

ironic node-set-provision-state <node id> manage

Once you have identified and fixed the issue, you can return the node to available state by executing the following commands:

ironic node-set-maintenance <node id> false
ironic node-set-provision-state <node id> provide

This will retry the cleaning steps and set the node to available state upon their successful completion.

29.7.4 Disabling Node Cleaning Edit source

To disable node cleaning, edit ~/openstack/my_cloud/definition/data/ironic/ironic_config.yml and set enable_node_cleaning to false.

Commit your changes:

cd ~/openstack/ardana/ansible
git add -A
git commit -m "disable node cleaning"

Deploy these changes by re-running the configuration processor and reconfigure the ironic installation:

cd ~/openstack/ardana/ansible
ansible-playbook -i hosts/localhost config-processor-run.yml
ansible-playbook -i hosts/localhost ready-deployment.yml
cd ~/scratch/ansible/next/ardana/ansible
ansible-playbook -i hosts/verb_hosts ironic-reconfigure.yml

29.8 Ironic and HPE OneView Edit source

29.8.1 Enabling Ironic HPE OneView driver in SUSE OpenStack Cloud Edit source

Edit the file ~/openstack/my_cloud/definition/data/ironic/ironicconfig.yml and set the value

enable_oneview: true

This will enable the HPE OneView driver for ironic in SUSE OpenStack Cloud.

29.8.2 Adding HPE OneView Appliance Credentials Edit source

manage_url: https://<Onview appliance URL>

oneview_username: "<Appliance username>"

oneview_encrypted_password: "<Encrypted password>"

oneview_allow_insecure_connections: <true/false>

tls_cacert_file: <CA certificate for connection>

29.8.3 Encrypting the HPE OneView Password Edit source

Encryption can be applied using ardanaencrypt.py or using openssl. On the Cloud Lifecycle Manager node, export the key used for encryption as environment variable:

export ARDANA_USER_PASSWORD_ENCRYPT_KEY="ENCRYPTION_KEY"

And then execute the following commands:

cd ~/openstack/ardana/ansible
python ardanaencrypt.py

Enter password to be encrypted when prompted. The script uses the key that was exported in the ARDANA_USER_PASSWORD_ENCRYPT_KEY to do the encryption.

For more information, see Book “Security Guide”, Chapter 10 “Encryption of Passwords and Sensitive Data”.

29.8.4 Decrypting the HPE OneView Password Edit source

Before running the site.yml playbook, export the key used for encryption as environment variable:

export ARDANA_USER_PASSWORD_ENCRYPT_KEY="ENCRYPTION_KEY"

The decryption of the password is then automatically handled in ironic-ansible playbooks.

29.8.5 Registering Baremetal Node for HPE OneView Driver Edit source

ironic node-create -d agent_pxe_oneview

Update node driver-info:

 ironic node-update $NODE_UUID add driver_info/server_hardware_uri=$SH_URI

29.8.6 Updating Node Properties Edit source

ironic node-update $NODE_UUID add \
  properties/capabilities=server_hardware_type_uri:$SHT_URI,\
        enclosure_group_uri:$EG_URI,server_profile_template_uri=$SPT_URI

29.8.7 Creating Port for Driver Edit source

ironic port-create -n $NODE_UUID -a $MAC_ADDRESS

29.8.8 Creating a Node Edit source

Create Node:

ironic node-create -n ovbay7 -d agent_pxe_oneview

Update driver info:

ironic node-update $ID add driver_info/server_hardware_uri="/rest/server-hardware/3037...464B" \
driver_info/deploy_kernel="$KERNELDISK" driver_info/deploy_ramdisk="$RAMDISK"

Update node properties:

ironic node-update $ID add properties/local_gb=10
ironic node-update $ID add properties/cpus=24 properties/memory_mb=262144 \
properties/cpu_arch=x86_64
ironic node-update \
$ID add properties/capabilities=server_hardware_type_uri:'/rest/server-hardware-types/B31...F69E',\
enclosure_group_uri:'/rest/enclosure-groups/80efe...b79fa',\
server_profile_template_uri:'/rest/server-profile-templates/faafc3c0-6c81-47ca-a407-f67d11262da5'

29.8.9 Getting Data using REST API Edit source

GET login session auth id:

curl -k https://ONEVIEW_MANAGER_URL/rest/login-sessions \
  -H "content-type:application/json" \
  -X POST \
  -d '{"userName":"USER_NAME", "password":"PASSWORD"}'

Get the complete node details in JSON format:

curl -k "https://ONEVIEW_MANAGER_URL;/rest/server-hardware/30373237-3132-4753-4835-32325652464B" -H "content-type:application/json" -H "Auth:<auth_session_id>"| python -m json.tool

29.8.10 Ironic HPE OneView CLI Edit source

ironic-oneview-cli is already installed in ironicclient venv with a symbolic link to it. To generate an rc file for the HPE OneView CLI, follow these steps:

  1. Run the following commands:

    source ~/service.osrc
    openstack image list
  2. Note the deploy-kernel and deploy-ramdisk UUID and then run the following command to generate the rc file:

    ironic-oneview genrc

    You will be prompted to enter:

    • HPE OneView Manager URL

    • Username

    • deploy-kernel

    • deploy-ramdisk

    • allow_insecure_connection

    • cacert file

    The ironic-oneview.rc file will be generated in the current directory, by default. It is possible to specify a different location.

  3. Source the generated file:

    source ironic-oneview.rc

    Now enter the password of the HPE OneView appliance.

  4. You can now use the CLI for node and flavor creation as follows:

    ironic-oneview node-create
    ironic-oneview flavor-create

29.9 RAID Configuration for Ironic Edit source

  1. Node Creation:

    Check the raid capabilities of the driver:

    ironic --ironic-api-version 1.15 driver-raid-logical-disk-properties pxe_ilo

    This will generate output similar to the following:

    +----------------------+-------------------------------------------------------------------------+
    | Property             | Description                                                             |
    +----------------------+-------------------------------------------------------------------------+
    | controller           | Controller to use for this logical disk. If not specified, the          |
    |                      | driver will choose a suitable RAID controller on the bare metal node.   |
    |                      | Optional.                                                               |
    | disk_type            | The type of disk preferred. Valid values are 'hdd' and 'ssd'. If this   |
    |                      | is not specified, disk type will not be a selection criterion for       |
    |                      | choosing backing physical disks. Optional.                              |
    | interface_type       | The interface type of disk. Valid values are 'sata', 'scsi' and 'sas'.  |
    |                      | If this is not specified, interface type will not be a selection        |
    |                      | criterion for choosing backing physical disks. Optional.                |
    | is_root_volume       | Specifies whether this disk is a root volume. By default, this is False.|
    |                      | Optional.                                                               |
    | #_of_physical_disks  | Number of physical disks to use for this logical disk. By default, the  |
    |                      | driver uses the minimum number of disks required for that RAID level.   |
    |                      | Optional.                                                               |
    | physical_disks       | The physical disks to use for this logical disk. If not specified, the  |
    |                      | driver will choose suitable physical disks to use. Optional.            |
    | raid_level           | RAID level for the logical disk. Valid values are '0', '1', '2', '5',   |
    |                      | '6', '1+0', '5+0' and '6+0'. Required.                                  |
    | share_physical_disks | Specifies whether other logical disks can share physical disks with this|
    |                      | logical disk. By default, this is False. Optional.                      |
    | size_gb              | Size in GiB (Integer) for the logical disk. Use 'MAX' as size_gb if     |
    |                      | this logical disk is supposed to use the rest of                        |
    |                      | the space available. Required.                                          |
    | volume_name          | Name of the volume to be created. If this is not specified, it will be  |
    |                      | auto-generated. Optional.                                               |
    +----------------------+-------------------------------------------------------------------------+

    Node State will be Available

    ironic node-create -d pxe_ilo -i ilo_address=<ip_address> \
      -i ilo_username=<username> -i ilo_password=<password> \
      -i ilo_deploy_iso=<iso_id> -i deploy_kernel=<kernel_id> \
      -i deploy_ramdisk=<ramdisk_id> -p cpus=2 -p memory_mb=4096 \
      -p local_gb=80  -p cpu_arch=amd64 \
      -p capabilities="boot_option:local,boot_mode:bios"
    ironic port-create -a <port> -n <node-uuid>
  2. Apply the target raid configuration on the node:

    See the OpenStack documentation for RAID configuration at http://docs.openstack.org/developer/ironic/deploy/raid.html.

    Set the target RAID configuration by editing the file raid_conf.json and setting the appropriate values, for example:

    { "logical_disks": [ {"size_gb": 5, "raid_level": "0", "is_root_volume": true} ] }

    and then run the following command:

    ironic --ironic-api-version 1.15 node-set-target-raid-config <node-uuid> raid_conf.json

    The output produced should be similar to the following:

    +-----------------------+-------------------------------------------------------------------------+
    | Property              | Value                                                                   |
    +-----------------------+-------------------------------------------------------------------------+
    | chassis_uuid          |                                                                         |
    | clean_step            | {}                                                                      |
    | console_enabled       | False                                                                   |
    | created_at            | 2016-06-14T14:58:07+00:00                                               |
    | driver                | pxe_ilo                                                                 |
    | driver_info           | {u'ilo_deploy_iso': u'd43e589a-07db-4fce-a06e-98e2f38340b4',            |
    |                       | u'deploy_kernel': u'915c5c74-1ceb-4f78-bdb4-8547a90ac9c0',              |
    |                       | u'ilo_address': u'10.1.196.116', u'deploy_ramdisk':                     |
    |                       | u'154e7024-bf18-4ad2-95b0-726c09ce417a', u'ilo_password': u'******',    |
    |                       | u'ilo_username': u'Administrator'}                                      |
    | driver_internal_info  | {u'agent_cached_clean_steps_refreshed': u'2016-06-15 07:16:08.264091',  |
    |                       | u'agent_cached_clean_steps': {u'raid': [{u'interface': u'raid',         |
    |                       | u'priority': 0, u'step': u'delete_configuration'}, {u'interface':       |
    |                       | u'raid', u'priority': 0, u'step': u'create_configuration'}], u'deploy': |
    |                       | [{u'priority': 10, u'interface': u'deploy', u'reboot_requested': False, |
    |                       | u'abortable': True, u'step': u'erase_devices'}]}, u'clean_steps': None, |
    |                       | u'hardware_manager_version': {u'generic_hardware_manager': u'3'},       |
    |                       | u'agent_erase_devices_iterations': 1, u'agent_url':                     |
    |                       | u'http://192.168.245.143:9999', u'agent_last_heartbeat': 1465974974}    |
    | extra                 | {}                                                                      |
    | inspection_finished_at| None                                                                    |
    | inspection_started_at | None                                                                    |
    | instance_info         | {u'deploy_key': u'XXN2ON0V9ER429MECETJMUG5YHTKOQOZ'}                    |
    | instance_uuid         | None                                                                    |
    | last_error            | None                                                                    |
    | maintenance           | False                                                                   |
    | maintenance_reason    | None                                                                    |
    | name                  | None                                                                    |
    | power_state           | power off                                                               |
    | properties            | {u'cpu_arch': u'amd64', u'root_device': {u'wwn': u'0x600508b1001ce286'},|
    |                       | u'cpus': 2, u'capabilities':                                            |
    |                       | u'boot_mode:bios,raid_level:6,boot_option:local', u'memory_mb': 4096,   |
    |                       | u'local_gb': 4}                                                         |
    | provision_state       | available                                                               |
    | provision_updated_at  | 2016-06-15T07:16:27+00:00                                               |
    | reservation           | padawan-ironic-cp1-c1-m2-mgmt                                           |
    | target_power_state    | power off                                                               |
    | target_provision_state| None                                                                    |
    | target_raid_config    | {u'logical_disks': [{u'size_gb': 5, u'raid_level': u'6',                |
    |                       | u'is_root_volume': True}]}                                              |
    | updated_at            | 2016-06-15T07:44:22+00:00                                               |
    | uuid                  | 22ab9f85-71a1-4748-8d6b-f6411558127e                                    |
    +-----------------------+-------------------------------------------------------------------------+

    Now set the state of the node to manageable:

    ironic --ironic-api-version latest node-set-provision-state <node-uuid> manage
  3. Manual cleaning steps:

    Manual cleaning is enabled by default in production - the following are the steps to enable cleaning if the manual cleaning has been disabled.

    1. Provide cleaning_network_uuid in ironic-conductor.conf

    2. Edit the file ~/openstack/my_cloud/definition/data/ironic/ironic_config.yml and set enable_node_cleaning to true.

    3. Then run the following set of commands:

      cd ~/openstack/ardana/ansible
      git add -A
      git commit -m "enabling node cleaning"
      cd ~/openstack/ardana/ansible
      ansible-playbook -i hosts/localhost config-processor-run.yml
      ansible-playbook -i hosts/localhost ready-deployment.yml
      cd ~/scratch/ansible/next/ardana/ansible
      ansible-playbook -i hosts/verb_hosts ironic-reconfigure.yml

      After performing these steps, the state of the node will become Cleaning.

    Run the following command:

    ironic --ironic-api-version latest node-set-provision-state 2123254e-8b31...aa6fd \
      clean --clean-steps '[{ "interface": "raid","step": "delete_configuration"}, \
      { "interface": "raid" ,"step": "create_configuration"}]'

    Node-information after a Manual cleaning:

    +-----------------------+-------------------------------------------------------------------------+
    | Property              | Value                                                                   |
    +-----------------------+-------------------------------------------------------------------------+
    | chassis_uuid          |                                                                         |
    | clean_step            | {}                                                                      |
    | console_enabled       | False                                                                   |
    | created_at            | 2016-06-14T14:58:07+00:00                                               |
    | driver                | pxe_ilo                                                                 |
    | driver_info           | {u'ilo_deploy_iso': u'd43e589a-07db-4fce-a06e-98e2f38340b4',            |
    |                       | u'deploy_kernel': u'915c5c74-1ceb-4f78-bdb4-8547a90ac9c0',              |
    |                       | u'ilo_address': u'10.1.196.116', u'deploy_ramdisk':                     |
    |                       | u'154e7024-bf18-4ad2-95b0-726c09ce417a', u'ilo_password': u'******',    |
    |                       | u'ilo_username': u'Administrator'}                                      |
    | driver_internal_info  | {u'agent_cached_clean_steps_refreshed': u'2016-06-15 07:16:08.264091',  |
    |                       | u'agent_cached_clean_steps': {u'raid': [{u'interface': u'raid',         |
    |                       | u'priority': 0, u'step': u'delete_configuration'}, {u'interface':       |
    |                       | u'raid', u'priority': 0, u'step': u'create_configuration'}], u'deploy': |
    |                       | [{u'priority': 10, u'interface': u'deploy', u'reboot_requested': False, |
    |                       | u'abortable': True, u'step': u'erase_devices'}]}, u'clean_steps': None, |
    |                       | u'hardware_manager_version': {u'generic_hardware_manager': u'3'},       |
    |                       | u'agent_erase_devices_iterations': 1, u'agent_url':                     |
    |                       | u'http://192.168.245.143:9999', u'agent_last_heartbeat': 1465974974}    |
    | extra                 | {}                                                                      |
    | inspection_finished_at| None                                                                    |
    | inspection_started_at | None                                                                    |
    | instance_info         | {u'deploy_key': u'XXN2ON0V9ER429MECETJMUG5YHTKOQOZ'}                    |
    | instance_uuid         | None                                                                    |
    | last_error            | None                                                                    |
    | maintenance           | False                                                                   |
    | maintenance_reason    | None                                                                    |
    | name                  | None                                                                    |
    | power_state           | power off                                                               |
    | properties            | {u'cpu_arch': u'amd64', u'root_device': {u'wwn': u'0x600508b1001ce286'},|
    |                       | u'cpus': 2, u'capabilities':                                            |
    |                       | u'boot_mode:bios,raid_level:6,boot_option:local', u'memory_mb': 4096,   |
    |                       | u'local_gb': 4}                                                         |
    | provision_state       | manageable                                                              |
    | provision_updated_at  | 2016-06-15T07:16:27+00:00                                               |
    | raid_config           | {u'last_updated': u'2016-06-15 07:16:14.584014', u'physical_disks':     |
    |                       | [{u'status': u'ready', u'size_gb': 1024, u'interface_type': u'sata',    |
    |                       | u'firmware': u'HPGC', u'controller': u'Smart Array P440ar in Slot 0     |
    |                       | (Embedded)', u'model': u'ATA     MM1000GBKAL', u'disk_type': u'hdd',    |
    |                       | u'id': u'1I:3:3'}, {u'status': u'ready', u'size_gb': 1024,              |
    |                       | u'interface_type': u'sata', u'firmware': u'HPGC', u'controller': u'Smart|
    |                       | Array P440ar in Slot 0 (Embedded)', u'model': u'ATA     MM1000GBKAL',   |
    |                       | u'disk_type': u'hdd', u'id': u'1I:3:1'}, {u'status': u'active',         |
    |                       | u'size_gb': 1024, u'interface_type': u'sata', u'firmware': u'HPGC',     |
    |                       | u'controller': u'Smart Array P440ar in Slot 0 (Embedded)', u'model':    |
    |                       | u'ATA     MM1000GBKAL', u'disk_type': u'hdd', u'id': u'1I:3:2'},        |
    |                       | {u'status': u'active', u'size_gb': 1024, u'interface_type': u'sata',    |
    |                       | u'firmware': u'HPGC', u'controller': u'Smart Array P440ar in Slot 0     |
    |                       | (Embedded)', u'model': u'ATA     MM1000GBKAL', u'disk_type': u'hdd',    |
    |                       | u'id': u'2I:3:6'}, {u'status': u'active', u'size_gb': 1024,             |
    |                       | u'interface_type': u'sata', u'firmware': u'HPGC', u'controller': u'Smart|
    |                       | Array P440ar in Slot 0 (Embedded)', u'model': u'ATA     MM1000GBKAL',   |
    |                       | u'disk_type': u'hdd', u'id': u'2I:3:5'}, {u'status': u'active',         |
    |                       | u'size_gb': 1024, u'interface_type': u'sata', u'firmware': u'HPGC',     |
    |                       | u'controller': u'Smart Array P440ar in Slot 0 (Embedded)', u'model':    |
    |                       | u'ATA     MM1000GBKAL', u'disk_type': u'hdd', u'id': u'1I:3:4'}],       |
    |                       | u'logical_disks': [{u'size_gb': 4, u'physical_disks': [u'1I:3:2',       |
    |                       | u'2I:3:6', u'2I:3:5', u'1I:3:4'], u'raid_level': u'6',                  |
    |                       | u'is_root_volume': True, u'root_device_hint': {u'wwn':                  |
    |                       | u'0x600508b1001ce286'}, u'controller': u'Smart Array P440ar in Slot 0   |
    |                       | (Embedded)', u'volume_name': u'015E795CPDNLH0BRH8N406AAB7'}]}           |
    | reservation           | padawan-ironic-cp1-c1-m2-mgmt                                           |
    | target_power_state    | power off                                                               |
    | target_provision_state| None                                                                    |
    | target_raid_config    | {u'logical_disks': [{u'size_gb': 5, u'raid_level': u'6',                |
    |                       | u'is_root_volume': True}]}                                              |
    | updated_at            | 2016-06-15T07:44:22+00:00                                               |
    | uuid                  | 22ab9f85-71a1-4748-8d6b-f6411558127e                                    |
    +-----------------------+-------------------------------------------------------------------------+

    After the manual cleaning, run the following command to change the state of a node to available:

    ironic --ironic-api-version latest node-set-provision-state <node-uuid> \
      provide

29.10 Audit Support for Ironic Edit source

29.10.1 API Audit Logging Edit source

Audit middleware supports delivery of CADF audit events via Oslo messaging notifier capability. Based on notification_driver configuration, audit events can be routed to messaging infrastructure (notification_driver = messagingv2) or can be routed to a log file (notification_driver = log).

Audit middleware creates two events per REST API interaction. The first event has information extracted from request data and the second one contains information on the request outcome (response).

29.10.2 Enabling API Audit Logging Edit source

You can enable audit logging for ironic by changing the configuration in the input model. Edit the file ~/openstack/my_cloud/definition/cloudConfig.yml and in the audit-settings section, change the default value to enabled. The ironic-ansible playbooks will now enable audit support for ironic.

API audit events will be logged in the corresponding audit directory, for example, /var/audit/ironic/ironic-api-audit.log. An audit event will be logged in the log file for every request and response for an API call.

29.10.3 Sample Audit Event Edit source

The following output is an example of an audit event for an ironic node-list command:

{
   "event_type":"audit.http.request",
   "timestamp":"2016-06-15 06:04:30.904397",
   "payload":{
      "typeURI":"http://schemas.dmtf.org/cloud/audit/1.0/event",
      "eventTime":"2016-06-15T06:04:30.903071+0000",
      "target":{
         "id":"ironic",
         "typeURI":"unknown",
         "addresses":[
            {
               "url":"http://{ironic_admin_host}:6385",
               "name":"admin"
            },
           {
               "url":"http://{ironic_internal_host}:6385",
               "name":"private"
           },
           {
               "url":"http://{ironic_public_host}:6385",
               "name":"public"
           }
         ],
         "name":"ironic"
      },
      "observer":{
         "id":"target"
      },
      "tags":[
         "correlation_id?value=685f1abb-620e-5d5d-b74a-b4135fb32373"
      ],
      "eventType":"activity",
      "initiator":{
         "typeURI":"service/security/account/user",
         "name":"admin",
         "credential":{
            "token":"***",
            "identity_status":"Confirmed"
         },
         "host":{
            "agent":"python-ironicclient",
            "address":"10.1.200.129"
         },
         "project_id":"d8f52dd7d9e1475dbbf3ba47a4a83313",
         "id":"8c1a948bad3948929aa5d5b50627a174"
      },
      "action":"read",
      "outcome":"pending",
      "id":"061b7aa7-5879-5225-a331-c002cf23cb6c",
      "requestPath":"/v1/nodes/?associated=True"
   },
   "priority":"INFO",
   "publisher_id":"ironic-api",
   "message_id":"2f61ebaa-2d3e-4023-afba-f9fca6f21fc2"
}