112 lines
2.8 KiB
Markdown
112 lines
2.8 KiB
Markdown
puppet-monasca
|
|
=============
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Overview - What is the monasca module?](#overview)
|
|
2. [Module Description - What does the module do?](#module-description)
|
|
3. [Setup - The basics of getting started with monasca](#setup)
|
|
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
|
|
5. [Limitations - OS compatibility, etc.](#limitations)
|
|
6. [Development - Guide for contributing to the module](#development)
|
|
7. [Contributors - Those with commits](#contributors)
|
|
|
|
Overview
|
|
--------
|
|
|
|
The monasca module is a part of [OpenStack](https://github.com/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.
|
|
|
|
```puppet
|
|
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.
|
|
|
|
```puppet
|
|
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.
|
|
|
|
* http://docs.openstack.org/developer/puppet-openstack-guide/
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* https://github.com/openstack/puppet-monasca/graphs/contributors
|