c0920d5e36
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: I924c6661c222917aa2f301bc11cdb9c1786dde4b |
||
---|---|---|
doc | ||
examples | ||
lib/puppet | ||
manifests | ||
releasenotes | ||
spec | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
CONTRIBUTING.rst | ||
Gemfile | ||
LICENSE | ||
README.md | ||
Rakefile | ||
bindep.txt | ||
metadata.json | ||
setup.cfg | ||
setup.py | ||
tox.ini |
README.md
Team and repository tags
Table of Contents
- Overview - What is the placement module?
- Module Description - What does the module do?
- Setup - The basics of getting started with placement
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Beaker-Rspec - Beaker-rspec tests for the project
- Development - Guide for contributing to the module
- Contributors - Those with commits
Overview
The placement 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 not part of the core software. The module its self is used to flexibly configure and manage the placement service for OpenStack.
Module Description
The placement module is a thorough attempt to make Puppet capable of managing the entirety of placement. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the placement module to assist in manipulation of configuration files.
Setup
What the placement module affects
- Placement, the placement service for OpenStack.
Installing placement
placement is not currently in Puppet Forge, but is anticipated to be added soon. Once that happens, you'll be able to install placement with:
puppet module install openstack/placement
Beginning with placement
To utilize the placement module's functionality you will need to declare multiple resources.
Implementation
placement
placement is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
Limitations
- All the placement types use the CLI tools and so need to be ran on the placement node.
Beaker-Rspec
This module has beaker-rspec tests
To run the tests on the default vagrant node:
bundle install
bundle exec rake acceptance
For more information on writing and running beaker-rspec tests visit the documentation:
Development
Developer documentation for the entire puppet-openstack project.