Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Puppet Labs Reference and Testing Deployment Module for OpenStack (master tracks Kilo)
Puppet Ruby Shell Python HTML

Merge pull request #215 from cmurphy/docs

Add a getting help guide
latest commit 969d8b6bd1
@EmilienM EmilienM authored


Puppet Labs Reference and Testing Deployment Module for OpenStack.

Version 5.0 / 2014.2 / Juno

Table of Contents

  1. Overview - What is the puppetlabs-openstack module?
  2. A Note on Versioning
  3. Module Description - What does the module do?
  4. Setup - The basics of getting started with OpenStack
  5. Usage - Configuration and customization options
  6. Reference - An under-the-hood peek at what the module is doing
  7. Limitations - OS compatibility, etc.
  8. License


The puppetlabs-openstack module is used to deploy a multi-node, all-in-one, or swift-only installation of OpenStack Juno.

Getting Help

If you need help configuring your puppet master or your puppet agents, or any help understanding puppet or hiera, please review puppet's guide to getting help.

If your puppet ran successfully but OpenStack is not working as expected, please visit OpenStack's getting started guide to find help operating OpenStack.

If puppet did not run successfully, examine what resources failed the puppet run. Please keep in mind that this module is a thin wrapper around the OpenStack Puppet Modules, so problems that arise are often due to bugs in the main modules rather than this one. If you are having trouble with one of the OpenStack Puppet Modules, first check these resources for getting help, and if necessary file a bug for the particular module. If you believe the problem is in the puppetlabs-openstack module, file an issue with the Puppet Labs ticket tracker.

Similarly, if after seeking help from OpenStack's getting started guide you believe puppet has caused a misconfiguration, file a launchpad bug for the particular module causing the issue or for the puppetlabs-openstack module.


This module has been given version 4 to track the puppet-openstack modules. The versioning for the puppet-openstack modules are as follows:

Puppet Module :: OpenStack Version :: OpenStack Codename
2.0.0         -> 2013.1.0          -> Grizzly
3.0.0         -> 2013.2.0          -> Havana
4.0.0         -> 2014.1.0          -> Icehouse
5.0.0         -> 2014.2.0          -> Juno

Module Description

Using the stable/juno branch of the puppet-openstack modules, puppetlabs-openstack allows for the rapid deployment of an installation of OpenStack Juno. For the multi-node, up to six types of nodes are created for the deployment:

  • A controller node that hosts databases, message queues and caches, and most api services.
  • A storage node that hosts volumes, image storage, and the image storage api.
  • A network node that performs L2 routing, L3 routing, and DHCP services.
  • A compute node to run guest operating systems.
  • Optional object storage nodes to host an object/blob store.
  • An optional Tempest node to test your deployment.

The all-in-one deployment sets up all of the services except for Swift on a single node, including the Tempest testing.

The Swift deployment sets up:

  • A controller node that hosts databases, message queues and caches, and the Swift API.
  • Three storage nodes in different Swift Zones.


Setup Requirements

This module assumes nodes running on a RedHat 7 variant (RHEL, CentOS, or Scientific Linux) or Ubuntu 14.04 (Trusty) with either Puppet Enterprise or Puppet.

Each node needs a minimum of two network interfaces, and up to four. The network interfaces are divided into two groups.

  • Public interfaces:
    • API network.
    • External network.
  • Internal interfaces:
    • Management network.
    • Data network.

This module have been tested with Puppet 3.5 and Puppet Enterprise. This module depends upon Hiera. Object store support (Swift) depends upon exported resources and PuppetDB.

Beginning with OpenStack

To begin, you will need to do some basic setup on the compute node. SElinux needs to be disabled on the compute nodes to give OpenStack full control over the KVM hypervisor and other necessary services. This is the only node that SELinux needs to be disabled on.

Additionally, you need to know the network address ranges for all four of the public/private networks, and the specific ip addresses of the controller node and the storage node. Keep in mind that your public networks can overlap with one another, as can the private networks.

The examples directory contains Vagrantfiles with CentOS 7 boxes to test out all-in-one, multi-node, or swift-only deployments.


Hiera Configuration

The first step to using the puppetlabs-openstack module is to configure hiera with settings specific to your installation. In this module, the example directory contains sample common.yaml (for multi-node) and allinone.yaml (for all-in-one) files with all of the settings required by this module, as well as an example user and networks to test your deployment with. These configuration options include network settings, locations of specific nodes, and passwords for Keystone and databases. If any of these settings are undefined or not properly set, your deployment may fail.

Controller Node

For your controller node, you need to assign your node the controller role. For example:

node 'control.localdomain' {
  include ::openstack::role::controller

It's important to apply this configuration to the controller node before any of the other nodes are applied. The other nodes depend upon the service and database setup in the controller node.

Other Nodes

For the remainder nodes, there are roles to assign for each. For example:

node 'storage.localdomain' {
  include ::openstack::role::storage

node 'network.localdomain' {
  include ::openstack::role::network

node /compute[0-9]+.localdomain/ {
  include ::openstack::role::compute

For this deployment, it's assumed that there is only one storage node and one network node. There may be multiple compute nodes.

After applying the configuration to the controller node, apply the remaining configurations to the worker nodes.

You will need to reboot all of the nodes after installation to ensure that the kernel module that provides network namespaces, required by Open VSwitch, is loaded.

Object Store Nodes

Begin by setting up PuppetDB. The easiest way to do this is to use the module provided by Puppet Labs. The module only needs to be installed on the master. See the puppet node configuration in the multinode or swift site.pp.

You will need to create three nodes as object stores for Swift, assigning three zones:

node /swift[0-9]+zone1.localdomain/ {
  class { '::openstack::role::swiftstorage':
    zone => '1',

node /swift[0-9]+zone2.localdomain/ {
  class { '::openstack::role::swiftstorage':
    zone => '2',

node /swift[0-9]+zone3.localdomain/ {
  class { '::openstack::role::swiftstorage':
    zone => '3',

Because of the use of exported resources, puppet will need multiple runs to converge. First run the Puppet Agent on all of the Swift nodes, which will build out the basic storage and store the exported resource information in PuppetDB. Then run the agent on the control node, which will build out the ring files required by Swift. Finally, run Puppet against the Swift storage nodes again to copy the ring files over and successfully start the Swift services.


The puppetlabs-openstack module is built on the 'Roles and Profiles' pattern. Every node in a deployment is assigned a single role. Every role is composed of some number of profiles, which ideally should be independent of one another, allowing for composition of new roles. The puppetlabs-openstack module does not strictly adhere to this pattern, but should serve as a useful example of how to build profiles from modules for customized and maintainable OpenStack deployments.


  • High availability and SSL-enabled endpoints are not provided by this module.


Puppet Labs OpenStack - A Puppet Module for a Multi-Node OpenStack Juno Installation.

Copyright (C) 2013, 2014 Puppet Labs, Inc. and Authors

Original Author - Christian Hoge

Puppet Labs can be contacted at:

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
Something went wrong with that request. Please try again.