OpenStack Mistral Puppet Module
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ZhongShengping 030a4fe27e Prepare Train M2 1 week ago
doc Follow the new PTI for document build 1 year ago
examples Fix module structure 6 months ago
lib/puppet Make providers use auth_url for authentication 10 months ago
manifests Add openstackclient installation to the client class 4 weeks ago
releasenotes Add openstackclient installation to the client class 4 weeks ago
spec Add openstackclient installation to the client class 4 weeks ago
.gitignore Dissuade .gitignore references to personal tools 8 months ago
.gitreview OpenDev Migration Patch 1 month ago
.zuul.yaml switch documentation job to new PTI 9 months ago Release 8.0.0 3 years ago
Gemfile Move to opendev 1 month ago
LICENSE Update LICENSE 1 year ago Fix Repository 1 month ago
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 3 years ago
bindep.txt modulesync: sync and add nodepool-bionic for beaker 11 months ago
metadata.json Prepare Train M2 5 days ago
setup.cfg Change openstack-dev to openstack-discuss 6 months ago Add basic structure for ReNo 3 years ago
tox.ini Move to opendev 1 month ago

Team and repository tags

Team and repository tags


Table of Contents

  1. Overview - What is the mistral module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with mistral
  4. Implementation - An under-the-hood peek at what the module is doing
  5. Limitations - OS compatibility, etc.
  6. Beaker-Rspec - Beaker-rspec tests for the project
  7. Development - Guide for contributing to the module
  8. Contributors - Those with commits
  9. Release Notes - Release notes for the project
  10. Repository - The project source code repository


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.


What the mistral module affects

  • Mistral, the workflow service for OpenStack.

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 openstack documentation.



puppet-mistral is a combination of Puppet manifests and ruby code to deliver configuration and extra functionality through types and providers.



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.

mistral_config { 'DEFAULT/use_syslog' :
  value => false,

This will write use_syslog=false in the [DEFAULT] section.


Section/setting name to manage from mistral.conf


The value of the setting to be defined.


Whether to hide the value from Puppet logs. Defaults to false.


If value is equal to ensure_absent_val then the resource will behave as if ensure => absent was specified. Defaults to <SERVICE DEFAULT>


The mistral_workflow provider allows the creation/update/deletion of workflow definitions using a source file (in YAML).

mistral_workflow { 'my_workflow':
  ensure          => present,
  definition_file => '/home/user/my_workflow.yaml',
  is_public       => true,


mistral_workflow { 'my_workflow':
  ensure => absent,

If you need to force the update of the workflow or change it’s public attribute, use latest:

mistral_workflow { 'my_workflow':
  ensure          => latest,
  definition_file => '/home/user/my_workflow.yaml',
  is_public       => false,

Although the mistral client allows multiple workflow definitions per source file, it not recommended to do so with this provider as the mistral_workflow is supposed to represent a single workflow.


The name of the workflow; this is only used when deleting the workflow since the definition file specifies the name of the workflow to create/update.


The path to the file containing the definition of the workflow. This parameter is not mandatory but the creation or update will fail if it is not supplied.


Specifies whether the workflow must be public or not. Defaults to true.


  • All the mistral types use the CLI tools and so need to be ran on the mistral node.


This module has beaker-rspec tests

To run:

bundle install
bundle exec rspec spec/acceptance


Developer documentation for the entire puppet-openstack project.


Release Notes