d4ced03725
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: https://gist.github.com/351a90e08724817524422c5801918ebe Change-Id: If788fbd7392398e9c9551da5dd4e079fded030c0
105 lines
2.4 KiB
Markdown
105 lines
2.4 KiB
Markdown
Team and repository tags
|
|
========================
|
|
|
|
[](http://governance.openstack.org/reference/tags/index.html)
|
|
|
|
<!-- Change things from this point on -->
|
|
|
|
mistral
|
|
======
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Overview - What is the mistral module?](#overview)
|
|
2. [Module Description - What does the module do?](#module-description)
|
|
3. [Setup - The basics of getting started with mistral](#setup)
|
|
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
|
|
5. [Limitations - OS compatibility, etc.]
|
|
6. [Development - Guide for contributing to the module](#development)
|
|
7. [Contributors - Those with commits](#contributors)
|
|
|
|
Overview
|
|
--------
|
|
|
|
The Mistral module itself is a workflow service for OpenStack cloud.
|
|
|
|
Module Description
|
|
------------------
|
|
|
|
The mistral module is an attempt to make Puppet capable of managing the
|
|
entirety of mistral.
|
|
|
|
Setup
|
|
-----
|
|
|
|
### Beginning with mistral
|
|
|
|
To use the mistral module's functionality you will need to declare multiple
|
|
resources. This is not an exhaustive list of all the components needed; we
|
|
recommend you consult and understand the
|
|
[core of openstack](http://docs.openstack.org) documentation.
|
|
|
|
|
|
Implementation
|
|
--------------
|
|
|
|
### Mistral
|
|
|
|
puppet-mistral is a combination of Puppet manifests and ruby code to deliver
|
|
configuration and extra functionality through types and providers.
|
|
|
|
### Types
|
|
|
|
#### mistral_config
|
|
|
|
The `mistral_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/mistral/mistral.conf` file.
|
|
|
|
```puppet
|
|
mistral_config { 'DEFAULT/use_syslog' :
|
|
value => false,
|
|
}
|
|
```
|
|
|
|
This will write `use_syslog=false` in the `[DEFAULT]` section.
|
|
|
|
##### name
|
|
|
|
Section/setting name to manage from `mistral.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>`
|
|
|
|
|
|
Beaker-Rspec
|
|
------------
|
|
|
|
This module has beaker-rspec tests
|
|
|
|
To run:
|
|
|
|
```shell
|
|
bundle install
|
|
bundle exec rspec spec/acceptance
|
|
```
|
|
|
|
Development
|
|
-----------
|
|
|
|
Developer documentation for the entire puppet-openstack project.
|
|
|
|
* http://docs.openstack.org/developer/puppet-openstack-guide/
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* https://github.com/openstack/puppet-mistral/graphs/contributors
|