Team and repository tags

cinder

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 - Release notes for the project
9. Repository - The project source code repository

Overview

The cinder module is a part of OpenStack, an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects as 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.

Setup

What the cinder module affects

• Cinder, the block storage service for OpenStack.

Installing cinder

puppet module install openstack/cinder

Beginning with cinder

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

Define a cinder control node

class { 'cinder':
  database_connection   => 'mysql://cinder:secret_block_password@openstack-controller.example.com/cinder',
  default_transport_url => 'rabbit://cinder:secret_password@openstack-controller.example.com:5672',
}

class { 'cinder::api':
  keystone_password       => $keystone_password,
  keystone_user           => $keystone_user,
  keystone_auth_uri       => $keystone_auth_uri,
  service_port            => $keystone_service_port,
  package_ensure          => $cinder_api_package_ensure,
  bind_host               => $cinder_bind_host,
  enabled                 => $cinder_api_enabled,
}

class { 'cinder::scheduler': }

Define a cinder storage node

class { 'cinder':
  database_connection   => 'mysql://cinder:secret_block_password@openstack-controller.example.com/cinder',
  default_transport_url => 'rabbit://cinder:secret_password@openstack-controller.example.com:5672',
}

class { 'cinder::volume': }

cinder::backend::iscsi {
  'iscsi_example':
    target_ip_address => '10.0.0.2',
}

Define a cinder storage node with multiple backends

class { 'cinder':
  database_connection   => 'mysql://cinder:secret_block_password@openstack-controller.example.com/cinder',
  default_transport_url => 'rabbit://cinder:secret_password@openstack-controller.example.com:5672',
}

class { 'cinder::volume': }

cinder::backend::iscsi {'iscsi1':
  target_ip_address => '10.0.0.2',
}

cinder::backend::iscsi {'iscsi2':
  target_ip_address => '10.0.0.3',
}

cinder::backend::iscsi {'iscsi3':
  target_ip_address   => '10.0.0.4',
  volume_backend_name => 'iscsi',
}

cinder::backend::iscsi {'iscsi4':
  target_ip_address   => '10.0.0.5',
  volume_backend_name => 'iscsi',
}

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

cinder_type {'iscsi':
  ensure     => present,
  properties => ['volume_backend_name=iscsi,iscsi1,iscsi2'],
}

cinder_type {'rbd-images':
  ensure     => present,
  properties => ['volume_backend_name=rbd-images'],
}

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

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

Using cinder_type

Cinder allows for the usage of type to set extended information that can be used for various reasons. We have resource provider for cinder_type and if you want create some cinder type, you should set ensure to absent. Properties field is optional and should be an array. All items of array should match pattern key=value1[,value2 ...]. In case when you want to delete some type - set ensure to absent.

Implementation

cinder

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

Types

cinder_config

The cinder_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/cinder/cinder.conf file.

cinder_config { 'DEFAULT/api_paste_config' :
  value => '/etc/cinder/api-paste.ini',
}

This will write api_paste_config=/etc/cinder/api-paste.ini in the [DEFAULT] section.

name

Section/setting name to manage from cinder.conf

value

The value of the setting to be defined.

secret

Whether to hide the value from Puppet logs. Defaults to false.

ensure_absent_val

If value is equal to ensure_absent_val then the resource will behave as if ensure => absent was specified. Defaults to <SERVICE DEFAULT>

Limitations

• 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'].

Development

Developer documentation for the entire puppet-openstack project.

• https://docs.openstack.org/puppet-openstack-guide/latest/

Contributors

• https://github.com/openstack/puppet-cinder/graphs/contributors

Release Notes

• https://docs.openstack.org/releasenotes/puppet-cinder

Repository

• https://opendev.org/openstack/puppet-cinder

8.0.0 and beyond

From 8.0.0 release and beyond, release notes are published on docs.openstack.org.

##2015-11-25 - 7.0.0 ###Summary

This is a backwards-incompatible major release for OpenStack Liberty.

####Backwards-incompatible changes

• rabbitmq: do not manage rabbitmq service anymore
• remove deprecated mysql_module
• change section name for AMQP qpid parameters
• change section name for AMQP rabbit parameters

