Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
OpenStack Cinder Puppet Module

Merge "added HP 3par iscsi backend module"

latest commit 1b8f8a5138
Jenkins authored openstack-gerrit committed


5.0.0 - 2014.2.0 - Juno

Table of Contents

  1. Overview - What is the cinder module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with cinder
  4. Implementation - An under-the-hood peek at what the module is doing
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. Contributors - Those with commits
  8. Release Notes - Notes on the most recent updates to the module


The cinder module is a part of Stackforge, an effort by the Openstack infrastructure team to provide continuous integration testing and code review for Openstack and Openstack community projects not part of the core software. The module its self is used to flexibly configure and manage the block storage service for Openstack.

Module Description

The cinder module is a thorough attempt to make Puppet capable of managing the entirety of cinder. This includes manifests to provision such things as keystone endpoints, RPC configurations specific to cinder, and database connections. Types are shipped as part of the cinder module to assist in manipulation of configuration files.

This module is tested in combination with other modules needed to build and leverage an entire Openstack software stack. These modules can be found, all pulled together in the openstack module.


What the cinder module affects

  • cinder, the block storage service for Openstack.

Installing cinder

puppet module install puppetlabs/cinder

Beginning with cinder

To utilize the cinder module's functionality you will need to declare multiple resources. The following is a modified excerpt from the openstack module. This is not an exhaustive list of all the components needed, we recommend you consult and understand the openstack module and the core openstack documentation.

Define a cinder control node

