TripleO Components¶
Contents
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.
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
Git repository: https://opendev.org/openstack/instack
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
Git repository: https://opendev.org/openstack/instack-undercloud
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
Upstream Project: https://docs.openstack.org/ironic/index.html
Blueprints: https://blueprints.launchpad.net/ironic
Specs process should be followed for suggesting new features.
Approved Specs: http://specs.openstack.org/openstack/ironic-specs/
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
Use devstack with Heat to set up a development environment. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).
Useful links
Upstream Project: https://wiki.openstack.org/wiki/Heat
Blueprints: https://blueprints.launchpad.net/heat
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
Use devtest with Puppet to set up a development environment. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).
Useful links
Upstream Project: https://opendev.org/openstack/heat-templates
Blueprints: https://blueprints.launchpad.net/heat-templates
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
Use devtest with Puppet to set up a development environment. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).
Useful links
Upstream Project: https://opendev.org/openstack/tripleo-heat-templates
Blueprints: https://blueprints.launchpad.net/tripleo
nova¶
nova provides a cloud computing fabric controller.
How to contribute
Read the Development Quickstart to set up a development environment. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).
Useful links
Git repository: https://opendev.org/openstack/nova
Blueprints: https://blueprints.launchpad.net/nova
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
Use devtest with Puppet to set up a development environment. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).
Useful links
Upstream Project: https://wiki.openstack.org/wiki/Puppet
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
Use devtest with Puppet to set up a development environment. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).
Useful links
Upstream Project: https://opendev.org/openstack/tripleo-puppet-elements
Blueprints: https://blueprints.launchpad.net/tripleo
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
python-openstackclient uses tox to manage the development environment, see the python-openstackclient documentation for details. Submit your changes via OpenStack Gerrit (see OpenStack Developer’s Guide).
Useful links
Upstream Project: https://opendev.org/openstack/python-openstackclient
Blueprints: https://blueprints.launchpad.net/python-openstackclient
Human interface guide: https://docs.openstack.org/python-openstackclient/humaninterfaceguide.html
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
python-tripleoclient uses tox to manage the development environment, see the python-tripleoclient documentation for details. Submit your changes via Gerrit.
Useful links
tripleo-ui¶
TripleO UI is the web interface for TripleO.
How to contribute
See the documentation for details.
Useful links
tripleo-validations¶
Pre and post-deployment validations for the deployment workflow.
Useful links
Upstream Project: https://opendev.org/openstack/tripleo-validations/
Bugs: https://bugs.launchpad.net/tripleo/+bugs?field.tag=validations
Documentation for individual validations: https://docs.openstack.org/tripleo-validations/latest/readme.html#existing-validations
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.
