ironic/doc/source/dev/dev-quickstart.rst

Developer Quick-Start

This is a quick walkthrough to get you started developing code for Ironic. This assumes you are already familiar with submitting code reviews to an OpenStack project.

The gate currently runs the unit tests under both Python 2.7 and Python 3.4. It is strongly encouraged to run the unit tests locally under one, the other, or both prior to submitting a patch.

Note

Do not run unit tests on the same environment as devstack due to conflicting configuration with system dependencies.

http://docs.openstack.org/infra/manual/developers.html#development-workflow

Install prerequisites (for python 2.7):

• Ubuntu/Debian:

  sudo apt-get install python-dev libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev libpq-dev git git-review libffi-dev gettext ipmitool psmisc graphviz libjpeg-dev

• Fedora 21/RHEL7/CentOS7:

  sudo yum install python-devel openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel postgresql-devel git git-review libffi-devel gettext ipmitool psmisc graphviz gcc libjpeg-turbo-devel

  If using RHEL and yum reports "No package python-pip available" and "No package git-review available", use the EPEL software repository. Instructions can be found at http://fedoraproject.org/wiki/EPEL/FAQ#howtouse.

• Fedora 22 or higher:

  sudo dnf install python-devel openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel postgresql-devel git git-review libffi-devel gettext ipmitool psmisc graphviz gcc libjpeg-turbo-devel

  Additionally, if using Fedora 23, redhat-rpm-config package should be installed so that development virtualenv can be built successfully.

• openSUSE/SLE 12:

  sudo zypper install git git-review libffi-devel libmysqlclient-devel libopenssl-devel libxml2-devel libxslt-devel postgresql-devel python-devel python-nose python-pip gettext-runtime psmisc

  Graphviz is only needed for generating the state machine diagram. To install it on openSUSE or SLE 12, see http://software.opensuse.org/download.html?project=graphics&package=graphviz-plugins.

To use Python 3.4, follow the instructions above to install prerequisites and additionally install the following packages:

• On Ubuntu/Debian:

  sudo apt-get install python3-dev

• On Fedora 21/RHEL7/CentOS7:

  sudo yum install python3-devel

• On Fedora 22 and higher:

  sudo dnf install python3-devel

If your distro has at least tox 1.8, use similar command to install python-tox package. Otherwise install this on all distros:

sudo pip install -U tox

You may need to explicitly upgrade virtualenv if you've installed the one from your OS distribution and it is too old (tox will complain). You can upgrade it individually, if you need to:

sudo pip install -U virtualenv

Ironic source code should be pulled directly from git:

# from your home or source directory
cd ~
git clone https://git.openstack.org/openstack/ironic
cd ironic

Set up a local environment for development and testing should be done with tox, for example:

# create a virtualenv for development
tox -evenv --notest

All unit tests should be run using tox. To run Ironic's entire test suite:

# run all tests (unit under both py27 and py34, and pep8)
tox

To run the unit tests under py27 and also run the pep8 tests:

# run all tests (unit under py27 and pep8)
tox -epy27 -epep8

To run the unit tests under py34 and also run the pep8 tests:

# run all tests (unit under py34 and pep8)
tox -epy34 -epep8

You may pass options to the test programs using positional arguments. To run a specific unit test, this passes the -r option and desired test (regex string) to os-testr:

# run a specific test for Python 2.7
tox -epy27 -- -r test_conductor

To run only the pep8/flake8 syntax and style checks:

tox -epep8

Exercising the Services Locally

If you would like to exercise the Ironic services in isolation within a local virtual environment, you can do this without starting any other OpenStack services. For example, this is useful for rapidly prototyping and debugging interactions over the RPC channel, testing database migrations, and so forth.

Step 1: System Dependencies

There are two ways you may use to install the required system dependencies: Manually, or by using the included Vagrant file.

Option 1: Manual Install

1. Install a few system prerequisites:

   # install rabbit message broker
   # Ubuntu/Debian:
   sudo apt-get install rabbitmq-server
   
   # Fedora 21/RHEL7/CentOS7:
   sudo yum install rabbitmq-server
   sudo systemctl start rabbitmq-server.service
   
   # Fedora 22 or higher:
   sudo dnf install rabbitmq-server
   sudo systemctl start rabbitmq-server.service
   
   # openSUSE/SLE 12:
   sudo zypper install rabbitmq-server
   sudo systemctl start rabbitmq-server.service
   
   # optionally, install mysql-server
   
   # Ubuntu/Debian:
   # sudo apt-get install mysql-server
   
   # Fedora 21/RHEL7/CentOS7:
   # sudo yum install mariadb mariadb-server
   # sudo systemctl start mariadb.service
   
   # Fedora 22 or higher:
   # sudo dnf install mariadb mariadb-server
   # sudo systemctl start mariadb.service
   
   # openSUSE/SLE 12:
   # sudo zypper install mariadb
   # sudo systemctl start mysql.service

