9d3ef6df10
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: I118a7d3157c159fa4f5bf96dd203fe9b24d8a2c6
Team and repository tags
zaqar
Table of Contents
- Overview - What is the zaqar module?
- Module Description - What does the module do?
- Setup - The basics of getting started with zaqar
- 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 zaqar 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 queue service for OpenStack.
Module Description
The zaqar module is a thorough attempt to make Puppet capable of managing the entirety of zaqar. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the zaqar module to assist in manipulation of configuration files.
Setup
What the zaqar module affects
Zaqar, the queue service for OpenStack.
Installing zaqar
puppet module install openstack/zaqar
Beginning with zaqar
Implementation
zaqar
zaqar is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
Types
zaqar_config
The zaqar_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/zaqar/zaqar.conf file.
zaqar_config { 'DEFAULT/debug' :
value => true,
}
This will write debug=true in the [DEFAULT] section.
name
Section/setting name to manage from zaqar.conf
value
The value of the setting to be defined.
secret
Whether to hide the value from Puppet logs. Defaults to false.
ensure_absent_val
If value is equal to ensure_absent_val then the resource will behave as if ensure => absent was specified. Defaults to <SERVICE DEFAULT>
Limitations
- All the zaqar types use the CLI tools and so need to be ran on the zaqar 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.