####Features

• make it possible to have multiple type_sets with the same value
• keystone/auth: make service description configurable
• add support for RabbitMQ connection heartbeat
• add tag to package and service resources
• sync cinder::db::sync with new standard
• set parameter host in vmdk backend
• add lock_path to cinder config
• add 'host' parameter to cinder.conf
• add an ability to manage use_stderr parameter
• reflect provider change in puppet-openstacklib
• introduce cinder::db class
• add support for Pure Volume Drivers
• implement class and defined type for cinder GPFS driver
• allow RBD host to be configurable
• add posibility to specify privileged user for Cinder
• switch cinder to use os_service_default
• simplify rpc_backend parameter
• put all the logging related parameters to the logging class
• specify a dedicated keystone user for cinderv2
• db: Use postgresql lib class for psycopg package
• add kombu_reconnect_delay parameter to cinder
• allow customization of db sync command line
• add possibility to use list of qpid hosts in cinder

####Bugfixes

• rely on autorequire for config resource ordering
• dont run losetup if it's been done already
• don't run vgcreate if vg exists
• make sure cinder user is created before creating Cinder::Type
• type: Add retry to Exec resource

####Maintenance

• fix rspec 3.x syntax
• initial msync run for all Puppet OpenStack modules
• acceptance: enable debug & verbosity for OpenStack logs
• try to use zuul-cloner to prepare fixtures
• remove class_parameter_defaults puppet-lint check
• add test coverage for cinder::db::mysql
• acceptance: use common bits from puppet-openstack-integration

##2015-10-10 - 6.1.0 ###Summary

This is a feature and bugfix release in the Kilo series.

####Features

• Add ability to search nova in the service catalog
• DB purge cron job

####Bugfixes

• Update default notification_driver for ceilometer

####Maintenance

• acceptance: checkout stable/kilo puppet modules

##2015-07-08 - 6.0.0 ###Summary

This is a backwards-incompatible major release for OpenStack Kilo.

####Backwards-incompatible changes

• Iscsi: Change default $volume_driver
• Switch to TLSv1 as SSLv3 is considered insecure and is disabled by default
• Remove POSIX users, groups, and file modes
• Move rabbit/kombu settings to oslo_messaging_rabbit section
• Also removed deprecated parameters

####Features

• Puppet 4.x support
• Refactorise Keystone resources management
• Add an option to not configure RabbitMQ service
• Run db_sync when upgrading packages
• Makes kombussl* parameters optional when rabbit_use_ssl => true
• Adds ability to override service name for service catalog
• Support the enable_v*_api settings
• Support iSER driver within the ISCSITarget flow
• ISCSI: Allow one to specify volumes_dir path
• Backends: Add an extra_options door
• Support identity_uri and auth_uri properly
• Make scheduler_driver option can be cleaned up
• Tag all Cinder packages
• Adds OracleLinux support
• Create a sync_db boolean for Cinder
• Update NetApp params for Kilo
• Add nfs_mount_options variable when backend is NetApp
• Add support for NFS Backup
• Decouple $sync_db from $enabled
• Add backup compression parameter
• Introduce public_url, internal_url and admin_url
• Added support for DellStorageCenter ISCSI cinder driver
• Add cinder::scheduler::filter for managing scheduler.filter
• NetApp: use $name for configuration group name (allows to run multiple NetApp backends)
• Lint documentation parameters
• HP 3par iscsi backend module
• MySQL: change default MySQL collate to utf8_general_ci

####Bugfixes

• Fix db_sync dependencies

####Maintenance

• Acceptance tests with Beaker
• Fix spec tests for RSpec 3.x and Puppet 4.x

##2015-06-17 - 5.1.0 ###Summary

This is a feature and bugfix release in the Juno series.

####Features

• Service Validation for Cinder-API
• Automate generation of NFS config file
• Make kombussl* parameters optional when rabbit_use_ssl => true
• Switch to TLSv1
• Add nfs_mount_options variable when backend is NetApp
• Add configuration helpers for Quobyte
• Implement HP 3par iscsi backend module

####Bugfixes

