9f19d11c16
The module was written in a way that was not consistent with other Puppet OpenStack modules, the interface was very different. This patch: * add db.pp * update logging.pp with usual parameters * drop useless parameters in keystone/auth.pp * cleanup params.pp * drop services.pp, which is useless * Update unit tests * Add coordination support in init.pp * Some alignment issues * Add more doc in README * Stop including ::mistral in all classes * Include mistral::policy in mistral::api This is a non-backward compatible change, but since the module has no release and no stable branch, also very new, this is not something we need to care at this stage. People using this module at this stage will have to update their manifests otherwise their Puppet catalog will fail. Change-Id: I979e21caa71ee35337dc01b225878701868e966a
98 lines
2.2 KiB
Markdown
98 lines
2.2 KiB
Markdown
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/verbose' :
|
|
value => true,
|
|
}
|
|
```
|
|
|
|
This will write `verbose=true` 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.
|
|
|
|
* https://wiki.openstack.org/wiki/Puppet#Developer_documentation
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* https://github.com/openstack/puppet-mistral/graphs/contributors
|