0026ba1d03
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: Iad57a6e61ae005f176710218fdd331aacbe2e1a1 |
||
|---|---|---|
| doc | ||
| examples | ||
| files | ||
| lib/puppet | ||
| manifests | ||
| releasenotes | ||
| spec | ||
| templates | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| CONTRIBUTING.rst | ||
| Gemfile | ||
| LICENSE | ||
| Puppetfile_extras | ||
| README.md | ||
| Rakefile | ||
| bindep.txt | ||
| metadata.json | ||
| tox.ini | ||
README.md
puppet-monasca
Table of Contents
- Overview - What is the monasca module?
- Module Description - What does the module do?
- Setup - The basics of getting started with monasca
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
Overview
The monasca module is a part of OpenStack, and is meant to assist with the installation and configuration of monasca itself, and its dependent services (mentioned below).
Module Description
Setup
What the monasca module affects:
- monasca, monitoring as a service for OpenStack.
- storm, Apache's distributed realtime computational system.
- kafka, Apache's publish-subscribe messaging system.
- influxdb, a stand-alone open-source distributes time series database.
Implementation
monasca
monasca is a combination of Puppet manifest that configures the monasca client and server configuration, as well as monasca's dependent services.
Types
monasca_config
The monasca_config provider is a child of the ini_setting provider. It allows one to write an entry in the /etc/monasca/monasca.conf file.
monasca_config { 'DEFAULT/debug' :
value => true,
}
This will write debug=true in the [DEFAULT] section.
name
Section/setting name to manage from monasca.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>
agent_config
The agent_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/monasca/agent/agent.conf file.
agent_config { 'DEFAULT/verbose' :
value => true,
}
This will write verbose=true in the [DEFAULT] section.
name
Section/setting name to manage from agent.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
This module currently only supports debian based installs.
Development
Developer documentation for the entire puppet-openstack project.