2d9c82283c
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ie00c95615b1b29def8bc34d1b4cfd01f1e19da53 |
||
|---|---|---|
| doc | ||
| examples | ||
| files | ||
| lib/puppet | ||
| manifests | ||
| releasenotes | ||
| spec | ||
| templates | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| bindep.txt | ||
| CHANGELOG.md | ||
| CONTRIBUTING.rst | ||
| Gemfile | ||
| LICENSE | ||
| metadata.json | ||
| Rakefile | ||
| README.md | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
Team and repository tags
openstack_extras
Table of Contents
- Overview - What is the openstack_extras module?
- Module Description - What does the module do?
- Setup - The basics of getting started with openstack_extras
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Release Notes - Release notes for the project
- Contributors - Those with commits
- Repository - The project source code repository
- Versioning - Notes on the version numbering scheme
Overview
The openstack_extras 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 itself is used to add useful utilities for composing and deploying OpenStack with the Openstack puppet modules.
Module Description
The openstack_extras module is intended to provide useful utilities to help with OpenStack deployments, including composition classes, HA utilities, monitoring functionality, and so on.
This module combines other modules in order to build and leverage an entire OpenStack software stack. This module replaces functionality from the deprecated stackforge/puppet-openstack module.
Setup
Installing openstack_extras
puppet module install openstack/openstack_extras
Beginning with openstack_extras
Instructions for beginning with openstack_extras will be added later.
Implementation
openstack_extras
openstack_extras is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
HA configuration for Openstack services
This module allows to configure Openstack services in HA. Please refer to the ha-guide for details. If you have a Corosync with Pacemaker cluster with several nodes joined, you may want to use an HA service provider which allows you to create the pacemaker resources for Openstack services and run them in HA mode. The example HA service configuration for keystone service:
openstack_extras::pacemaker::service { 'openstack-keystone' :
ensure => present,
metadata => {},
ms_metadata => {},
operations => {},
parameters => {},
primitive_class => 'systemd',
primitive_provider => false,
primitive_type => 'openstack-keystone',
use_handler => false,
clone => true,
require => Package['openstack-keystone']
}
This example will create a pacemaker clone resource named p_openstack-keystone-clone and will start it with the help of systemd.
And this example will create a resource p_cinder-api-clone for Cinder API service with the given OCF script template from some cluster module:
$metadata = {
'resource-stickiness' => '1'
}
$operations = {
'monitor' => {
'interval' => '20',
'timeout' => '30',
},
'start' => {
'timeout' => '60',
},
'stop' => {
'timeout' => '60',
},
}
$ms_metadata = {
'interleave' => true,
}
openstack_extras::pacemaker::service { 'cinder-api' :
primitive_type => 'cinder-api',
metadata => $metadata,
ms_metadata => $ms_metadata,
operations => $operations,
clone => true,
ocf_script_template => 'cluster/cinder_api.ocf.erb',
}
Limitations
- Limitations will be added as they are discovered.
Development
Developer documentation for the entire puppet-openstack project.
Release Notes
Contributors
Repository
Versioning
This module has been given version 5 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
6.0.0 -> 2015.1.0 -> Kilo