openstack
Version information
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet 3.x
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'karume-openstack', '1.0.1'
Learn more about managing modules with a PuppetfileDocumentation
#puppetlabs-openstack Puppet Labs Reference and Testing Deployment Module for OpenStack.
Version 5.0 / 2014.2 / Juno
####Table of Contents
- Overview - What is the puppetlabs-openstack module?
- A Note on Versioning
- Module Description - What does the module do?
- Setup - The basics of getting started with OpenStack
- Usage - Configuration and customization options
- Reference - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- License
##Overview
The puppetlabs-openstack module is used to deploy a multi-node, all-in-one, or swift-only installation of OpenStack Juno.
###Getting Help
If you need help configuring your puppet master or your puppet agents, or any help understanding puppet or hiera, please review puppet's guide to getting help.
If your puppet ran successfully but OpenStack is not working as expected, please visit OpenStack's getting started guide to find help operating OpenStack.
If puppet did not run successfully, examine what resources failed the puppet run. Please keep in mind that this module is a thin wrapper around the OpenStack Puppet Modules, so problems that arise are often due to bugs in the main modules rather than this one. If you are having trouble with one of the OpenStack Puppet Modules, first check these resources for getting help, and if necessary file a bug for the particular module. If you believe the problem is in the puppetlabs-openstack module, file an issue with the Puppet Labs ticket tracker.
Similarly, if after seeking help from OpenStack's getting started guide you believe puppet has caused a misconfiguration, file a launchpad bug for the particular module causing the issue or for the puppetlabs-openstack module.
##Versioning
This module has been given version 4 to track the puppet-openstack modules. The versioning for the puppet-openstack modules are as follows:
Puppet Module :: OpenStack Version :: OpenStack Codename
2.0.0 -> 2013.1.0 -> Grizzly
3.0.0 -> 2013.2.0 -> Havana
4.0.0 -> 2014.1.0 -> Icehouse
5.0.0 -> 2014.2.0 -> Juno
##Module Description
Using the stable/juno branch of the puppet-openstack modules, puppetlabs-openstack allows for the rapid deployment of an installation of OpenStack Juno. For the multi-node, up to six types of nodes are created for the deployment:
- A controller node that hosts databases, message queues and caches, and most api services.
- A storage node that hosts volumes, image storage, and the image storage api.
- A network node that performs L2 routing, L3 routing, and DHCP services.
- A compute node to run guest operating systems.
- Optional object storage nodes to host an object/blob store.
- An optional Tempest node to test your deployment.
The all-in-one deployment sets up all of the services except for Swift on a single node, including the Tempest testing.
The Swift deployment sets up:
- A controller node that hosts databases, message queues and caches, and the Swift API.
- Three storage nodes in different Swift Zones.
##Setup
###Setup Requirements
This module assumes nodes running on a RedHat 7 variant (RHEL, CentOS, or Scientific Linux) or Ubuntu 14.04 (Trusty) with either Puppet Enterprise or Puppet.
Each node needs a minimum of two network interfaces, and up to four. The network interfaces are divided into two groups.
- Public interfaces:
- API network.
- External network.
- Internal interfaces:
- Management network.
- Data network.
This module have been tested with Puppet 3.5 and Puppet Enterprise. This module depends upon Hiera. Object store support (Swift) depends upon exported resources and PuppetDB.
###Beginning with OpenStack
To begin, you will need to do some basic setup on the compute node. SElinux needs to be disabled on the compute nodes to give OpenStack full control over the KVM hypervisor and other necessary services. This is the only node that SELinux needs to be disabled on.
Additionally, you need to know the network address ranges for all four of the public/private networks, and the specific ip addresses of the controller node and the storage node. Keep in mind that your public networks can overlap with one another, as can the private networks.
The examples directory contains Vagrantfiles with CentOS 7 boxes to test out all-in-one, multi-node, or swift-only deployments.
##Usage
###Hiera Configuration The first step to using the puppetlabs-openstack module is to configure hiera with settings specific to your installation. In this module, the example directory contains sample common.yaml (for multi-node) and allinone.yaml (for all-in-one) files with all of the settings required by this module, as well as an example user and networks to test your deployment with. These configuration options include network settings, locations of specific nodes, and passwords for Keystone and databases. If any of these settings are undefined or not properly set, your deployment may fail.
###Controller Node For your controller node, you need to assign your node the controller role. For example:
node 'control.localdomain' {
include ::openstack::role::controller
}
It's important to apply this configuration to the controller node before any of the other nodes are applied. The other nodes depend upon the service and database setup in the controller node.
###Other Nodes
For the remainder nodes, there are roles to assign for each. For example:
node 'storage.localdomain' {
include ::openstack::role::storage
}
node 'network.localdomain' {
include ::openstack::role::network
}
node /compute[0-9]+.localdomain/ {
include ::openstack::role::compute
}
For this deployment, it's assumed that there is only one storage node and one network node. There may be multiple compute nodes.
After applying the configuration to the controller node, apply the remaining configurations to the worker nodes.
You will need to reboot all of the nodes after installation to ensure that the kernel module that provides network namespaces, required by Open VSwitch, is loaded.
Object Store Nodes
Begin by setting up PuppetDB. The easiest way to do this is to use the module provided by Puppet Labs. The module only needs to be installed on the master. See the puppet node configuration in the multinode or swift site.pp.
You will need to create three nodes as object stores for Swift, assigning three zones:
node /swift[0-9]+zone1.localdomain/ {
class { '::openstack::role::swiftstorage':
zone => '1',
}
node /swift[0-9]+zone2.localdomain/ {
class { '::openstack::role::swiftstorage':
zone => '2',
}
node /swift[0-9]+zone3.localdomain/ {
class { '::openstack::role::swiftstorage':
zone => '3',
}
Because of the use of exported resources, puppet will need multiple runs to converge. First run the Puppet Agent on all of the Swift nodes, which will build out the basic storage and store the exported resource information in PuppetDB. Then run the agent on the control node, which will build out the ring files required by Swift. Finally, run Puppet against the Swift storage nodes again to copy the ring files over and successfully start the Swift services.
##Reference
The puppetlabs-openstack module is built on the 'Roles and Profiles' pattern. Every node in a deployment is assigned a single role. Every role is composed of some number of profiles, which ideally should be independent of one another, allowing for composition of new roles. The puppetlabs-openstack module does not strictly adhere to this pattern, but should serve as a useful example of how to build profiles from modules for customized and maintainable OpenStack deployments.
##Limitations
- High availability and SSL-enabled endpoints are not provided by this module.
##License Puppet Labs OpenStack - A Puppet Module for a Multi-Node OpenStack Juno Installation.
Copyright (C) 2013, 2014 Puppet Labs, Inc. and Authors
Original Author - Christian Hoge
Puppet Labs can be contacted at: info@puppetlabs.com
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.
##2015-01-26 - Release 5.0.2 ###Summary
This is an emergency bugfix release to fix the use of parameters that were unexpectedly removed in the stable nova branch, plus a number of other bugfixes.
####Bugfixes
- Fix syntax error in example hiera file
- Fix Puppetfile dependency for staging module
- Remove heat_stack_owner from default admin roles
- Add firewall rule to fix connectivity between guest nodes
- Have the mongodb module manage the mongodb repo
- Update libvirt type parameter for nova config
- Update database connection parameters for keystone endpoint config
##2015-01-14 - Release 5.0.1 ###Summary
This is a bugfix release to synchronize the mongodb dependency between the metadata.json and the Puppetfile.
####Bugfixes Update mongodb dependency in Puppetfile to 0.10.0
##2015-01-13 - Release 5.0.0 ###Summary
This release is the first stable release for Juno.
####Backwards-incompatible Changes:
- Update release default version to Juno
- Update references to old OpenStack versions
####Features
- Add Juno repositories
- Allow user to configure glance API servers not on the controller
- Allow user to configure alternate database users
- Allow user to configure neutron_plugins via parameterization
- Add support for multiple rabbitmq hosts
- Allow user to configure ceilometer servers not on the controller
- Add libvirt migration support
- Use epel module for epel repo management
- Add region parameter for glance
####Bugfixes and changes to the examples
- Update rabbitmq profile to avoid using nova::rabbitmq
- Make controller role compatible with swift deployment
- Use CentOS 7 vm as default example
- Change memory requirements in example vagrant nodes
- Use Ubuntu vm for example puppet node
Dependencies
- stackforge/ceilometer (>=5.0.0 <6.0.0)
- stackforge/cinder (>=5.0.0 <6.0.0)
- stackforge/glance (>=5.0.0 <6.0.0)
- stackforge/heat (>=5.0.0 <6.0.0)
- stackforge/horizon (>=5.0.0 <6.0.0)
- stackforge/keystone (>=5.0.0 <6.0.0)
- stackforge/neutron (>=5.0.0 <6.0.0)
- stackforge/nova (>=5.0.0 <6.0.0)
- stackforge/openstack_extras (>=5.0.0 <6.0.0)
- stackforge/swift (>=5.0.0 <6.0.0)
- stackforge/tempest (>=5.0.0 <6.0.0)
- puppetlabs/apache (>=1.2.0 <2.0.0)
- puppetlabs/firewall (>=1.0.0 <2.0.0)
- puppetlabs/mongodb (>=0.10.0 <0.11.0)
- puppetlabs/ntp (>=3.0.0 <4.0.0)
- puppetlabs/rabbitmq (>=5.0.0 <5.2.3)
- stackforge/vswitch (>=1.0.0 <2.0.0)
- garethr/erlang (0.3.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 {2013} {Puppet Labs} 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.