2. Clone the Ironic repository and install it within a virtualenv:

   # activate the virtualenv
   cd ~
   git clone https://git.openstack.org/openstack/ironic
   cd ironic
   tox -evenv --notest
   source .tox/venv/bin/activate
   
   # install ironic within the virtualenv
   python setup.py develop

3. Create a configuration file within the ironic source directory:

   # copy sample config and modify it as necessary
   cp etc/ironic/ironic.conf.sample etc/ironic/ironic.conf.local
   
   # disable auth since we are not running keystone here
   sed -i "s/#auth_strategy=keystone/auth_strategy=noauth/" etc/ironic/ironic.conf.local
   
   # Use the 'fake_ipmitool' test driver
   sed -i "s/#enabled_drivers=pxe_ipmitool/enabled_drivers=fake_ipmitool/" etc/ironic/ironic.conf.local
   
   # set a fake host name [useful if you want to test multiple services on the same host]
   sed -i "s/#host=.*/host=test-host/" etc/ironic/ironic.conf.local
   
   # turn off the periodic sync_power_state task, to avoid getting NodeLocked exceptions
   sed -i "s/#sync_power_state_interval=60/sync_power_state_interval=-1/" etc/ironic/ironic.conf.local

4. Initialize the ironic database (optional):

   # ironic defaults to storing data in ./ironic/ironic.sqlite
   
   # If using MySQL, you need to create the initial database
   mysql -u root -pMYSQL_ROOT_PWD -e "create schema ironic"
   
   # and switch the DB connection from sqlite to something else, eg. mysql
   sed -i "s/#connection=.*/connection=mysql\+pymysql:\/\/root:MYSQL_ROOT_PWD@localhost\/ironic/" etc/ironic/ironic.conf.local

At this point, you can continue to Step 2.

Option 2: Vagrant, VirtualBox, and Ansible

This option requires virtualbox, vagrant, and ansible. You may install these using your favorite package manager, or by downloading from the provided links.

Next, run vagrant:

vagrant up

This will create a VM available to your local system at 192.168.99.11, will install all the necessary service dependencies, and configure some default users. It will also generate ./etc/ironic/ironic.conf.local preconfigured for local dev work. We recommend you compare and familiarize yourself with the settings in ./etc/ironic/ironic.conf.sample so you can adjust it to meet your own needs.

Step 2: Start the API

1. Activate the virtual environment created in the previous section to run the API:

   # switch to the ironic source (Not necessary if you followed Option 1)
   cd ironic
   
   # activate the virtualenv
   source .tox/venv/bin/activate
   
   # install ironic within the virtualenv
   python setup.py develop
   
   # This creates the database tables.
   ironic-dbsync --config-file etc/ironic/ironic.conf.local create_schema

2. Start the API service in debug mode and watch its output:

   # start the API service
   ironic-api -v -d --config-file etc/ironic/ironic.conf.local

Step 3: Install the Client

1. Clone the python-ironicclient repository and install it within a virtualenv:

   # from your home or source directory
   cd ~
   git clone https://git.openstack.org/openstack/python-ironicclient
   cd python-ironicclient
   tox -evenv --notest
   source .tox/venv/bin/activate

2. Export some ENV vars so the client will connect to the local services that you'll start in the next section:

   export OS_AUTH_TOKEN=fake-token
   export IRONIC_URL=http://localhost:6385/

Step 4: Start the Conductor Service

Open one more window (or screen session), again activate the venv, and then start the conductor service and watch its output:

# activate the virtualenv
cd ironic
source .tox/venv/bin/activate

# start the conductor service
ironic-conductor -v -d --config-file etc/ironic/ironic.conf.local

You should now be able to interact with Ironic via the python client (installed in Step 3) and observe both services' debug outputs in the other two windows. This is a good way to test new features or play with the functionality without necessarily starting DevStack.

To get started, list the available commands and resources:

# get a list of available commands
ironic help

# get the list of drivers currently supported by the available conductor(s)
ironic driver-list

# get a list of nodes (should be empty at this point)
ironic node-list

Here is an example walkthrough of creating a node:

MAC="aa:bb:cc:dd:ee:ff"   # replace with the MAC of a data port on your node
IPMI_ADDR="1.2.3.4"       # replace with a real IP of the node BMC
IPMI_USER="admin"         # replace with the BMC's user name
IPMI_PASS="pass"          # replace with the BMC's password

