View
24 website/plugin_directory/index.markdown
@@ -3,65 +3,65 @@ layout: default
title: "MCollective Plugin Directory"
---
This directory of MCollective plugins was migrated from the Puppet Labs wiki in January, 2015.
This directory of MCollective plugins was migrated from the Puppet Labs wiki in January, 2015.
# Agents
## Agents
* [Apt](apt.html) - Perform various tasks for apt/dpkg
* [File Manager](agent_file_manager.html) - create, touch, remove and retrieve information about files
* [IP Tables Junkfilter Manager](agent_iptables_junk_filter.html) - Add, removes and queries rules on a specific chain
* [Net Test](net_test.html) - Performs network reachability testing
* [NRPE](nrpe_agent.html) - Runs NRPE commands using MCollective as transport
* [Process](process_management.html) - Manage server processes
* [Puppet](puppet_agent.html) - enable, disable, run puppet daemons.
* [Puppet](puppet_agent.html) - enable, disable, run puppet daemons.
* [Puppet CA](puppet_ca.html) - Manage the Puppet Certificate Authority
* [Package](package.html) - installs, uninstalls and query Operating System packages
* [Packages](packages.html) - install, update, uninstall multiple packages in one run with fine version/revision control
* [Service](services.html) - stop, starts and query Operating System services
* [Spam Assassin](spamassassin.html) - Perform various tasks for Spam Assassin
* [Stomp Utilities](stomp_util.html) - helpers and utilities for the STOMP connector
# Fact Sources
## Fact Sources
* [Facter via YAML](facter_via_yaml.html) - Access Facter variables as YAML
* [Facter](facter.html) - Use Puppet Labs Facter as a fact source
* [Ohai](ohai.html) - Use OpsCode Ohai as a fact source
# Auditing
## Auditing
* [Central RPC Log](central_rpc_log.html) - Logs RPC audit logs to a central log file or MongoDB instance
* [Central LogStash log](logstash_rpc_audit_logs.html) - Logs RPC audit logs to a central [LogStash](http://code.google.com/p/logstash/) instance
# Authorization
## Authorization
* [Action Policy](authorization_action_policy.html) - Authorization plugin with fine grain per action ACLs
# Data
## Data
* [Puppet Resource Status]() - Datasource to facilitate discovery of machines based on the state of Puppet resources
* [Sysctl Value](sysctl_data.html) - Datasource to retrieve values from any Linux sysctl
* [Agent Meta Data](agent_metadata.html) - Datasource to retrieve meta data about currently installed agents for nodes
# Discovery
## Discovery
* [Registration Data in MongoDB](agent_registration_mongodb.html) - Discover against registration data in a MongoDB NoSQL server
# Security
## Security
* [None](none.html) - A plugin for development that provides no security
# Registration
## Registration
* [Meta Data](agent_metadata.html) - Sends agents, facts and classes lists to registration agents
* [Registration Monitor](agent_registration_monitor.html) - Writes registration data to file and a Nagios check
* [Registration Data in MongoDB](agent_registration_mongodb.html) - Writes registration data to a MongoDB NoSQL server
# Tools
## Tools
* [Puppet Commander](puppet_commander.html) - schedule puppet runs on a group of hosts with enforced concurrency
View
3 website/plugin_directory/logstash_rpc_audit_logs.markdown
@@ -1,7 +1,8 @@
---
layout: default
title: "MCollective Plugin: Logstash RPC Audit Logs"
toc: false
---
The documentation for this plugin can be found in its [GitHub repository](https://github.com/puppetlabs/mcollective-logstash-audit#readme).
The documentation for this plugin can be found in its [GitHub repository](https://github.com/puppetlabs/mcollective-logstash-audit#readme).
View
1 website/plugin_directory/net_test.markdown
@@ -1,6 +1,7 @@
---
layout: default
title: "MCollective Plugin: Net Test Agent"
toc: false
---
The documentation for this plugin can be found in its [GitHub Repository](https://github.com/puppetlabs/mcollective-nettest-agent#readme)
View
5 website/plugin_directory/none.markdown
@@ -1,18 +1,19 @@
---
layout: default
title: "MCollective Plugin: No Security"
toc: false
---
This plugin is very easy to use as it provides no security there are no certificates or pre shared keys to setup. The intention is to use it in development and testing but **NOT IN PRODUCTION**
Installation
============
-----
* The source is on [GitHub](https://github.com/puppetlabs/mcollective-plugins/tree/master/security/none/).
Configuration
=============
-----
Set the following in both server and client config files:
View
2 website/plugin_directory/nrpe_agent.markdown
@@ -1,5 +1,7 @@
---
layout: default
title: "MCollective Plugin: NRPE Agent"
toc: false
---
The documentation for this plugin can be found in its [GitHub Repository](https://github.com/puppetlabs/mcollective-nrpe-agent#readme)
View
16 website/plugin_directory/ohai.markdown
@@ -4,22 +4,22 @@ title: "MCollective Plugin: Ohai"
---
# Overview
## Overview
The Ohai plugin enables mcollective to use [OpsCode Ohai](http://wiki.opscode.com/display/chef/Ohai) as a source for facts about your system.
This plugin uses a 3000 second cache for facts, after that it will reset Ohai and regenerate all the facts, this adds a few seconds or so overhead to discovery.
This plugin uses a 3000 second cache for facts, after that it will reset Ohai and regenerate all the facts, this adds a few seconds or so overhead to discovery.
This plugin is released as Apache License v2 same as the license of Ohai.
This plugin is released as Apache License v2 same as the license of Ohai.
# Installation
## Installation
If you are using MCollective 1.1.0 or newer you need the file `opscodeohai_facts.rb`. Otherwise, use `opscodeohai.rb`.
* The source for the plugin is [GitHub](https://github.com/puppetlabs/mcollective-plugins/tree/master/facts/ohai/)
# Configuration
## Configuration
You can set the following config options in the <em>server.cfg</em>
@@ -35,18 +35,18 @@ If you have Mcollective 1.1.x and newer:
* fact\_cache\_time - how long to cache for, defaults to 300
# Usage
## Usage
You should now be able to do use all your ohai facts in discovery and fact reporting.
<pre>
$ mc-facts platform_version
Report for fact: platform_version
Report for fact: platform_version
5.3 found 3 times
5.4 found 10 times
Finished processing 13 hosts in 5007.51 ms
</pre>
You can also use all these facts in your usual discovery lookups etc.
You can also use all these facts in your usual discovery lookups etc.
View
1 website/plugin_directory/package.markdown
@@ -1,6 +1,7 @@
---
layout: default
title: "MCollective Plugin: Package Agent"
toc: false
---
The documentation for this plugin can be found in its [GitHub Repository](https://github.com/puppetlabs/mcollective-package-agent#readme)
View
6 website/plugin_directory/packages.markdown
@@ -20,17 +20,17 @@ Packages agent tackles the following requirements
1. Include "yum clean expire-cache"
Limitations
===========
-----
Mainly tested on Scientific Linux 6.1.
Installation
============
-----
The source is on [GitHub](https://github.com/jbraeuer/mcollective-plugins/tree/packages/agent/packages/)
Usage
=====
-----
Install multiple packages at a time:
View
8 website/plugin_directory/process_management.markdown
@@ -8,13 +8,13 @@ An agent that can be used for process management like the Unix _pgrep_, _kill_ a
**WARNING:** You should use the _kill_ and _pkill_ actions with extreme caution, you can do extensive damage to the availability of your infrastructure using these.
Installation
============
-----
* The source is on [GitHub](https://github.com/puppetlabs/mcollective-plugins/tree/master/agent/process/)
* You need to have the [sys-proctable](http://raa.ruby-lang.org/project/sys-proctable/) Gem installed
Usage
=====
-----
There is a bundled _pgrep_ utility:
@@ -24,11 +24,11 @@ There is a bundled _pgrep_ utility:
* [ ============================================================> ] 48 / 48
node1.your.com
32470 root 92.805MB ruby /usr/sbin/mcollectived --pid=/var/run/mcollectived.pid
32470 root 92.805MB ruby /usr/sbin/mcollectived --pid=/var/run/mcollectived.pid
node2.your.com
1997 root 40.539MB /usr/bin/ruby /usr/sbin/puppetd --onetime
12316 root 25.676MB ruby /usr/sbin/mcollectived --pid=/var/run/mcollectived.pid
12316 root 25.676MB ruby /usr/sbin/mcollectived --pid=/var/run/mcollectived.pid
&lt;snip&gt;
View
1 website/plugin_directory/puppet_agent.markdown
@@ -1,6 +1,7 @@
---
layout: default
title: "MCollective Plugin: AgentPuppet"
toc: false
---
This is a rewrite of the older Puppetd agent which supports many new features and Puppet 3.
View
20 website/plugin_directory/puppet_ca.markdown
@@ -6,18 +6,17 @@ title: "MCollective Plugin: Puppet CA Agent"
This agent lets you sign, list, revoke and clean certificates on your Puppet Certificate Authorities
Installation
============
-----
* The source is on [GitHub](https://github.com/puppetlabs/mcollective-plugins/tree/master/agent/puppetca/)
Usage
=====
-----
The commands available are shown below:
List:
-----
### List:
<pre>
% mco rpc puppetca list
@@ -41,8 +40,7 @@ puppet2.your.net:
[]
</pre>
Sign:
-----
### Sign:
<pre>
% mco rpc puppetca sign certname=host3.your.net
@@ -62,8 +60,7 @@ puppet1.your.net
Finished processing 2 / 2 hosts in 1207.45 ms
</pre>
Revoke:
-------
### Revoke:
Note how puppetca doesn't behave too well when you ask it to revoke a certificate that doesn't exist, doesn't cause problems though
@@ -74,15 +71,14 @@ Determining the amount of hosts matching filter for 2 seconds .... 2
* [ ============================================================> ] 2 / 2
puppet1.your.net
puppet1.your.net
Result: notice: Revoked certificate with serial 156
puppet2.your.net
Result: notice: Revoked certificate with serial # Inventory of signed certificates
</pre>
Clean
-----
### Clean
<pre>
% mco rpc puppetca clean certname=host3.your.net
@@ -91,7 +87,7 @@ Determining the amount of hosts matching filter for 2 seconds .... 2
* [ ============================================================> ] 2 / 2
monitor3.your.net
monitor3.your.net
Result: Removed signed cert: /var/lib/puppet/ssl/ca/signed/host3.your.net.pem.
View
4 website/plugin_directory/registration_metadata.markdown
@@ -10,13 +10,13 @@ Sends all available metadata via the registration mechanism, at present this is:
* List of all classes
Installation
============
-----
* The source is on [GitHub](https://github.com/puppetlabs/mcollective-plugins/tree/master/registration/).
Configuration
=============
-----
For full details about the registration system see [Registration](http://docs.puppetlabs.com/mcollective/reference/plugins/registration.html)
View
1 website/plugin_directory/resources_data_plugin.markdown
@@ -1,6 +1,7 @@
---
layout: default
title: "MCollective Plugin: Resources Data"
toc: false
---
This plugin has been incorporated into the new Puppet agent, which can be found on [GitHub](https://github.com/puppetlabs/mcollective-puppet-agent#readme).
View
1 website/plugin_directory/services.markdown
@@ -1,6 +1,7 @@
---
layout: default
title: "MCollective Plugin: Services Agent"
toc: false
---
The documentation for this plugin can be found in its [GitHub Repository](https://github.com/puppetlabs/mcollective-service-agent#readme)
View
21 website/plugin_directory/stomp_util.markdown
@@ -8,15 +8,15 @@ title: "MCollective Plugin: STOMP Utilities"
Helpers and utilities for the MCollective STOMP connector
Installation
============
-----
The source is on [GitHub](https://github.com/puppetlabs/mcollective-plugins/tree/master/agent/stomputil/)
Usage
=====
-----
### Connection Information
Connection Information:
-----------------------
The idea is that if you have a network with failover STOMP servers you might need some visibility about what is connected where, this agent and bundled utility will help you with that.
<pre>
@@ -26,7 +26,7 @@ Determining the amount of hosts matching filter for 2 seconds .... 1
* [ ============================================================> ] 1 / 1
node1.your.net
node1.your.net
Host: stomp1.your.net
Address: 192.168.1.10
Protocol: AF_INET
@@ -39,25 +39,24 @@ You can also view all the nodes using the peer map utility.
<pre>
$ mc-peermap country
stomp1.your.net -+ 22 nodes with 16.08ms average ping [de]
stomp1.your.net -+ 22 nodes with 16.08ms average ping [de]
|-node1.your.net
&lt;snip&gt;
stomp3.your.net -+ 19 nodes with 123.07ms average ping [uk]
stomp3.your.net -+ 19 nodes with 123.07ms average ping [uk]
|-node10.your.net
&lt;snip&gt;
stomp2.your.net -+ 7 nodes with 363.30ms average ping [us]
stomp2.your.net -+ 7 nodes with 363.30ms average ping [us]
|-node20.your.net
&lt;snip&gt;
</pre>
Notice that I specified _country_ on the command line this causes the fact country for each STOMP server to be displayed in the output.
Reconnect:
----------
### Reconnect:
If you determined with the command above that you have nodes you'd rather reconnect to their primary STOMP server use this to disconnect and reconnect to the middleware, recreating all subscriptions and reloading all agents.
@@ -70,7 +69,7 @@ Determining the amount of hosts matching filter for 2 seconds .... 1
* [ ============================================================> ] 1 / 1
nod1.your.net
nod1.your.net
Restarted: 1
View
10 website/plugin_directory/sysctl_data.markdown
@@ -1,5 +1,9 @@
Introduction
------------
---
layout: default
title: "MCollective Plugin: Sysctl Data"
toc: false
---
This plugin can retrive a value from a Linux sysctl variable to be used in agents and discovery.
@@ -11,7 +15,7 @@ $ mco find -S "sysctl('net.ipv4.conf.all.forwarding').value=1"
Installation
=======
------
* The source is on [GitHub](https://github.com/puppetlabs/mcollective-plugins/tree/master/data/sysctl/).
View
2 website/reference/basic/messageformat.md
@@ -2,7 +2,7 @@
layout: default
title: Message Format
---
[SecurityPlugins]: http://github.com/puppetlabs/marionette-collective/tree/master/plugins/mcollective/security/
[SecurityPlugins]: http://github.com/puppetlabs/marionette-collective/tree/master/lib/mcollective/security/
[SimpleRPCIntroduction]: /mcollective/simplerpc/
[MessageFlow]: messageflow.html
[ScreenCast]: /mcollective/screencasts.html#message_flow
View
4 website/reference/plugins/aggregate.md
@@ -3,7 +3,7 @@ layout: default
title: Aggregate Plugins
---
[DDL]: /mcollective/reference/plugins/ddl.html
[Examples]: https://github.com/puppetlabs/marionette-collective/tree/master/plugins/mcollective/aggregate
[Examples]: https://github.com/puppetlabs/marionette-collective/tree/master/lib/mcollective/aggregate
## Overview
MCollective Agents return data and we try to provide as much usable user
@@ -365,5 +365,3 @@ end
Add the last few lines - we check that we're running in a version of MCollective
that supports this feature and then we call our function with the *:exitcode*
results.