Basic Deployment (CLI)¶

Prepare Your Environment¶

1. Make sure you have your environment ready and undercloud running:

   • Environment Setup
   • Installing the Undercloud

2. Log into your undercloud (instack) virtual machine as non-root user:

   ssh root@<undercloud-machine>
   
   su - stack
   

3. In order to use CLI commands easily you need to source needed environment variables:

   source stackrc
   

Get Images¶

ironic-python-agent.initramfs
ironic-python-agent.kernel
overcloud-full.initrd
overcloud-full.qcow2
overcloud-full.vmlinuz

Images must be built prior to doing a deployment. An IPA ramdisk and openstack-full image can all be built using tripleo-common.

It’s recommended to build images on the installed undercloud directly since all the dependencies are already present, but this is not a requirement.

The following steps can be used to build images. They should be run as the same non-root user that was used to install the undercloud. If the images are not created on the undercloud, one should use a non-root user.

1. Choose image operating system:

   CentOS

   The image build with no arguments will build CentOS 7. It will include the common YAML of /usr/share/openstack-tripleo-common/image-yaml/overcloud-images.yaml and the CentOS YAML at /usr/share/openstack-tripleo-common/image-yaml/overcloud-images-centos7.yaml.

   RHEL

   The common YAML is /usr/share/openstack-tripleo-common/image-yaml/overcloud-images.yaml. It must be specified along with the following.

   The default YAML for RHEL is /usr/share/openstack-tripleo-common/image-yaml/overcloud-images-rhel7.yaml

   export OS_YAML="/usr/share/openstack-tripleo-common/image-yaml/overcloud-images/rhel7.yaml"
   

2. Install the current-tripleo delorean repository and deps repository:

Stable Branch

Enable the appropriate repos for the desired release, as indicated below. Do not enable any other repos not explicitly marked for that release.

Newton

Enable latest RDO Newton Delorean repository for all packages

sudo curl -L -o /etc/yum.repos.d/delorean-newton.repo https://trunk.rdoproject.org/centos7-newton/current/delorean.repo

Enable the Newton Delorean Deps repository

sudo curl -L -o /etc/yum.repos.d/delorean-deps-newton.repo https://trunk.rdoproject.org/centos7-newton/delorean-deps.repo

Ceph

Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph

sudo yum -y install --enablerepo=extras centos-release-ceph-jewel
sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo

Ocata

Enable latest RDO Ocata Delorean repository for all packages

sudo curl -L -o /etc/yum.repos.d/delorean-ocata.repo https://trunk.rdoproject.org/centos7-ocata/current/delorean.repo

Enable the Ocata Delorean Deps repository

sudo curl -L -o /etc/yum.repos.d/delorean-deps-ocata.repo https://trunk.rdoproject.org/centos7-ocata/delorean-deps.repo

Ceph

Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph

sudo yum -y install --enablerepo=extras centos-release-ceph-jewel
sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo

Enable last known good RDO Trunk Delorean repository for core openstack packages

sudo curl -L -o /etc/yum.repos.d/delorean.repo https://trunk.rdoproject.org/centos7-master/current-passed-ci/delorean.repo

Enable latest RDO Trunk Delorean repository only for the TripleO packages

sudo curl -L -o /etc/yum.repos.d/delorean-current.repo https://trunk.rdoproject.org/centos7/current/delorean.repo
sudo sed -i 's/\[delorean\]/\[delorean-current\]/' /etc/yum.repos.d/delorean-current.repo
sudo /bin/bash -c "cat <<EOF>>/etc/yum.repos.d/delorean-current.repo

includepkgs=diskimage-builder,instack,instack-undercloud,os-apply-config,os-collect-config,os-net-config,os-refresh-config,python-tripleoclient,openstack-tripleo-common*,openstack-tripleo-heat-templates,openstack-tripleo-image-elements,openstack-tripleo,openstack-tripleo-puppet-elements,openstack-puppet-modules,openstack-tripleo-ui,puppet-*
EOF"

Enable the Delorean Deps repository

sudo curl -L -o /etc/yum.repos.d/delorean-deps.repo https://trunk.rdoproject.org/centos7/delorean-deps.repo

Ceph

Enable the CentOS Storage SIG Ceph/Jewel repository if using Ceph

sudo yum -y install --enablerepo=extras centos-release-ceph-jewel
sudo sed -i -e 's%gpgcheck=.*%gpgcheck=0%' /etc/yum.repos.d/CentOS-Ceph-Jewel.repo