• Switch to using the new SolidFire driver name
• Create type-key only if it doesn't exist
• use lioadm on Fedora
• Change default MySQL collate to utf8_general_ci

####Maintenance

• spec: pin rspec-puppet to 1.0.1
• Pin puppetlabs-concat to 1.2.1 in fixtures
• Update .gitreview file for project rename

##2014-11-20 - 5.0.0 ###Summary

This is a backwards-incompatible major release for OpenStack Juno.

####Backwards-incompatible changes

• Migrate the mysql backend to use openstacklib::db::mysql, adding dependency on puppet-openstacklib

####Features

• Add class to manage policy.json
• Add database tuning parameters
• Made keystone user creation optional when creating a service
• Add ability to hide secrets from logs
• Add parameters for netapp and cinder-api workers
• Add support for the EMC VNX direct driver
• Add support for availability zones

####Bugfixes

• Correct the package name for cinder backup

##2014-10-16 - 4.2.0 ###Summary

This is a feature and bugfix release in the Icehouse series.

####Features

• Add parameters to set cinder volume driver
• Add class for extended logging options
• Add option to specify endpoint protocol
• Add option to specify cinder volume path
• Add option to configure os_region_name in the cinder config

####Bugfixes

• Fix cinder type path issues
• Fix targetcli package dependency on target service
• Fix os version fact comparison for RedHat-based operating systems for specifying service provider

##2014-06-19 - 4.1.0 ###Summary

This is a feature and bugfix release in the Icehouse series.

####Features

• Add Cinder v2 endpoint support
• Add SSL support for Cinder API
• Add RabbitMQ SSL support

####Bugfixes

• Move default_volume_type to cinder::api
• Remove warnings for existing Cinder volumes

####Maintenance

• Pin major gems

##2014-01-29 - 4.0.0 ###Summary

This is a backwards-incompatible major release for OpenStack Icehouse.

####Backwards-incompatible changes

• Remove control exchange flag
• Remove deprecated cinder::base class
• Update NetApp unified driver config options

####Features

• Update support for latest RabbitMQ module
• Add Glance support
• Add GlusterFS driver support
• Add region support
• Add support for MySQL module (>= 2.2)
• Add support for Swift and Ceph backup backend
• Add cinder::config to handle additional custom options
• Refactor duplicate code for single and multiple backends

####Bugfixes

None

##2014-04-15 - 3.1.1 ###Summary

This is a bugfix release in the Havana series.

####Bugfixes

• Fix resource duplication bug

##2014-03-26 - 3.1.0 ###Summary

This is a feature and bugfix release in the Havana series.

####Features

• Add default_volume_type as a Cinder API parameter
• Add parameter for endpoint protocols
• Deprecate glance_api_version
• Add support for VMDK
• Add support for Cinder multi backend
• Add support for https authentication endpoints

####Bugfixes

• Replace pip with native package manager (VMDK)

##2014-01-13 - 3.0.0 ###Summary

This is a major release for OpenStack Havana but contains no API-breaking changes.

####Features

• Add support for SolidFire
• Add support for ceilometer

####Bugfixes

• Fix bug for cinder-volume requirement

##2013-10-07 - 2.2.0 ###Summary

This is a feature and bugfix release in the Grizzly series.

####Features

• Add support for rate limiting via api-paste.ini
• Add support to configure control_exchange
• Add parameter check to enable or disable db_sync
• Add syslog support
• Add default auth_uri setting for auth token
• Set package defaults to present

####Bugfixes

• Fix a bug to create empty init script when necessary

####Maintenance

• Various lint fixes

##2013-08-07 - 2.1.0 ###Summary

This is a feature and bugfix release in the Grizzly series.

####Features

• Add configuration of Cinder quotas
• Add support for NetApp direct driver backend
• Add support for ceph backend
• Add support for SQL idle timeout
• Add support for RabbitMQ clustering with single IP

####Bugfixes

• Fix allowed_hosts/database connection bug
• Fix lvm2 setup failure for Ubuntu
• Remove unnecessary mysql::server dependency

####Maintenance

• Pinned RabbitMQ and database module versions
• Various lint and bug fixes

##2013-06-24 - 2.0.0 ###Summary

Initial release on Stackforge.

####Features

• 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