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.
Zuul 49d34a7d65 Merge "Remove deprecated mistral::coordination_* parameters" 2 hours ago
doc Update openstackdocstheme to the latest version 11 months ago
examples Convert all class usage to relative names 3 years ago
lib/puppet Merge "Deprecate usage of authtoken parameters in providers" 5 months ago
manifests Merge "Remove deprecated mistral::coordination_* parameters" 2 hours ago
releasenotes Remove deprecated mistral::coordination_* parameters 1 week ago
spec Merge "Remove deprecated mistral::coordination_* parameters" 2 hours ago
.gitignore Dissuade .gitignore references to personal tools 4 years ago
.gitreview OpenDev Migration Patch 3 years ago
.zuul.yaml Drop the tripleo-puppet-undercloud job 1 year ago Release 8.0.0 6 years ago
CONTRIBUTING.rst [ussuri][goal] Add CONTRIBUTING.rst 2 years ago
Gemfile Use openstack_spec_helper from zuul checkout 2 years ago
LICENSE Update LICENSE 4 years ago Add Puppet Litmus 2 years ago
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 7 years ago
bindep.txt modulesync: sync and add nodepool-bionic for beaker 4 years ago
metadata.json Remove support for CentOS 8 Stream 2 months ago
setup.cfg Add information technology in the setup.cfg 11 months ago setuptools: Disable auto discovery 5 months ago
tox.ini Stop configuring install_command in tox. 11 months 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. Development - Guide for contributing to the module
  7. Contributors - Those with commits
  8. Release Notes - Release notes for the project
  9. 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.


Developer documentation for the entire puppet-openstack project.


Release Notes