class { 'cinder':
  database_connection     => 'mysql://',
  rabbit_password         => 'secret_rpc_password_for_blocks',
  rabbit_host             => '',
  verbose                 => true,

class { 'cinder::api':
  keystone_password       => $keystone_password,
  keystone_enabled        => $keystone_enabled,
  keystone_user           => $keystone_user,
  keystone_auth_host      => $keystone_auth_host,
  keystone_auth_port      => $keystone_auth_port,
  keystone_auth_protocol  => $keystone_auth_protocol,
  service_port            => $keystone_service_port,
  package_ensure          => $cinder_api_package_ensure,
  bind_host               => $cinder_bind_host,
  enabled                 => $cinder_api_enabled,

class { 'cinder::scheduler':
  scheduler_driver => 'cinder.scheduler.simple.SimpleScheduler',

Define a cinder storage node

class { 'cinder':
  database_connection     => 'mysql://',
  rabbit_password         => 'secret_rpc_password_for_blocks',
  rabbit_host             => '',
  verbose                 => true,

class { 'cinder::volume': }

class { 'cinder::volume::iscsi':
  iscsi_ip_address => '',

*Define a cinder storage node with multiple backends *

class { 'cinder':
  database_connection     => 'mysql://',
  rabbit_password         => 'secret_rpc_password_for_blocks',
  rabbit_host             => '',
  verbose                 => true,

class { 'cinder::volume': }

cinder::backend::iscsi {'iscsi1':
  iscsi_ip_address => '',

cinder::backend::iscsi {'iscsi2':
  iscsi_ip_address => '',

cinder::backend::iscsi {'iscsi3':
  iscsi_ip_address    => '',
  volume_backend_name => 'iscsi',

cinder::backend::iscsi {'iscsi4':
  iscsi_ip_address    => '',
  volume_backend_name => 'iscsi',

cinder::backend::rbd {'rbd-images':
  rbd_pool => 'images',
  rbd_user => 'images',

# Cinder::Type requires keystone credentials
Cinder::Type {
  os_password     => 'admin',
  os_tenant_name  => 'admin',
  os_username     => 'admin',
  os_auth_url     => '',

cinder::type {'iscsi':
  set_key   => 'volume_backend_name',
  set_value => ['iscsi1', 'iscsi2', 'iscsi']

cinder::type {'rbd':
  set_key   => 'volume_backend_name',
  set_value => 'rbd-images',

class { 'cinder::backends':
  enabled_backends => ['iscsi1', 'iscsi2', 'rbd-images']

Note: that the name passed to any backend resource must be unique accross all backends otherwise a duplicate resource will be defined.

** Using type and type_set **

Cinder allows for the usage of type to set extended information that can be used for various reasons. We have resource provider for type and type_set Since types are rarely defined with out also setting attributes with it, the resource for type can also call type_set if you pass set_key and set_value



cinder is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.


  • Setup of storage nodes is limited to Linux and LVM, i.e. Puppet won't configure a Nexenta appliance but nova can be configured to use the Nexenta driver with Class['cinder::volume::nexenta'].


Developer documentation for the entire puppet-openstack project.


Release Notes


  • Stable Juno release
  • Added class to manage policy.json
  • Changed the default value of the san_thin_provision parameter for eqlx
  • Added database tuning parameters
  • Made keystone user creation optional when creating a service
  • Added ability to hide secrets from logs
  • Added parameters for netapp and and cinder-api workers
  • Corrected the package name for cinder backup
  • Added support for the EMC VNX direct driver
  • Migrated the mysql backend to use openstacklib::db::mysql
  • Added support for availability zones


  • Added parameters to set cinder volume driver
  • Added class for extended logging options
  • Added option to specify endpoint protocol
  • Fixed cinder type path issues
  • Added option to specify cinder volume path
  • Fixed targetcli package dependency on target service
  • Fixed os version fact comparison for RedHat-based operating systems for specifying service provider
  • Added option to configure os_region_name in the cinder config


  • Added Cinder v2 endpoint support.
  • Added SSL support for Cinder API.
  • Added RabbitMQ SSL support.
  • Moved default_volume_type to cinder::api
  • Removed warnings for existing Cinder volumes.
  • Pinned major gems.


  • Stable Icehouse release.
  • Updated NetApp unified driver config options.
  • Updated support for latest RabbitMQ module.
  • Added Glance support.
  • Added GlusterFS driver support.
  • Added region support.
  • Added support for MySQL module (>= 2.2).
  • Added support for Swift and Ceph backup backend.
  • Added cinder::config to handle additional custom options.
  • Refactored duplicate code for single and multiple backends.
  • Removed control exchange flag.
  • Removed deprecated cinder::base class.


  • Fixed resource duplication bug.


  • Added default_volume_type as a Cinder API parameter.
  • Added parameter for endpoint procols.
  • Deprecated glance_api_version.
  • Added support for VMDK.
  • Added support for Cinder multi backend.
  • Added support for https authentication endpoints.
  • Replaced pip with native package manager (VMDK).


  • Major release for OpenStack Havana.
  • Added support for SolidFire.
  • Added support for ceilometer.
  • Fixed bug for cinder-volume requirement.


  • Added support for rate limiting via api-paste.ini
  • Added support to configure control_exchange.
  • Added parameter check to enable or disable db_sync.
  • Added syslog support.
  • Added default auth_uri setting for auth token.
  • Set package defaults to present.
  • Fixed a bug to create empty init script when necessary.
  • Various lint fixes.


  • Added configuration of Cinder quotas.
  • Added support for NetApp direct driver backend.
  • Added support for ceph backend.
  • Added support for SQL idle timeout.
  • Added support for RabbitMQ clustering with single IP.
  • Fixed allowed_hosts/database connection bug.
  • Fixed lvm2 setup failure for Ubuntu.
  • Removed unnecessary mysql::server dependency.
  • Pinned RabbitMQ and database module versions.
  • Various lint and bug fixes.


  • Upstream is now part of stackfoge.
  • Nexenta, NFS, and SAN support added as cinder volume drivers.
  • Postgres support added.
  • The Apache Qpid and the RabbitMQ message brokers available as RPC backends.
  • Configurability of scheduler_driver.
  • Various cleanups and bug fixes.
Something went wrong with that request. Please try again.