{"id":15013925,"url":"https://github.com/voxpupuli/puppet-mcollective","last_synced_at":"2025-09-22T13:30:44.491Z","repository":{"id":47539956,"uuid":"1522671","full_name":"voxpupuli/puppet-mcollective","owner":"voxpupuli","description":"MCollective Server and Client Puppet Module","archived":false,"fork":false,"pushed_at":"2020-12-07T12:11:59.000Z","size":803,"stargazers_count":120,"open_issues_count":29,"forks_count":178,"subscribers_count":117,"default_branch":"master","last_synced_at":"2024-12-14T20:11:39.689Z","etag":null,"topics":["centos-puppet-module","debian-puppet-module","hacktoberfest","linux-puppet-module","oraclelinux-puppet-module","puppet","redhat-puppet-module","scientific-puppet-module","sles-puppet-module","ubuntu-puppet-module"],"latest_commit_sha":null,"homepage":"https://forge.puppet.com/puppet/mcollective","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voxpupuli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-03-24T20:18:16.000Z","updated_at":"2024-07-19T21:29:03.000Z","dependencies_parsed_at":"2022-09-04T10:13:05.512Z","dependency_job_id":null,"html_url":"https://github.com/voxpupuli/puppet-mcollective","commit_stats":null,"previous_names":["puppetlabs/puppetlabs-mcollective"],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-mcollective","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-mcollective/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-mcollective/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-mcollective/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voxpupuli","download_url":"https://codeload.github.com/voxpupuli/puppet-mcollective/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233851062,"owners_count":18740158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["centos-puppet-module","debian-puppet-module","hacktoberfest","linux-puppet-module","oraclelinux-puppet-module","puppet","redhat-puppet-module","scientific-puppet-module","sles-puppet-module","ubuntu-puppet-module"],"created_at":"2024-09-24T19:44:57.348Z","updated_at":"2025-09-22T13:30:44.423Z","avatar_url":"https://github.com/voxpupuli.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MCollective module for Puppet\n\n[![Build Status](https://travis-ci.org/voxpupuli/puppet-mcollective.png?branch=master)](https://travis-ci.org/voxpupuli/puppet-mcollective)\n[![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-mcollective/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-mcollective)\n[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/mcollective.svg)](https://forge.puppetlabs.com/puppet/mcollective)\n[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/mcollective.svg)](https://forge.puppetlabs.com/puppet/mcollective)\n[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/mcollective.svg)](https://forge.puppetlabs.com/puppet/mcollective)\n[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/mcollective.svg)](https://forge.puppetlabs.com/puppet/mcollective)\n\n\u003e [!CAUTION]\n\u003e This module is **archived**, please switch to [choria/choria](https://forge.puppet.com/modules/choria/choria).\n\u003e See [#396](https://github.com/voxpupuli/puppet-mcollective/issues/396) for more info.\n\n#### Table of Contents\n\n1. [Overview](#overview)\n2. [Module Description - What the module does and why it is useful](#module-description)\n3. [Setup - The basics of getting started with mcollective](#setup)\n    * [What the mcollective module affects](#what-the-mcollective-module-affects)\n    * [Beginning with mcollective](#beginning-with-mcollective)\n4. [Usage - Configuration options and additional functionality](#usage)\n5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\n5. [Limitations - OS compatibility, etc.](#limitations)\n6. [Development - Guide for contributing to the module](#development)\n\n## Overview\n\nThe mcollective module installs, configures, and manages the mcollective\nagents, and clients of an MCollective cluster.\n\n## Module Description\n\nThe mcollective module handles installing and configuring mcollective across a\nrange of operating systems and distributions.  Where possible we follow the\nstandards laid down by the\n[MCollective Standard Deployment guide](http://docs.puppetlabs.com/mcollective/deploy/standard.html).\n\n### MCollective Terminology\n\nA quick aside, mcollective's terminology differs a little from what you might\nbe used to in puppet.  There are 3 main components, the client (the mco\ncommands you run to control your servers), the server (a daemon that runs on\nall of your managed nodes and executes the commands), and the middleware (a\nmessage broker the servers and agent connect to).\n\nIf it helps to map these to puppet concepts you loosely have:\n\n* Middleware -\u003e Puppet Master\n* MCollective Server -\u003e Puppet Agent\n* MCollective Client -\u003e no direct equivalent\n\n## Setup\n\n### What the mcollective module affects\n\nOn a server\n\n* mcollective package\n* mcollective server configuration file\n* mcollective service\n\nOn a client\n\n* mcollective-client package\n* mcollective client configuration file\n* optionally user configuration files (~/.mcollective and ~/.mcollective.d)\n\n### Beginning with mcollective\n\nYour main entrypoint to the mcollective module is the mcollective class, so\nassuming you have your middleware configured on a node this is all you need to\nadd a server to mcollective.\n\n```puppet\nclass { '::mcollective':\n  middleware_hosts =\u003e [ 'broker1.example.com' ],\n}\n```\n\n## Usage\n\nYour primary interaction with the mcollective module will be though the main\nmcollective class, with secondary configuration managed by the defined types\n`mcollective::user`, `mcollective::plugin`, `mcollective::actionpolicy`, and\n`mcollective::actionpolicy::rule`.\n\n### I just want to run it, what's the minimum I need?\n\n```puppet\nnode 'broker1.example.com' {\n  include activemq\n}\n\nnode 'server1.example.com' {\n  class { '::mcollective':\n    middleware_hosts =\u003e [ 'broker1.example.com' ],\n  }\n}\n\nnode 'control1.example.com' {\n  class { '::mcollective':\n    client            =\u003e true,\n    middleware_hosts =\u003e [ 'broker1.example.com' ],\n  }\n}\n```\n\nThis default install will be using *no* TLS, a set of well-known usernames and\npasswords, and the psk securityprovider.  This is against the recommendataion\nof the standard deploy guide but does save you from having to deal with ssl\ncertificates to begin with.\n\n### I'd like to secure the transport channel and authenticate users, how do I do that?\n\nGather some credentials for the server and users.  You'll need the ca\ncertificate, and a keypair for the server to use, and a keypair for each user\nto allow.\n\nSee the [standard deploy guide](http://docs.puppetlabs.com/mcollective/deploy/standard.html#step-1-create-and-collect-credentials)\nfor more information about how to generate these.\n\n```puppet\nnode 'broker1.example.com' {\n  # Please see\n  # https://github.com/voxpupuli/puppet-mcollective/blob/master/examples/ssl_example/mco_profile/manifests/middleware/activemq.pp\n  # for this as setting up activemq with a truststore can be quite complex.\n}\n\nnode 'server1.example.com' {\n  class { '::mcollective':\n    middleware_hosts    =\u003e [ 'broker1.example.com' ],\n    middleware_ssl      =\u003e true,\n    middleware_ssl_cert =\u003e \"/var/lib/puppet/ssl/certs/${::clientcert}.pem\",\n    middleware_ssl_key  =\u003e \"/var/lib/puppet/ssl/private_keys/${::clientcert}.pem\",\n    middleware_ssl_ca   =\u003e \"/var/lib/puppet/ssl/certs/ca.pem\",\n    securityprovider    =\u003e 'ssl',\n    ssl_client_certs    =\u003e 'puppet:///modules/site_mcollective/client_certs',\n    ssl_ca_cert         =\u003e 'puppet:///modules/site_mcollective/certs/ca.pem',\n    ssl_server_public   =\u003e 'puppet:///modules/site_mcollective/certs/server.pem',\n    ssl_server_private  =\u003e 'puppet:///modules/site_mcollective/private_keys/server.pem',\n  }\n\n  mcollective::actionpolicy { 'nrpe':\n    default =\u003e 'deny',\n  }\n\n  mcollective::actionpolicy::rule { 'vagrant user can use nrpe agent':\n    agent    =\u003e 'nrpe',\n    callerid =\u003e 'cert=vagrant',\n  }\n}\n\nnode 'control.example.com' {\n  class { '::mcollective':\n    client              =\u003e true,\n    middleware_hosts    =\u003e [ 'broker1.example.com' ],\n    middleware_ssl      =\u003e true,\n    middleware_ssl_cert =\u003e \"/var/lib/puppet/ssl/certs/${::clientcert}.pem\",\n    middleware_ssl_key  =\u003e \"/var/lib/puppet/ssl/private_keys/${::clientcert}.pem\",\n    middleware_ssl_ca   =\u003e \"/var/lib/puppet/ssl/certs/ca.pem\",\n    securityprovider    =\u003e 'ssl',\n    ssl_client_certs    =\u003e 'puppet:///modules/site_mcollective/client_certs',\n    ssl_ca_cert         =\u003e 'puppet:///modules/site_mcollective/certs/ca.pem',\n    ssl_server_public   =\u003e 'puppet:///modules/site_mcollective/certs/server.pem',\n    ssl_server_private  =\u003e 'puppet:///modules/site_mcollective/private_keys/server.pem',\n  }\n\n  mcollective::user { 'vagrant':\n    certificate =\u003e 'puppet:///modules/site_mcollective/client_certs/vagrant.pem',\n    private_key =\u003e 'puppet:///modules/site_mcollective/private_keys/vagrant.pem',\n  }\n}\n```\n\n### I'd like to secure the transport channel and authenticate users with just their private key, how do I do that?\n\nThe Mcollective standard deployment guide uses the 'ssl' securityprovider to handle\nauthentication.  If you're interested in performing the authentication without\ncreating SSL certificates for each user, one alternative is to use the 'sshkey'\nsecurityprovider.  As far as the transport channel encryption goes, it's no different\nthan the above example's use of 'middleware_ssl*' parameters.\n\nSshkey adds additional flexibility with regards to deployment as it currently supports\nboth a static and a dynamic key management philosophy.  You can seperate sshkey from\nyour normal system authentication's backend (known\\_hosts / authorized\\_keys) and\npermit it to send and record its key data for you.  If you do this, you should strongly\nconsider using an authorization plugin with mcollective. Alternatively, you can use\npuppet to enforce the available set of key data to use with requests and responses.\nBecause this could reuse an existing user's ssh private key, it could work along-side\nyour existing user management module.\n\nThe use of sshkey is optional.  For further information, you can review a sample\ndeployment in the /examples folder, review the [sshkey module documentation](https://github.com/puppetlabs/mcollective-sshkey-security),\nand review the [sshkeyauth rubygem documentation](https://github.com/jordansissel/ruby-sshkeyauth)\n(helpful for debugging errors).\n\n## Reference\n\n### The `::mcollective::` class\n\nThe `mcollective` class is the main entry point to the module.  From here you\ncan configure the behaviour of your mcollective install of server, client, and\nmiddleware.\n\n#### Parameters\n\nThe following parameters are available to the mcollective class:\n\n##### `server`\n\nBoolean: defaults to true.  Whether to install the mcollective server on this\nnode.\n\n##### `client`\n\nBoolean: defaults to false.  Whether to install the mcollective client\napplication on this node.\n\n##### `rabbitmq_vhost`\n\nString: defaults to '/mcollective'.  The vhost to connect to/manage when using\nrabbitmq middleware.\n\n##### `manage_packages`\n\nBoolean: defaults to true.  Whether to install mcollective and mcollective-\nclient packages when installing the server and client components.\n\n##### `version`\n\nString: defaults to 'present'.  What version of packages to `ensure` when\n`mcollective::manage_packages` is true.\n\n##### `client_package`\n\nString: defaults to 'mcollective-client'. The name of the package to install for\nthe client part. In the case that there is only one package package handling both,\nclient and server, give the same name for 'client_package' and 'server_package'.\n\n##### `server_package`\n\nString: defaults to 'mcollective'. The name of the package to install for\nthe server. In the case that there is only one package package handling both,\nclient and server, give the same name for 'client_package' and 'server_package'.\n\n##### `ruby_stomp_ensure`\n\nString: defaults to 'installed'.  What version of the ruby-stomp package to\n`ensure` when `mcollective::manage_packages` is true. Only relevant on the\nDebian OS family.\n\n##### `main_collective`\n\nString: defaults to 'mcollective'.  The name of the main collective for this\nclient/server.\n\n##### `collectives`\n\nString: defaults to 'mcollective'.  Comma seperated list of collectives this\nserver should join.\n\n##### `connector`\n\nString: defaults to 'activemq'.  Name of the connector plugin to use.\n\nCurrently supported are `activemq`, `rabbitmq`, and `redis`\n\n##### `securityprovider`\n\nString: defaults to 'psk'.  Name of the security provider plugin to use.\n'ssl' is recommended but requires some additional setup.\n\n##### `psk`\n\nString: defaults to 'changemeplease'.  Used by the 'psk' security provider as\nthe pre-shared key to secure the collective with.\n\n##### `factsource`\n\nString: defaults to 'yaml'.  Name of the factsource plugin to use on the\nserver.\n\n##### `fact_cron_splay`\nBoolean: defaults to false. Spread the cron tasks so that not all the nodes\nruns the facter cronjob at the exact same time.\n\n##### `yaml_fact_path`\n\nString: defaults to '/etc/mcollective/facts.yaml'.  Name of the file the\n'yaml' factsource plugin should load facts from.\n\n##### `ruby_interpreter`\n\nString: defaults to '/usr/bin/env ruby' for non PE installations, and to\n'/opt/puppet/bin/ruby' for PE installations. With `factsource` 'yaml', a ruby\nscript is installed as cron job, which needs to find the ruby interpreter.\nThis parameter allows overriding the default interpreter.\n\n##### `classesfile`\n\nString: defaults to '/var/lib/puppet/state/classes.txt'.  Name of the file the\nserver will load the configuration management class for filtering.\n\n##### `rpcauthprovider`\n\nString: defaults to 'action_policy'.  Name of the RPC Auth Provider to use on\nthe server.\n\n##### `rpcauditprovider`\n\nString: defaults to 'logfile'.  Name of the RPC Audit Provider to use on the\nserver.\n\n##### `rpcauditlogfile`\n\nString: defaults to '/var/log/mcollective-audit.log'.  Name of the audit\nlogfile.\n\n##### `registration`\n\nString: defaults to undef.  Name of the registration plugin to use on the\nserver.\n\n##### `core_libdir`\n\nString: default is based on platform.  Path to the core plugins that are\ninstalled by the mcollective-common package.\n\n##### `site_libdir`\n\nString: default is based on platform.  Path to the site-specific plugins that\nthe `mcollective::plugin` type will install with its `source` parameter.\n\nThis path will be managed and purged by puppet, so don't point it at\ncore_libdir or any other non-dedicated path.\n\n##### `middleware_hosts`\n\nArray of strings: defaults to [].  Where the middleware servers this\nclient/server should talk to are.\n\n##### `middleware_user`\n\nString: defaults to 'mcollective'. Username to use when connecting to the\nmiddleware.\n\n##### `middleware_password`\n\nString: defaults to 'marionette'.  Password to use when connecting to the\nmiddleware.\n\n##### `middleware_multiple_ports`\n\nBoolean: defaults to false. Wheter to use different ports for each host\ndefined in `middleware_hosts` list.\n\n##### `middleware_port`\n\nString: defaults to '61613' (for `activemq`).  Port number to use when\nconnecting to the middleware over an unencrypted connection.\n\n##### `middleware_ssl_port`\n\nString: defaults to '61614'. Port number to use when connecting to the\nmiddleware over a ssl connection.\n\n##### `middleware_ports`\n\nArray of strings: defaults to ['61613'] (for `activemq`). List of port numbers to use\nwhen connecting to the middleware over an unencrypted connection. Port defined in the\narray position `i` will be assigned to the host defined in the same position\nin `middleware_hosts` key.\n\n##### `middleware_ssl_ports`\n\nArray of strings: defaults to ['61614']. List of ports numbers to use when connecting to the\nmiddleware over a ssl connection. Port defined in the array position `i` will be assigned\nto the host defined in the same position in `middleware_hosts` key.\n\n##### `middleware_ssl`\n\nBoolean: defaults to false.  Whether to talk to the middleware over a ssl\nprotected channel.  Highly recommended.  Requires `mcollective::ssl_ca_cert`,\n`mcollective::ssl_server_public`, `mcollective::ssl_server_private` parameters\nfor the server/client install.\n\n##### `middleware_admin_user`\n\nString: defaults to 'admin'.  Username for the middleware admin user.\n\n##### `middleware_admin_password`\n\nString: defaults to 'secret'.  Password to for the middleware\nadmin user.\n\n##### `server_config_file`\n\nString: default is '$confdir/server.cfg'.  Path to the server\nconfiguration file.\n\n##### `server_logfile`\n\nString: defaults to '/var/log/mcollective.log'.  Logfile the mcollective\nserver should log to.\n\n##### `server_loglevel`\n\nString: defaults to 'info'.  Level the mcollective server should log at.\n\n##### `server_daemonize`\n\nBoolean: defaults to true.  Should the mcollective server daemonize when\nstarted.\n\n##### `client_config_file`\n\nString: defaults to '$confdir/client.cfg'.  Path to the client\nconfiguration file.\n\n##### `client_logger_type`\n\nString: defaults to 'console'.  What type of logger the client should use.\n\n##### `client_loglevel`\n\nString: defaults to 'warn'.  Level the mcollective client should log at.\n\n##### `ssl_ca_cert`\n\nString: defaults to undef.  A file source that points to the ca certificate\nused to manage the ssl keys of the mcollective install.\n\n##### `ssl_server_public`\n\nString: defaults to undef.  A file source that points to the public key or\ncertificate of the server keypair.\n\n##### `ssl_server_private`\n\nString: defaults to undef.  A file source that points to the private key of\nthe server keypair.\n\n##### `ssl_client_certs`\n\nString: defaults to 'puppet:///modules/mcollective/empty'.  A file source that\ncontains a directory of user certificates which are used by the ssl security\nprovider in authenticating user requests.\n\n##### `sshkey_server_learn_public_keys`\n\nBoolean: defaults to false.  Allow writing sshkey public keys to\n`sshkey_server_publickey_dir`.\n\n##### `sshkey_server_overwrite_stored_keys`\n\nBoolean: defaults to false.  Overwrite learned keys.\n\n##### `sshkey_server_publickey_dir`\n\nString: defaults to `${confdir}/sshkey_pubdir`.  Directory to store\nreceived keys\n\n##### `sshkey_server_private_key`\n\nString: defaults to '/etc/ssh/ssh\\_host\\_rsa\\_key'.  The private key used to\nsign replies with.\n\n##### `sshkey_server_authorized_keys`\n\nString: defaults to undefined.  The authorized_key file to use.  Undefined\nis interpreted by sshkey to mean the caller's authorized key file.\n\n##### `sshkey_server_send_key`\n\nString: defaults to undefined.  Specifies the public key\nsent back with the response for validation. You probably want\n'/etc/ssh/ssh\\_host\\_rsa\\_key.pub'.\n\n### `mcollective::user` defined type\n\n`mcollective::user` installs a client configuration and any needed client\ncertificates in a users home directory.\n\n#### Parameters\n\n##### `username`\n\nString: defaults to $name. The username of the user to install for.\n\n##### `group`\n\nString: defaults to $name. The group of the user to install for.\n\n##### `homedir`\n\nString: defaults to \"/home/${name}\".  The home directory of the user to\ninstall for.\n\n##### `certificate`\n\nString: defaults to undef.  A file source for the certificate of the user.\nUsed by the 'ssl' securityprovider to set the identity of the user. This is\nmutually exclusive with `certificate_content`.\n\n##### `certificate_content`\n\nString: defaults to undef.  The file content for the certificate of the user.\nUsed by the 'ssl' securityprovider to set the identity of the user. This is\nmutually exclusive with `certificate`.\n\n##### `private_key`\n\nString: defaults to undef.  A file source for the private key of the user.\nUsed by the 'ssl' \u0026 'sshkey' securityprovider to sign messages as from this user.\nWhen not supplied to sshkey, this is interpreted to use the user's ssh-agent.\nThis is mutually exclusive with `private_key_content`.\n\n##### `private_key_content`\n\nString: defaults to undef.  The file content for the private key of the user.\nUsed by the 'ssl' \u0026 'sshkey' securityprovider to sign messages as from this user.\nThis is mutually exclusive with `private_key`.\n\n##### `sshkey_learn_public_keys`\n\nBoolean: defaults to false.  Allow writing sshkey public keys to\n`sshkey_client_publickey_dir`.\n\n##### `sshkey_overwrite_stored_keys`\n\nBoolean: defaults to false.  Overwrite learned keys.\n\n##### `sshkey_publickey_dir`\n\nString: defaults to `${homedir}/.mcollective.d/public_keys`.  Directory to store\nreceived keys.\n\n##### `sshkey_enable_private_key`\n\nBoolean: defaults to false.  Enable manual specification of the private key to\nsign requests with.  False is interpreted by sshkey to use the\nuser's ssh-agent.\n\n##### `sshkey_known_hosts`\n\nString: defaults to '${homedir}/${callerid}/.ssh/known\\_hosts'. The known\\_hosts\nfile to use.  This is mutually exclusive with `sshkey_publickey_dir` and is disabled\nby `sshkey_learn_public_keys`.\n\n##### `sshkey_enable_send_key`\n\nBoolean: defaults to false.  Enable sending the user public key inside the\nrequest.\n\n### `mcollective::plugin` defined type\n\n`mcollective::plugin` installs a plugin from a source uri or a package.  When\ninstalling from a source uri the plugin will be copied to\n`mcollective::site_libdir`\n\n```puppet\nmcollective::plugin { 'puppet':\n  package =\u003e true,\n}\n```\n\nWhen installing a plugin from source you need to create the correct directory\nstructure for it to work.\n\nFor example if you wish to sync an agent for apt which ships with ``apt.ddl``\nand ``apt.rb`` you need to create the following structure:\n\n```\nsite_mcollective/files/plugins/apt/\n                               └── mcollective\n                                   └── agent\n                                       ├── apt.ddl\n                                       └── apt.rb\n```\n\nNow you can then point the ``source`` attribute of the defined type to the\napt folder in your plugins directory.\n\n```puppet\nmcollective::plugin { 'apt':\n  source =\u003e 'puppet:///modules/site_mcollective/plugins/apt',\n}\n```\n\nFor more examples have a look at the directory structure in ``files/plugins``\nof this module.\n\n#### Parameters\n\n##### `name`\n\nString: the resource title.  The base name of the plugin to install.\n\n##### `source`\n\nString: will default to \"puppet:///modules/mcollective/plugins/${name}\".  The\nsource uri that will be copied to `mcollective::site_libdir`\n\n##### `package`\n\nBoolean: defaults to false.  Whether to install the plugin from a file copy or\na package install.\n\n##### `type`\n\nString: defaults to 'agent'.  The type of the plugin package to install.\n\n##### `has_client`\n\nBoolean: defaults to true.  When installing from a package, whether to attempt\nto install `mcollective-${name}-client` on the client node.\n\n### `mcollective::actionpolicy` defined type\n\n`mcollective::actionpolicy` configures an agent for use with actionpolicy in\nconjunction with `mcollective::actionpolicy::rule`.\n\n#### Parameters\n\n##### `name`\n\nString: the resource title.  The name of the agent to set up an actionpolicy\nfor.\n\n##### `default`\n\nString: defaults to 'deny'.  The default actionpolicy to apply to the agent.\n\n### `mcollective::actionpolicy::rule` defined type\n\n`mcollective::actionpolicy::rule` represents a single actionpolicy policy\nentry. See the actionpolicy plugin [Policy File Format](https://github.com/puppetlabs/mcollective-actionpolicy-auth#policy-file-format)\nfor specific restrictions on the values of these fields.\n\n#### Parameters\n\n##### `name`\n\nString: the resource title.  A descriptive name for the rule you are adding.\n\n##### `agent`\n\nString: required, no default.  The name of the agent you are adding a rule\nfor.\n\n##### `action`\n\nString: defaults to 'allow'.  What to do when the other conditions of this\nline are matched.\n\n##### `callerid`\n\nString: defaults to '*'.  What callerids should match this rule.\n\n##### `actions`\n\nString: defaults to '*'.  What actions should match this rule.\n\n##### `fact_filter`\n\nString: defaults to '*'.  What facts should match this rule. This can be either\n'*', a space-separated list of ``fact=value`` pairs (which match if every listed\nfact matches), or any valid [compound filter string](http://docs.puppetlabs.com/mcollective/reference/basic/basic_cli_usage.html#complex-compound-or-select-queries).\nThis matches the \"facts\" field of the policy file lines.\n\n##### `classes`\n\nString: defaults to '*'.  What classes should match this rule.\n\n### `mcollective::common::setting` defined type\n\n`mcollective::common::setting` declares a setting that is common between\nserver and client.\n\n#### Parameters\n\n##### `setting`\n\nString: defaults to the resource title.  The name of the setting to set.\n\n##### `value`\n\nString: no default.  The value to set.\n\n##### `order`\n\nString: default '10'.  The order in which to merge this setting.\n\n### `mcollective::server::setting` defined type\n\n`mcollective::server::setting` declares a setting that is exclusive to a server.\n\n#### Parameters\n\n##### `setting`\n\nString: defaults to the resource title.  The name of the setting to set.\n\n##### `value`\n\nString: no default.  The value to set.\n\n##### `order`\n\nString: default '30'.  The order in which to merge this setting.\n\n### `mcollective::client::setting` defined type\n\n`mcollective::client::setting` declares a setting that is common to clients\nand users.\n\n#### Parameters\n\n##### `setting`\n\nString: defaults to the resource title.  The name of the setting to set.\n\n##### `value`\n\nString: no default.  The value to set.\n\n##### `order`\n\nString: default '30'.  The order in which to merge this setting.\n\n### `mcollective::user::setting` defined type\n\n`mcollective::user::setting` declares a setting that is specific to a user.\n\n#### Parameters\n\n##### `username`\n\nString: required, no default.  Which user to set this value for.\n\n##### `setting`\n\nString: required, no default. The name of the setting to set.\n\n##### `value`\n\nString: no default.  The value to set.\n\n##### `order`\n\nString: default '70'.  The order in which to merge this setting.\n\n### `mcollective::server::config::factsource::yaml` private class\n\n`mcollective::server::config::factsource::yaml` is the class that implements\ncron-based fact generation and configures MCollective to use it. It is a private\nclass and so may not be declared directly, but rather is invoked when the\n`mcollective` class is declared with the `factsource` parameter set to `yaml`\n(the default). Although `mcollective::server::config::factsource::yaml` is private\nit does have one parameter which can be tuned using data bindings (e.g. Hiera).\n\n#### Parameters\n\n##### `path`\n\nString: default $::path. What PATH environment variable to use when\nrefresh-mcollective-metadata is invoked by cron.\n\n\n### Configuration merging\n\nThe configuration of the server and client are built up from the various calls\nto `mcollective::common::setting`, `mcollective::server::setting`,\n`mcollective::client::setting`, and `mcollective::user::setting`.\n\nSettings for the server will be a merge of `mcollective::common::setting` and\n`mcollective::server::setting`, highest order of the setting wins.\n\nSettings for the client will be a merge of `mcollective::common::setting`,\nand `mcollective::client::setting`, highest order of the setting wins.\n\nSettings for a specific user will be a merge of\n`mcollective::common::setting`, `mcollective::client::setting` and\n`mcollective::user::setting` for that specific user, highest order of setting\nwins.\n\n#### Overriding existing options\n\nYou can override an existing server setting from outside of the module by\nsimply specifying that setting again with a higher order than the default of\nthat type, for example to make a server's loglevel be debug (without simply\nsetting mcollective::server_loglevel) you could write:\n\n```puppet\nmcollective::server::setting { 'override loglevel':\n  setting =\u003e 'loglevel',\n  value   =\u003e 'debug',\n  order   =\u003e '50',\n}\n```\n\n## Troubleshooting\n\n### Why do I have no client.cfg?\n\nI said to install the client, so why when I run `mco ping` am I seeing this:\n\n```shell\n$ mco ping\nFailed to generate application list: RuntimeError: Cannot find config file '/etc/mcollective/client.cfg'\n```\n\nYou've enabled the ssl security provider, which implies each user will have\ntheir own ssl credentials to use in the collective.  In order to avoid\nincomplete configuration of clients in this mode we delete the system-wide\n/etc/mcollective/client.cfg and only generate user configuration files with\nthe `mcollective::user` definition.\n\n## Limitations\n\nThis module has been built on and tested against Puppet 3.0 and higher.\n\nThe module has been tested on:\n\n* CentOS 6\n* Ubuntu 12.04\n\nTesting on other platforms has been light and cannot be guaranteed.\n\n## Development\n\nPuppet Community modules on are open projects, and community contributions are\nessential for keeping them great. We can’t access the huge number of platforms\nand myriad of hardware, software, and deployment configurations that Puppet is\nintended to serve.\n\nWe want to keep it as easy as possible to contribute changes so that our\nmodules work in your environment. There are a few guidelines that we need\ncontributors to follow so that we can have a chance of keeping on top of things.\n\nYou can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)\n\nCurrent build status is: [![Build Status](https://api.travis-ci.org/voxpupuli/puppet-mcollective.png)](https://travis-ci.org/voxpupuli/puppet-mcollective)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxpupuli%2Fpuppet-mcollective","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoxpupuli%2Fpuppet-mcollective","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxpupuli%2Fpuppet-mcollective/lists"}