3. Export environment variables

   export DIB_YUM_REPO_CONF="/etc/yum.repos.d/delorean*"
   

   Ceph

   export DIB_YUM_REPO_CONF="$DIB_YUM_REPO_CONF /etc/yum.repos.d/CentOS-Ceph-Jewel.repo"
   

   Stable Branch

   Newton

   export STABLE_RELEASE="newton"
   

   Ceph

   export DIB_YUM_REPO_CONF="$DIB_YUM_REPO_CONF /etc/yum.repos.d/CentOS-Ceph-Jewel.repo"
   

   Ocata

   export STABLE_RELEASE="ocata"
   

   Ceph

   export DIB_YUM_REPO_CONF="$DIB_YUM_REPO_CONF /etc/yum.repos.d/CentOS-Ceph-Jewel.repo"
   

4. Build the required images:

RHEL

Download the RHEL 7.3 cloud image or copy it over from a different location, for example: https://access.redhat.com/downloads/content/69/ver=/rhel---7/7.3/x86_64/product-downloads, and define the needed environment variables for RHEL 7.3 prior to running tripleo-build-images:

export DIB_LOCAL_IMAGE=rhel-guest-image-7.3-35.x86_64.qcow2

RHEL Portal Registration

To register the image builds to the Red Hat Portal define the following variables:

export REG_METHOD=portal
export REG_USER="[your username]"
export REG_PASSWORD="[your password]"
# Find this with `sudo subscription-manager list --available`
export REG_POOL_ID="[pool id]"
export REG_REPOS="rhel-7-server-rpms rhel-7-server-extras-rpms rhel-ha-for-rhel-7-server-rpms \
    rhel-7-server-optional-rpms rhel-7-server-openstack-6.0-rpms"

Ceph

If using Ceph, additional channels need to be added to REG_REPOS. Enable the appropriate channels for the desired release, as indicated below. Do not enable any other channels not explicitly marked for that release.

rhel-7-server-rhceph-2-mon-rpms
rhel-7-server-rhceph-2-osd-rpms
rhel-7-server-rhceph-2-tools-rpms

RHEL Satellite Registration

To register the image builds to a Satellite define the following variables. Only using an activation key is supported when registering to Satellite, username/password is not supported for security reasons. The activation key must enable the repos shown:

export REG_METHOD=satellite
# REG_SAT_URL should be in the format of:
# http://<satellite-hostname>
export REG_SAT_URL="[satellite url]"
export REG_ORG="[satellite org]"
# Activation key must enable these repos:
# rhel-7-server-rpms
# rhel-7-server-optional-rpms
# rhel-7-server-extras-rpms
# rhel-7-server-openstack-6.0-rpms
# rhel-7-server-rhceph-{2,1.3}-mon-rpms
# rhel-7-server-rhceph-{2,1.3}-osd-rpms
# rhel-7-server-rhceph-{2,1.3}-tools-rpms
export REG_ACTIVATION_KEY="[activation key]"

Source

Git checkouts of the puppet modules can be used instead of packages. Export the following environment variable:

export DIB_INSTALLTYPE_puppet_modules=source

It is also possible to use this functionality to use an in-progress review as part of the overcloud image build. See Using an In-Progress Review for details.

openstack overcloud image build

RHEL

openstack overcloud image build --config-file /usr/share/openstack-tripleo-common/image-yaml/overcloud-images.yaml --config-file $OS_YAML

See the help for openstack overcloud image build for further options.

The YAML files are cumulative. Order on the command line is important. The packages, elements, and options sections will append. All others will overwrite previously read values.

Note

This command will build overcloud-full images (*.qcow2, *.initrd, *.vmlinuz) and ironic-python-agent images (*.initramfs, *.kernel)

In order to build specific images, one can use the --image-name flag to openstack overcloud image build. It can be specified multiple times.

Upload Images¶

Load the images into the undercloud Glance:

openstack overcloud image upload

To upload a single image, see Uploading a Single Image.

Register Nodes¶

Register and configure nodes for your deployment with Ironic:

openstack overcloud node import instackenv.json

The file to be imported may be either JSON, YAML or CSV format, and the type is detected via the file extension (json, yaml, csv). The file format is documented in instackenv.json.

The nodes status will be set to manageable by default, so that introspection may later be run. To also run introspection and make the nodes available for deployment in one step, the following flags can be used:

openstack overcloud node import --introspect --provide instackenv.json

