Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x
- Puppet >= 8.0.0 < 9.0.0
- Archlinux, , , , , , , , , ,
Tasks:
- ping
Plans:
- download_files
- run
- status
- wait
Start using this module
Add this module to your Puppetfile:
mod 'choria-choria', '0.31.0'
Learn more about managing modules with a PuppetfileDocumentation
choria/choria
A modern Orchestration Engine with roots in The Marionette Collective. Please review the Official Documentation for installation guidance.
Usage
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::srvdomain: prod.example.net
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:
mcollective_choria::config:
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:
choria::broker::network_peers:
- nats://choria1.example.net:4223
- nats://choria2.example.net:4223
- nats://choria3.example.net:4223
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:
choria::broker::federation_middleware_hosts:
- choria1.central.example.net:4222
- choria2.central.example.net:4222
- choria3.central.example.net:4222
choria::broker::collective_middleware_hosts:
- choria1.london.example.net:4222
- choria2.london.example.net:4222
- choria3.london.example.net:4222
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.
choria::broker::adapters:
discover:
stream:
type: "nats_stream"
clusterid: prod_stream
topic: discovery
workers: 10
servers:
- stan1.example.net:4222
- stan2.example.net:4222
- stan3.example.net:4222
ingest:
topic: mcollective.broadcast.agent.discovery
protocol: request
workers: 10
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
What are plans?
Modules can contain plans that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Date | Issue | Description |
---|---|---|
2024/09/01 | Release 0.31.0 | |
2024/08/23 | 356 | Support v2 protocol security when creating KV and Governors using Puppet types |
2024/04/02 | 355 | Switched to the static key URL to optimize key downloads |
2024/03/22 | 352 | Allow choria::task::run to catch errors |
2024/03/12 | 350 | Support v2 provisioning connections |
2024/03/11 | 248 | Fix protocol v2 issuers and security |
2024/02/20 | 345 | Fix adapters data type |
2024/02/04 | Release 0.30.3 | |
2024/02/04 | Update dependencies | |
2024/02/03 | Release 0.30.2 | |
2024/01/08 | 339 | Use modern APT keyrings on Debian family |
2023/12/27 | 336 | Ensure tasks from non-production environments actually work |
2023/10/06 | Release 0.30.1 | |
2023/09/18 | 331 | Adds the architecture parameter to remove warnings about unsupported architectures |
2023/09/18 | Release 0.30.0 | |
2023/08/30 | 329 | Allow playbooks and tasks from non production environments |
2023/02/23 | New defined type choria::group to manage groups in access policies |
|
2023/03/22 | Release 0.29.0 | |
2022/09/21 | Release 0.28.3 | |
2022/09/14 | 320 | Allow plugin.choria.network.gateway_name to be set via choria::broker::cluster_name |
2022/09/04 | 317 | Allow latest puppetlabs/apt module to be used |
2022/08/03 | Release 0.28.2 | |
2022/06/23 | Release 0.28.1 | |
2022/06/23 | 314 | Support code name in debian versions |
2022/06/23 | Release 0.28.0 | |
2022/06/09 | 311 | Support EL9 |
2022/06/03 | Support Linux Mint | |
2022/05/16 | Release 0.27.3 | |
2022/05/16 | 307 | Allow hostnames in stats listen address |
2022/05/11 | Release 0.27.2 | |
2022/05/11 | 303 | Fix syntax errors affecting playbooks |
2022/03/23 | 301 | Remove Xenial and Stretch from support operatating systems |
2022/02/24 | 298 | Support systems without IPv6 |
2022/02/23 | Release 0.27.1 | |
2022/02/23 | Update dependencies to fix choria/mcollective bug | |
2022/02/23 | Release 0.27.0 | |
2022/02/10 | Allow access to Choria::TaskResults#bolt_task_result | |
2022/01/25 | 292 | Add package_source parameter |
2022/01/12 | 290 | Provide stats over the loopback address, allow the stats to be disabled entirely |
2021/12/17 | 287 | Add choria::kv_buckets and choria::governors |
2021/10/16 | 281 | Arch Linux: Switch from Ruby 2.7 to 3 |
2021/09/22 | 278 | Add the choria_kv_bucket resource |
2021/09/21 | Release 0.26.2 | |
2021/09/21 | Fix Debian releases | |
2021/09/21 | Release 0.26.1 | |
2021/09/21 | Fix nightly repository ensure property | |
2021/09/21 | Release 0.26.0 | |
2021/09/17 | 271 | Support new package repositories |
2021/09/20 | 273 | Add a type and provider to manage governors |
2021/09/03 | 269 | Arch Linux: adjust package name from choria to choria-io |
2021/09/03 | 267 | Arch Linux: Use /usr/bin/ruby-2.7 instead of default Ruby 3 |
2021/08/24 | Release 0.25.0 | |
2021/08/13 | 262 | Support allowing provisioning against a core Choria Broker |
2021/08/04 | 260 | Rename jetstream adapter to choria_streams |
2021/07/14 | 258 | Prepare autonomous agents for data storage |
2021/05/20 | 235 | Support puppetlabs/apt 8.x |
2021/07/10 | 254 | Support configuring core Stream replica configuration |
2021/06/19 | Release 0.24.0 | |
2021/04/28 | Use EL8 repo for Fedora | |
2021/04/28 | 247 | Support websocket ports |
2021/03/29 | Release 0.23.0 | |
2021/03/23 | 238 | Support configuring leafnode connections |
2021/03/22 | 235 | Support latest puppetlabs/stdlib |
2021/03/22 | 233 | Enable access to the NATS system account |
2021/03/10 | 231 | Support configuring Streaming |
2021/03/03 | 230 | Add server_service_enable parameter |
2021/01/13 | Release 0.22.2 | |
2021/01/13 | Ensure choria version 0.20.2 is installed on RedHat and Debian |
|
2021/01/13 | Release 0.22.1 | |
2021/01/13 | Ensure choria version 0.20.1 is installed on RedHat and Debian |
|
2021/01/13 | Release 0.22.0 | |
2021/01/18 | Support run_as for playbooks |
|
2021/01/15 | 207 | Ensure the mcollective class is included when just including choria |
2021/01/13 | Release 0.21.0 | |
2020/10/26 | Correctly describe the NATS Streaming Server adapter data type | |
2021/01/10 | 217 | Remove support for legacy compound filters |
2020/12/29 | 207 | Simplify choria module dependencies by moving all to this module |
2020/12/29 | 207 | Migrate configuration to /etc/choria |
2020/12/28 | 210 | Move mcollective_agent_bolt_tasks::ping task to choria::ping |
2020/12/28 | 208 | Correctly support disabling the Choria Server |
2020/12/16 | 200 | Impove Puppet 7 support |
2020/12/21 | 195 | Support yum repositories on CentOS 8 |
2020/12/21 | 203 | Improve testing harness using rspec-puppet-facts |
2020/12/21 | 203 | Improve testing harness using rspec-puppet-facts |
2020/12/21 | 204 | Remove unsupported operating systems |
2020/12/15 | 198 | Add support for setting additional properties in scout checks |
2020/12/13 | 196 | Remove references to mcollectived |
2020/12/04 | 192 | Add choria::scout_metric |
2020/11/25 | Release 0.20.0 | |
2020/10/22 | 188 | Add FreeBSD support for choria |
2020/10/21 | 188 | Always deploy choria server |
2020/10/02 | 187 | Support Ubuntu focal and KDE neon 20.04 |
2020/09/28 | Release 0.19.0 | |
2020/08/03 | 181 | Support Scout check annotations |
2020/08/03 | 179 | On resuming a Scout check move to unknown not force |
2020/07/22 | 175 | Support multiple Gossfiles |
2020/07/17 | Release 0.18.0 | |
2020/07/16 | 172 | Support creating a gossfile from hiera |
2020/07/16 | 170 | Add choria::scout_checks helper |
2020/07/07 | Release 0.17.0 | |
2020/06/28 | 164 | Improve package repository management |
2020/06/20 | 158 | Support creating Choria Scout checks and overrides |
2020/07/01 | Release 0.16.0 | |
2020/06/26 | 164 | Improve package repository management logic |
2020/06/24 | 158 | Support adding Choria Scout health checks |
2020/04/19 | Release 0.16.0 | |
2020/04/01 | 155 | Add choria::playbook_exist function |
2020/02/11 | 151 | Support Amazon Linux |
2020/01/27 | 135 | Allow GPG repo checking behaviour to be configured |
2020/01/25 | 115 | Allow the ssldir setting to be configured by the module |
2020/01/04 | 143 | New configuration options for auto provisioning support |
2020/01/04 | 145 | Improve windows support |
2019/12/06 | 142 | Add choria::sleep playbook function |
2019/11/25 | Release 0.15.0 | |
2019/11/21 | 113 | Improve resource ordering on debian systems |
2019/09/19 | 130 | Allow splitting services log into server and broker logs |
2019/09/20 | Release 0.14.0 | |
2019/09/17 | 127 | Create a symlink of mcollective policies into choria |
2019/08/20 | 125 | Allow client_hosts to be set in broker config |
2019/08/18 | 123 | Create a symlink mcollective plugin.d into choria |
2019/08/16 | 121 | Allow top-level choria::server_config options to be arrays |
2019/08/15 | 119 | Allow broker TLS timeout to be configured |
2019/07/23 | 108 | Improve packaging on CentOS 7, drops support for 5 |
2019/05/27 | Release 0.13.1 | |
2019/03/13 | 113 | Ensure APT repositories are managed before the packages |
2019/03/14 | 111 | Disable repo_gpgcheck for yum repos to enable mirrors to be made |
2019/03/04 | Release 0.13.0 | |
2019/01/30 | 106 | Allow the Package Cloud repo to be mirrored and a local url used when configuring the repos |
2018/12/01 | Release 0.12.0 | |
2018/11/30 | 102 | Write the Choria Server status file by default |
2018/11/27 | 99 | On AIO Puppet 6 enable Choria Server by default |
2018/11/12 | 88 | Use the correct hash2config function |
2018/10/13 | Release 0.11.1 | |
2018/10/03 | 94 | Allow latest apt and stdlib modules to be used |
2018/09/20 | Release 0.11.0 | |
2018/07/31 | 84 | Improve itterators in the plan DSL to return collected results instead of items |
2018/07/31 | 81 | Support for compound filters outside of mcollectived |
2018/07/20 | Release 0.10.0 | |
2018/07/20 | 77 | Ensure removal of mcollective plugins by way of the directory purge feature restarts choria server |
2018/07/11 | 75 | Support ubuntu 18.04, and remove old operating systems |
2018/07/05 | 71 | Rename log_file to logfile to improve consistency between our modules |
2018/07/06 | 73 | Improve support for servers with facter 2.5 like those installed from gems |
2018/05/21 | Release 0.9.0 | |
2018/05/18 | 68 | Fix inverted logic in on_error and on_success playbook helpers |
2018/05/05 | 61 | Support invoking Puppet Tasks from Playbooks |
2018/04/59 | 59 | Create a minimal config tailored to the needs of the ruby compat shim |
2018/04/25 | 57 | Ensure Choria Server auditing is enabled |
2018/04/24 | Release 0.8.0 | |
2018/04/19 | 53 | Configure the choria server component |
2018/04/02 | 49 | Improve handling of on_error in Playbooks |
2018/03/23 | 45 | Ensure the server service is off by default |
2018/03/22 | Release 0.7.1 | |
2018/03/22 | 43 | Ensure apt-get update gets run after adding deb repositories |
2018/03/22 | 41 | Improve debian/ubuntu support by setting the identity specifically |
2018/03/21 | Release 0.7.0 | |
2018/03/06 | 36 | Add mandatory name option to the YUM repositories |
2018/03/04 | 32 | Add missing install dependency to improve puppet run ordering |
2018/03/02 | 6 | Support managing the Choria Ubuntu and Debian repositories |
2018/03/02 | 21 | Support managing the Choria Data Adapters |
2018/03/02 | 5 | Support managing the Choria Federation Broker |
2018/03/01 | 4 | Support managing the Choria Network Broker |
2018/02/25 | Release 0.1.0 | |
2018/02/24 | 14 | Add Choria::ShellSafe |
2018/02/23 | 12 | Add choria::in_groups_of |
2018/02/23 | 1 | Support functions, types and helpers to support playbooks in the Puppet DSL |
2018/02/16 | 3 | Manage the YUM repository on EL machines |
Dependencies
- puppetlabs/stdlib (>= 9.0.0 < 10.0.0)
- puppetlabs/apt (>= 9.2.0 < 10.0.0)
- puppetlabs/concat (>= 9.0.0 < 10.0.0)
- choria/mcollective_choria (>= 0.22.2 < 2.0.0)
- choria/mcollective (>= 0.14.6 < 2.0.0)
- choria/mcollective_agent_puppet (>= 2.5.0)
- choria/mcollective_agent_package (>= 5.5.1)
- choria/mcollective_agent_service (>= 4.1.0)
- choria/mcollective_agent_filemgr (>= 2.1.0)
- choria/mcollective_util_actionpolicy (>= 3.3.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.