b554d30aaf
With the creation of the new openstack_config provider, some processing
that was done in cinder_config has been centralized in
openstack_config.
Impacted methods are :
* section
* setting
* separator
Also, this commit adds the fact that, when passing a specific string
(ensure_absent_val) the provider will behave as if ensure => absent was
specified. '<SERVICE DEFAULT>' is the default value for
ensure_absent_val.
The use case is the following :
cinder_config { 'DEFAULT/foo' : value => 'bar' } # will work as usual
cinder_config { 'DEFAULT/foo' : value => '<SERVICE DEFAULT>' } # will mean absent
That means that all the current :
if $myvar {
cinder_config { 'DEFAULT/foo' : value => $myvar }
} else {
cinder_config { 'DEFAULT/foo' : ensure => absent }
}
can be removed in favor of :
cinder_config { 'DEFAULT/foo' : value => $myvar }
If for any reason '<SERVICE DEFAULT>' turns out to be a valid value for
a specific parameter. One could by pass that doing the following :
cinder_config { 'DEFAULT/foo' : value => '<SERVICE DEFAULT>',
ensure_absent_val => 'foo' }
Change-Id: I10931ea201b567ff6576fd3f87d05f2fd0816166
Depends-On: I0eeebde3aac2662cc7e69bfad7f8d2481463a218
cinder
6.0.0 - 2015.1 - Kilo
Table of Contents
- Overview - What is the cinder module?
- Module Description - What does the module do?
- Setup - The basics of getting started with cinder
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
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. These modules can be found, all pulled together in the openstack module.
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. 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://cinder:secret_block_password@openstack-controller.example.com/cinder',
rabbit_password => 'secret_rpc_password_for_blocks',
rabbit_host => 'openstack-controller.example.com',
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://cinder:secret_block_password@openstack-controller.example.com/cinder',
rabbit_password => 'secret_rpc_password_for_blocks',
rabbit_host => 'openstack-controller.example.com',
verbose => true,
}
class { 'cinder::volume': }
class { 'cinder::volume::iscsi':
iscsi_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',
rabbit_password => 'secret_rpc_password_for_blocks',
rabbit_host => 'openstack-controller.example.com',
verbose => true,
}
class { 'cinder::volume': }
cinder::backend::iscsi {'iscsi1':
iscsi_ip_address => '10.0.0.2',
}
cinder::backend::iscsi {'iscsi2':
iscsi_ip_address => '10.0.0.3',
}
cinder::backend::iscsi {'iscsi3':
iscsi_ip_address => '10.0.0.4',
volume_backend_name => 'iscsi',
}
cinder::backend::iscsi {'iscsi4':
iscsi_ip_address => '10.0.0.5',
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 => 'http://127.0.0.1:5000/v2.0/',
}
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
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/verbose' :
value => true,
}
This will write verbose=true 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'].
Beaker-Rspec
This module has beaker-rspec tests
To run:
shell bundle install bundle exec rspec spec/acceptance
Development
Developer documentation for the entire puppet-openstack project.