bcdcd929ab
Developers run all sorts of different tools within Git repositories, any of which can leave their own special trashfiles all over the place. We can't every hope to catalog them all, so better to recommend developers simply configure a global core.excludesfile to filter the irrelevant files which tend to get created by their personal choice of tools. Add a comment block explaining this, for clarity, and remove the one current editor-specific entry present. We can, and should of course, continue to list files created by the tools recommended by our workflow (test frameworks, documentation and packaging builds, et cetera). This change is a port of Ib58a57267b064e4142686de6c37a70dbff04b9a7 from the openstack-dev/cookiecutter repository. Change-Id: Id6d8809a806b9798b5ad680f5265b22fd9f03064 |
||
---|---|---|
doc | ||
files | ||
lib/puppet | ||
manifests | ||
releasenotes | ||
spec | ||
templates | ||
tests | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
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.