# enroll the node with the "fake" deploy driver and the "ipmitool" power driver
# Note that driver info may be added at node creation time with "-i"
NODE=$(ironic node-create -d fake_ipmitool -i ipmi_address=$IPMI_ADDR -i ipmi_username=$IPMI_USER | grep ' uuid ' | awk '{print $4}')

# driver info may also be added or updated later on
ironic node-update $NODE add driver_info/ipmi_password=$IPMI_PASS

# add a network port
ironic port-create -n $NODE -a $MAC

# view the information for the node
ironic node-show $NODE

# request that the node's driver validate the supplied information
ironic node-validate $NODE

# you have now enrolled a node sufficiently to be able to control
# its power state from ironic!
ironic node-set-power-state $NODE on

If you make some code changes and want to test their effects, install again with "python setup.py develop", stop the services with Ctrl-C, and restart them.

Deploying Ironic with DevStack

DevStack may be configured to deploy Ironic, setup Nova to use the Ironic driver and provide hardware resources (network, baremetal compute nodes) using a combination of OpenVSwitch and libvirt. It is highly recommended to deploy on an expendable virtual machine and not on your personal work station. Deploying Ironic with DevStack requires a machine running Ubuntu 14.04 (or later) or Fedora 20 (or later).

http://docs.openstack.org/developer/devstack/

Devstack will no longer create the user 'stack' with the desired permissions, but does provide a script to perform the task:

git clone https://github.com/openstack-dev/devstack.git devstack
sudo ./devstack/tools/create-stack-user.sh

Switch to the stack user and clone DevStack:

sudo su - stack
git clone https://github.com/openstack-dev/devstack.git devstack

Create devstack/local.conf with minimal settings required to enable Ironic. You can use either of two drivers for deploy: pxe* or agent*, see IPA for explanation. An example local.conf that enables both types of drivers and uses the pxe_ssh driver by default:

cd devstack
cat >local.conf <<END
[[local|localrc]]
# Credentials
ADMIN_PASSWORD=password
DATABASE_PASSWORD=password
RABBIT_PASSWORD=password
SERVICE_PASSWORD=password
SERVICE_TOKEN=password
SWIFT_HASH=password
SWIFT_TEMPURL_KEY=password

# Enable Ironic plugin
enable_plugin ironic git://git.openstack.org/openstack/ironic

# Enable Neutron which is required by Ironic and disable nova-network.
disable_service n-net
disable_service n-novnc
enable_service q-svc
enable_service q-agt
enable_service q-dhcp
enable_service q-l3
enable_service q-meta
enable_service neutron

# Enable Swift for agent_* drivers
enable_service s-proxy
enable_service s-object
enable_service s-container
enable_service s-account

# Disable Horizon
disable_service horizon

# Disable Heat
disable_service heat h-api h-api-cfn h-api-cw h-eng

# Disable Cinder
disable_service cinder c-sch c-api c-vol

# Swift temp URL's are required for agent_* drivers.
SWIFT_ENABLE_TEMPURLS=True

# Create 3 virtual machines to pose as Ironic's baremetal nodes.
IRONIC_VM_COUNT=3
IRONIC_VM_SSH_PORT=22
IRONIC_BAREMETAL_BASIC_OPS=True
IRONIC_DEPLOY_DRIVER_ISCSI_WITH_IPA=True

# Enable Ironic drivers.
IRONIC_ENABLED_DRIVERS=fake,agent_ssh,agent_ipmitool,pxe_ssh,pxe_ipmitool

# Change this to alter the default driver for nodes created by devstack.
# This driver should be in the enabled list above.
IRONIC_DEPLOY_DRIVER=pxe_ssh

# The parameters below represent the minimum possible values to create
# functional nodes.
IRONIC_VM_SPECS_RAM=1024
IRONIC_VM_SPECS_DISK=10

# Size of the ephemeral partition in GB. Use 0 for no ephemeral partition.
IRONIC_VM_EPHEMERAL_DISK=0

# To build your own IPA ramdisk from source, set this to True
IRONIC_BUILD_DEPLOY_RAMDISK=False

VIRT_DRIVER=ironic

# By default, DevStack creates a 10.0.0.0/24 network for instances.
# If this overlaps with the hosts network, you may adjust with the
# following.
NETWORK_GATEWAY=10.1.0.1
FIXED_RANGE=10.1.0.0/24
FIXED_NETWORK_SIZE=256

# Log all output to files
LOGFILE=$HOME/devstack.log
LOGDIR=$HOME/logs
IRONIC_VM_LOG_DIR=$HOME/ironic-bm-logs

END

Note

When running QEMU as non-root user (e.g. qemu on Fedora or libvirt-qemu on Ubuntu), make sure IRONIC_VM_LOG_DIR points to a directory where QEMU will be able to write. You can verify this with, for example:

# on Fedora

sudo -u qemu touch $HOME/ironic-bm-logs/test.log # on Ubuntu sudo -u libvirt-qemu touch $HOME/ironic-bm-logs/test.log

Run stack.sh:

./stack.sh

Source credentials, create a key, and spawn an instance:

source ~/devstack/openrc

# query the image id of the default cirros image
image=$(nova image-list | egrep "$DEFAULT_IMAGE_NAME"'[^-]' | awk '{ print $2 }')

# create keypair
ssh-keygen
nova keypair-add default --pub-key ~/.ssh/id_rsa.pub

# spawn instance
nova boot --flavor baremetal --image $image --key-name default testing

Note

Because devstack create multiple networks, we need to pass an additional parameter --nic net-id to the nova boot command when using the admin account, for example:

net_id=$(neutron net-list | egrep "$PRIVATE_NETWORK_NAME"'[^-]' | awk '{ print $2 }')

nova boot --flavor baremetal --nic net-id=$net_id --image $image --key-name default testing

As the demo tenant, you should now see a Nova instance building:

nova list
+--------------------------------------+---------+--------+------------+-------------+----------+
| ID                                   | Name    | Status | Task State | Power State | Networks |
+--------------------------------------+---------+--------+------------+-------------+----------+
| a2c7f812-e386-4a22-b393-fe1802abd56e | testing | BUILD  | spawning   | NOSTATE     |          |
+--------------------------------------+---------+--------+------------+-------------+----------+

Nova will be interfacing with Ironic conductor to spawn the node. On the Ironic side, you should see an Ironic node associated with this Nova instance. It should be powered on and in a 'wait call-back' provisioning state:

# Note that 'ironic' calls must be made with admin credentials
. ~/devstack/openrc admin admin
ironic node-list
+--------------------------------------+--------------------------------------+-------------+--------------------+
| UUID                                 | Instance UUID                        | Power State | Provisioning State |
+--------------------------------------+--------------------------------------+-------------+--------------------+
| 9e592cbe-e492-4e4f-bf8f-4c9e0ad1868f | None                                 | power off   | None               |
| ec0c6384-cc3a-4edf-b7db-abde1998be96 | None                                 | power off   | None               |
| 4099e31c-576c-48f8-b460-75e1b14e497f | a2c7f812-e386-4a22-b393-fe1802abd56e | power on    | wait call-back     |
+--------------------------------------+--------------------------------------+-------------+--------------------+

At this point, Ironic conductor has called to libvirt via SSH to power on a virtual machine, which will PXE + TFTP boot from the conductor node and progress through the Ironic provisioning workflow. One libvirt domain should be active now:

sudo virsh list --all
 Id    Name                           State
----------------------------------------------------
 2     baremetalbrbm_2                running
 -     baremetalbrbm_0                shut off
 -     baremetalbrbm_1                shut off

This provisioning process may take some time depending on the performance of the host system, but Ironic should eventually show the node as having an 'active' provisioning state:

ironic node-list
+--------------------------------------+--------------------------------------+-------------+--------------------+
| UUID                                 | Instance UUID                        | Power State | Provisioning State |
+--------------------------------------+--------------------------------------+-------------+--------------------+
| 9e592cbe-e492-4e4f-bf8f-4c9e0ad1868f | None                                 | power off   | None               |
| ec0c6384-cc3a-4edf-b7db-abde1998be96 | None                                 | power off   | None               |
| 4099e31c-576c-48f8-b460-75e1b14e497f | a2c7f812-e386-4a22-b393-fe1802abd56e | power on    | active             |
+--------------------------------------+--------------------------------------+-------------+--------------------+

This should also be reflected in the Nova instance state, which at this point should be ACTIVE, Running and an associated private IP:

# Note that 'nova' calls must be made with the credentials of the demo tenant
. ~/devstack/openrc demo demo
nova list
+--------------------------------------+---------+--------+------------+-------------+------------------+
| ID                                   | Name    | Status | Task State | Power State | Networks         |
+--------------------------------------+---------+--------+------------+-------------+------------------+
| a2c7f812-e386-4a22-b393-fe1802abd56e | testing | ACTIVE | -          | Running     | private=10.1.0.4 |
+--------------------------------------+---------+--------+------------+-------------+------------------+

The server should now be accessible via SSH:

ssh cirros@10.1.0.4
$

Building developer documentation

If you would like to build the documentation locally, eg. to test your documentation changes before uploading them for review, run these commands to build the documentation set:

# activate your development virtualenv
source .tox/venv/bin/activate

# build the docs
tox -edocs

Now use your browser to open the top-level index.html located at:

ironic/doc/build/html/index.html