Forge Home


Install and manage the Choria plugin for MCollective


2,438 latest version

2.8 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.30.3 (latest)
  • 0.30.2
  • 0.30.1
  • 0.30.0
  • 0.29.0
  • 0.28.4
  • 0.28.3
  • 0.28.2
  • 0.28.1
  • 0.28.0
  • 0.27.3
  • 0.27.2
  • 0.27.1
  • 0.27.0
  • 0.26.2
  • 0.26.1 (deleted)
  • 0.26.0 (deleted)
  • 0.25.0
  • 0.24.0
  • 0.23.1
  • 0.23.0
  • 0.22.2
  • 0.22.1
  • 0.22.0
  • 0.21.0
  • 0.20.0
  • 0.19.0
  • 0.18.0
  • 0.17.0
  • 0.16.0
  • 0.15.0
  • 0.14.0
  • 0.13.1
  • 0.13.0
  • 0.12.0
  • 0.11.1
  • 0.11.0
  • 0.10.0
  • 0.9.0
  • 0.8.0
  • 0.7.1
  • 0.7.0
  • 0.1.0
released Feb 4th 2024
This version is compatible with:
  • Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , Archlinux, , , , , , , , , , , , ,
  • ping
  • download_files
  • run
  • status
  • wait

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'choria-choria', '0.30.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add choria-choria
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install choria-choria --version 0.30.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



choria/choria — version 0.30.3 Feb 4th 2024


The Choria Orchestrator

A modern Orchestration Engine with roots in The Marionette Collective. Please review the Official Documentation for installation guidance.


Package Repo and Basic Installation

At present RHEL 7 and 8, Debian Stretch, Buster and Bullseye and Ubuntu Xenial, Bionic and Focal are supported, the repository also include packages for other tools like our Stream Replicator etc.

It's best configured using Hiera, to install the YUM Repository and install a particular version with some basic adjustments this will be enough.

choria::manage_package_repo: true
choria::version: 0.0.7-1.el%{facts.os.release.major}
choria::log_level: warn
include choria

Packages and Repositories are signed using Choria Packages GPG Key. For those wishing to maintain their own repo mirrors disable manage_package_repo and create your own yumrepo or apt::source resources.

Configuring the Choria Server

The Choria Server replaces mcollectived.

On all your nodes where you wish to run the new service:

choria::server: true
choria::manage_package_repo: true

On all nodes including those that are pure MCollective and your clients:

  security.serializer: "json"

Configuring the Choria Broker

In all cases below you need to ensure the choria::broker class is used:

include choria::broker

Configuration for the various scenarios are shown via Hiera, you can run all scenarios on the same instance.

Configure a Standalone Choria Broker

We can now configure a standalone Choria Broker, it will listen on port 4222 on :: and on port 8222 on ::1. These settings are configurable via other properties of choria::broker.

Please review the Choria Network Broker documentation for full details.

choria::broker::network_broker: true

Configure a Choria Broker Cluster

To configure a Broker Cluster over port 4223 you can add this data:

  - nats://
  - nats://
  - nats://

This will build a TLs secures Choria Broker Cluster

Configure Federation Brokers

To Federate a network - london - into a Federated Collective you'd run a Federation Broker in the london LAN with the following configuration:

Please review the Federations of Collectives documentation for full details.

choria::broker::federation_broker: true
choria::broker::federation_cluster: london

This will use the SRV domain configured in choria::srvdomain to find the brokers to connect to as per the documentation.

You can configure custom addresses to connec to:


Configure a NATS Streaming Adapter

Given a NATS Stream server with a cluster id prod_stream this will adapt Registration messages received in the Collective to the NATS Stream for processing using Stream Processing patterns.

Please review the Data Adapters documentation for full details.

      type: "nats_stream"
      clusterid: prod_stream
      topic: discovery
      workers: 10
      topic: mcollective.broadcast.agent.discovery
      protocol: request
      workers: 10