Version information
released Oct 2nd 2015
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet 3.x
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'stackforge-cinder', '5.2.0'Learn more about managing modules with a PuppetfileDocumentation
stackforge/cinder — version 5.2.0 Oct 2nd 2015
cinder
5.2.0 - 2014.2 - Juno
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
- Release Notes - Notes on the most recent updates to the module
Overview
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.
Setup
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://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.
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.
Contributors
Release Notes
5.2.0
- Add an ability to manage use_stderr parameter
5.1.0
- Service Validation for Cinder-API
- Automates generation of NFS config file
- spec: pin rspec-puppet to 1.0.1
- Switch to using the new SolidFire driver name
- Makes kombussl* parameters optional when rabbit_use_ssl => true
- Switch to TLSv1
- Create type-key only if it doesn't exist
- use lioadm on Fedora
- Pin puppetlabs-concat to 1.2.1 in fixtures
- Add nfs_mount_options variable when backend is NetApp
- Change default MySQL collate to utf8_general_ci
- Add configuration helpers for Quobyte
- Implement HP 3par iscsi backend module
- Update .gitreview file for project rename
5.0.0
- 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
4.2.0
- 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
4.1.0
- 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.
4.0.0
- 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.
3.1.1
- Fixed resource duplication bug.
3.1.0
- 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).
3.0.0
- Major release for OpenStack Havana.
- Added support for SolidFire.
- Added support for ceilometer.
- Fixed bug for cinder-volume requirement.
2.2.0
- 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.
2.1.0
- 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.
2.0.0
- 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.
Types in this module release
Dependencies
- dprince/qpid (>=1.0.0 <2.0.0)
- puppetlabs/inifile (>=1.0.0 <2.0.0)
- stackforge/keystone (>=5.0.0 <6.0.0)
- puppetlabs/rabbitmq (>=2.0.2 <4.0.0)
- puppetlabs/stdlib (>=4.0.0 <5.0.0)
- stackforge/openstacklib (>=5.0.0 <6.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.