TripleO Components

TripleO Components

This section contains a list of components that TripleO uses. The components are organized in categories, and include a basic description, useful links, and contribution information.

Shared Libraries

diskimage-builder

diskimage-builder is an image building tool. It is used by openstack overcloud image build.

How to contribute

See the diskimage-builder README.rst for a further explanation of the tooling. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).

Useful links

dib-utils

dib-utils contains tools that are used by diskimage-builder.

How to contribute

Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).

Useful links

os-*-config

The os-*-config projects are a suite of tools used to configure instances deployed via TripleO. They include:

  • os-collect-config

  • os-refresh-config

  • os-apply-config

  • os-net-config

How to contribute

Each tool uses tox to manage the development environment. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).

Useful links

tripleo-image-elements

tripleo-image-elements is a repository of diskimage-builder style elements used for installing various software components.

How to contribute

Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).

Useful links

Installer

instack

instack executes diskimage-builder style elements on the current system. This enables a current running system to have an element applied in the same way that diskimage-builder applies the element to an image build.

instack, in its current form, should be considered low level tooling. It is meant to be used by higher level scripting that understands what elements and hook scripts need execution. Using instack requires a rather in depth knowledge of the elements within diskimage-builder and tripleo-image-elements.

How to contribute

Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).

Useful links

instack-undercloud

instack-undercloud is a TripleO style undercloud installer based around instack.

How to contribute

Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).

Useful links

tripleo-incubator

tripleo-incubator contains various scripts to aid in deploying a TripleO cloud.

How to contribute

Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).

Useful links

Node Management

ironic

Ironic project is responsible for provisioning and managing bare metal instances.

For testing purposes Ironic can also be used for provisioning and managing virtual machines which act as bare metal nodes via special driver pxe_ssh.

How to contribute

Ironic uses tox to manage the development environment, see the Developer Quick-Start, Ironic Developer Guidelines and OpenStack Developer’s Guide for details.

Useful links

ironic inspector (former ironic-discoverd)

Ironic Inspector project is responsible for inspection of hardware properties for newly enrolled nodes (see also ironic).

How to contribute

Ironic Inspector uses tox to manage the development environment, see upstream documentation for details.

Useful links

VirtualBMC

A helper command to translate IPMI calls into libvirt calls. Used for testing bare metal provisioning on virtual environments.

How to contribute

VirtualBMC uses tox to manage the development environment in a similar way to Ironic.

Useful links

Deployment & Orchestration

heat

Heat is OpenStack’s orchestration tool. It reads YAML files describing the OpenStack deployment’s resources (machines, their configurations etc.) and gets those resources into the desired state, often by talking to other components (e.g. Nova).

How to contribute

Useful links

heat-templates

The heat-templates repository contains additional image elements for producing disk images ready to be configured by Puppet via Heat.

How to contribute

Useful links

tripleo-heat-templates

The tripleo-heat-templates describe the OpenStack deployment in Heat Orchestration Template YAML files and Puppet manifests. The templates are deployed via Heat.

How to contribute

Useful links

nova

nova provides a cloud computing fabric controller.

How to contribute

Useful links

puppet-*

The OpenStack Puppet modules are used to configure the OpenStack deployment (write configuration, start services etc.). They are used via the tripleo-heat-templates.

How to contribute

Useful links

tripleo-puppet-elements

The tripleo-puppet-elements describe the contents of disk images which TripleO uses to deploy OpenStack. It’s the same kind of elements as in tripleo-image-elements, but tripleo-puppet-elements are specific for Puppet-enabled images.

How to contribute

Useful links

User Interfaces

python-openstackclient

The python-openstackclient is an upstream CLI tool which can manage multiple openstack services. It wraps openstack clients like glance, nova, etc. and maps them under intuitive names like openstack image, compute, etc.

The main value is that all services can be controlled by a single (openstack) command with consistent syntax and behaviour.

How to contribute

Useful links

python-tripleoclient

The python-tripleoclient is a CLI tool embedded into python-openstackclient. It provides functions related to instack installation and initial configuration like node introspection, overcloud image building and uploading, etc.

How to contribute

Useful links

tripleo-ui

TripleO UI is the web interface for TripleO.

How to contribute

Useful links

tripleo-validations

Pre and post-deployment validations for the deployment workflow.

Useful links

Note

When reporting an issue, make sure you add the validations tag.

Deprecated

Tuskar

The Tuskar project was responsible for planning the deployments and generating the corresponding Heat templates. This is no longer necessary as Heat supports this composability out of the box.

The source code is available below, but please note that it should not be used for new deployments.

https://github.com/openstack/tuskar

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.