- Overview - What is the cloud module?
- Module Description - What does the module do?
- Setup - The basics of getting started with puppet-openstack-cloud
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Getting Involved - How to go deeper
- Development - Guide for contributing to the module
- Contributors - Those with commits
- Release Notes - Notes on the most recent updates to the module
The OpenStack Puppet Modules are a flexible Puppet implementation capable of configuring the core OpenStack services:
- Nova (compute)
- Glance (image)
- Keystone (identity)
- Cinder (volume)
- Horizon (dashboard)
- Heat (orchestration)
- Ceilometer (telemetry)
- Neutron (networking)
- Swift (object storage)
- Trove (database as a service)
Cinder, Glance and Nova can use Ceph as backend storage, using puppet-ceph.
Only KVM and QEMU are supported as hypervisors, for now. Neutron use ML2 plugin with GRE and Open-vSwitch drivers. Cinder has multi-backend support:
- RBD (default)
- EMC VNX direct
- NFS Neutron supports:
- ML2 plugin with OVS agent (GRE + VXLAN supported)
- Cisco plugin with N1KV agent (non-ML2) Trove support is now experimental.
Puppet Modules are a collection of related contents that can be used to model the configuration of a discrete service.
These Puppet modules are based on the openstack documentation.
There are a lot of moving pieces in OpenStack, consequently there are several Puppet modules needed to cover all these pieces. Each module is then made up of several class definitions, resource declarations, defined resources, and custom types/providers. A common pattern to reduce this complexity in Puppet is to create a composite module that bundles all these component type modules into a common set of configurations. The cloud module is doing this compositing and exposing a set of variables needed to be successful in getting a functional stack up and running.
Puppet 3.x isn't yet available on Debian/RedHat stable osfamily, but hopefully puppet provides a Official repository, please see this page for the setup.
These modules have been fully tested on Ubuntu Precise and Debian Wheezy and RHEL 6.
What the cloud module affects
- The entirety of OpenStack!
Puppet Labs provides two tools for getting started with managing configuration modeling with Puppet, Puppet Enterprise or its underlying opensource projects, i.e. Puppet and MCollective.
- Puppet Enterprise is a complete configuration management platform, with an optimized set of components proven to work well together. Is free up to 10 nodes so if you're just using Puppet for OpenStack management this might just work perfectly. It will come configured with a handful of extra components that make for a richer experience, like a web interface for managing the orchestration of Puppet and certificate management.
- Puppet manages your servers: you describe machine configurations in an easy-to-read declarative language, and Puppet will bring your systems into the desired state and keep them there. This is the opensource version of Puppet and should be available in your operating system's package repositories but it is generally suggested you use the yum or apt repositories from Puppet Labs if possible.
Consult the documentation linked above to help you make your decision but don't fret about the choice to much, opensource Puppet agents are compatible with Puppet Enterprise Puppet masters.
The swift portions of this module needs Puppet's exported resources. Exported resources leverages the PuppetDB to export and share data across other Puppet managed nodes.
cd /etc/puppet/modules git clone firstname.lastname@example.org:enovance/puppet-openstack-cloud.git cloud cd cloud gem install --no-ri --no-rdoc r10k # a debian package is available in jessie PUPPETFILE=./Puppetfile PUPPETFILE_DIR=../ r10k --verbose 3 puppetfile install
The things that follow can be handled by Puppet but are out of scope of this document and are not included in the cloud module.
Utilization of this module can come in many forms. It was designed to be capable of deploying all services to a single node or distributed across several. This is not an exhaustive list, we recommend you consult and understand all the manifests included in this module and the core openstack documentation.
(more doc should be written here)
- Deploys only with rabbitmq and mysql RPC/data backends.
- Not backwards compatible with pre-2.x release of the cloud modules.
Need a feature? Found a bug? Let us know!
We are extremely interested in growing a community of OpenStack experts and users around these modules so they can serve as an example of consolidated best practices of how to deploy openstack.
The best way to get help with this set of modules is to email the group associated with this project:
dev [at] enovance [dot] com
Issues should be opened here:
See CHANGELOG file.
##2014-10-24 - Features release 2.2.0 ###Summary
- Sensu as first implementation of monitoring system
- Glance now supports NFS image storage backend
- Cinder now supports EMC VNX & iSCSI volume backends
- Nova now supports NFS instance storage backend
- Neutron now supports Cisco plugins with N1KV hardware (experimental)
- RabbitMQ can now be load-balanced by HAproxy
- Keystone roles for Heat are now created automatically
- Support for keepalived authentification
- MongoDB replicaset is now an option, so MongoDB can be standalone
- MySQL Galera has been tweaked to have better performances at scale
- Nova configuration has been tweaked to use read-only database feature and have better performances at scale
- Trove has been disabled by default since it's still in experimental status
- HAproxy: Allow user to bind multiple public/private IPs
- keepalived: allow vrrp traffic on a dedicated interface
- When running KVM, we check if VTX is really enabled
- HAproxy checks have been improve for OpenStack services
- Neutron: allow to specify tunnel type (i.e. VXLAN)
- Horizon: ALLOWED_HOST can now be controlled by the module
- Horizon: Allow user to speficy broader apache vhost settings
- Nova/RBD: support for RHEL 7
- Fix correct Puppet Ceph dependencies which could lead to bootstrap issues
- Fix issues with instance live migration support (nova configuration)
- Fix HAproxy checks for Spice (TCP instead of HTTP)
- No known bugs
##2014-07-15 - Features release 2.1.0 ###Summary
- Advanced logging support with kibana3, elasticsearch and fluentd
- Improve SSL termination support
- File backend support for Glance
- OpenStack Database as a Service support (Trove) as experimental
- Pacemaker support in Red-Hat
- heat-engine is no more managed as a single point of failure
- Fix heat-cfn & heat-cloudwatch HAproxy binding
- Fix issues when using SSL termination
- No known bugs
##2014-06-19 - Features release 2.0.0 ###Summary
- Icehouse release support
- OpenStack Object Storage support (Swift)
- Neutron Metadata multi-worker
- RBD flexibility on compute nodes
- Keystone and Nova v3 API support
- SSL termination support
- Fix nova-compute service when using RBD backend
- Fix cinder-volume service when creating a volume type
- Enable to have Swift Storage & Ceph OSD on same nodes
- No known bugs
##2014-05-06 - Features release 1.3.0 ###Summary
- High Availability refactorization
- OpenStack services separation in different classes
- DHCP Agent: Add support of DNS server declaration
- Defaults values for all puppet parameters, can now support Hiera.
- Fix all unit tests to pass Travis
- Fix HAproxy configuration for Heat API binding
- When using RBD as Nova Backend, nova-compute should be notified
- When creating a volume type, cinder-volume should be notified
- Impossible to attach a volume backend by RBD if not using RBD backend for Nova
##2014-04-22 - Features release 1.2.0 ###Summary
- Now supports Ubuntu 12.04
- Now supports Now supports Red Hat OpenStack Platform 4
- Can be deployed on 3 nodes
- Add cluster note type support for RabbitMQ configuration
- Block storage can now be backend by multiple RBD pools
- Fix a bug in Horizon in HTTP/HTTPS binding
- No known bugs
##2014-04-01 - Features release 1.1.0 ###Summary
- Updated puppetlabs-rabbitmq to 3.1.0 (RabbitMQ to 3.2.4)
- Add Cinder Muli-backend support
- NetApp support for Cinder as a backend
- Keystone uses now MySQL for tokens storage (due to several issues with Memcache backend)
- Back to upstream puppet-horizon from stackforge
- Servername parameter support in Horizon configuration to allow SSL redirections
- puppet-openstack-cloud module QA is done by Travis
- network: add dhcp_lease_duration parameter support
- neutron: increase agent polling interval
- Bug in Horizon in HTTP/HTTPS binding (fixed in 1.2.0)
##2014-03-13 - First stable version 1.0.0 ###Summary
- First stable version.
- No known bugs
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.