Starting with the Newton release you can take advantage of the enroll provisioning state - see Bare Metal Node States for details.

If your hardware has several hard drives, it’s highly recommended that you specify the exact device to be used during introspection and deployment as a root device. Please see Setting the Root Device for Deployment for details.

Introspect Nodes¶

openstack workflow execution create tripleo.validations.v1.run_groups '{"group_names": ["pre-introspection"]}'

Nodes must be in the manageable provisioning state in order to run introspection. Introspect hardware attributes of nodes with:

openstack overcloud node introspect --all-manageable

Nodes can also be specified individually by UUID. The --provide flag can be used in order to move the nodes automatically to the available provisioning state once the introspection is finished, making the nodes available for deployment.

openstack overcloud node introspect --all-manageable --provide

Provide Nodes¶

Only nodes in the available provisioning state can be deployed to (see Bare Metal Node States for details). To move nodes from manageable to available the following command can be used:

openstack overcloud node provide --all-manageable

Flavor Details¶

The undercloud will have a number of default flavors created at install time. In most cases these flavors do not need to be modified, but they can be if desired. By default, all overcloud instances will be booted with the baremetal flavor, so all baremetal nodes must have at least as much memory, disk, and cpu as that flavor.

In addition, there are profile-specific flavors created which can be used with the profile-matching feature. For more details on deploying with profiles, see Advanced Profile Matching.

Configure a nameserver for the Overcloud¶

Overcloud nodes can have a nameserver configured in order to resolve hostnames via DNS. The nameserver is defined in the undercloud’s neutron subnet. If needed, define the nameserver to be used for the environment:

# List the available subnets
openstack subnet list
openstack subnet set <subnet-uuid> --dns-nameserver <nameserver-ip>

Deploy the Overcloud¶

openstack workflow execution create tripleo.validations.v1.run_groups '{"group_names": ["pre-deployment"]}'

By default 1 compute and 1 control node will be deployed, with networking configured for the virtual environment. To customize this, see the output of:

openstack help overcloud deploy

-e /usr/share/openstack-tripleo-heat-templates/environments/enable-swap-partition.yaml
-e /usr/share/openstack-tripleo-heat-templates/environments/enable-swap.yaml

--ceph-storage-scale <number of nodes> -e /usr/share/openstack-tripleo-heat-templates/environments/storage-environment.yaml

-e /usr/share/openstack-tripleo-heat-templates/environments/hyperconverged-ceph.yaml -e /usr/share/openstack-tripleo-heat-templates/environments/storage-environment.yaml

--rhel-reg --reg-method satellite --reg-org <ORG ID#> --reg-sat-url <satellite URL> --reg-activation-key <KEY>

Run the deploy command, including any additional parameters as necessary:

openstack overcloud deploy --templates [additional parameters]

To deploy an overcloud with multiple controllers and achieve HA, follow Configuring High Availability.

Post-Deployment¶

openstack workflow execution create tripleo.validations.v1.run_groups '{"group_names": ["post-deployment"]}'

source ~/overcloudrc

source ~/stackrc

openstack network create public --external --provider-network-type flat \
--provider-physical-network datacentre
openstack subnet create --allocation-pool start=172.16.23.140,end=172.16.23.240 \
--network public --gateway 172.16.23.251 --no-dhcp --subnet-range \
172.16.23.128/25 public

openstack network list

+--------------------------------------+----------+--------------------------------------+
| ID                                   | Name     | Subnets                              |
+--------------------------------------+----------+--------------------------------------+
| 4db8dd5d-fab5-4ea9-83e5-bdedbf3e9ee6 | public   | 7a315c5e-f8e2-495b-95e2-48af9442af01 |
+--------------------------------------+----------+--------------------------------------+

openstack network create public --external --provider-network-type vlan \
--provider-physical-network datacentre --provider-segment 195 \
openstack subnet create --allocation-pool start=172.16.23.140,end=172.16.23.240 \
--network public --no-dhcp --gateway 172.16.23.251 \
--subnet-range 172.16.23.128/25 public

source ~/overcloudrc

mkdir ~/tempest
cd ~/tempest

/usr/share/openstack-tempest-*/tools/configure-tempest-directory

tools/config_tempest.py --deployer-input ~/tempest-deployer-input.conf \
                        --debug --create \
                        identity.uri $OS_AUTH_URL \
                        identity.admin_password $OS_PASSWORD

tools/run-tests.sh