Forge Home

mco_rpc

Allow MCO RPC Agents to be run through a task

13,916 downloads

9,761 latest version

4.6 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.1 (latest)
  • 0.1.0
released Jun 29th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x
  • Puppet >= 5.1.0 < 6.0.0
  • , , , , , ,
Tasks:
  • mco_rpc

Start using this module

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

Add this module to your Puppetfile:

mod 'puppetlabs-mco_rpc', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-mco_rpc --version 0.1.1

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.

Download

Documentation

puppetlabs/mco_rpc — version 0.1.1 Jun 29th 2018

mco_rpc

Table of Contents

  1. Description
  2. Requirements
  3. Setup - The basics of getting started with mco_rpc
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.

Description

The mco_rpc module contains a task to run installed rpc agents through Puppet Tasks with either bolt or the Puppet Orchestrator.

Requirements

This module is compatible with Puppet Enterprise and Puppet Bolt.

  • To run tasks with Puppet Enterprise, PE 2017.3 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must be Puppet agents.

  • To run tasks with Puppet Bolt, Bolt 0.5 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must have SSH or WinRM services enabled.

Setup

The Puppet agent package and any rpc agents that are going to be run must be installed on all target nodes. The MCO server does not have to be running and there is no need for MCO middleware or messaging services.

Usage

To run the package task with bolt

bolt task run mco_rpc --modulepath $MODULEPATH --nodes $TARGETNODES agent=package action=install args='package=nano'

To run the package task with puppet task

puppet-task run mco_rpc $TARGETS agent=package action=install arguments='package=nano'

Reference

Parameters

agent String[1]: The MCO RPC agent to run.

action String[1]: The action of the agent to run.

data Optional[Hash]: The options to pass to to the action. These vary per action.

arguments Optional[String]: A single string or arguments to the action as might be passed to the mco CLI ie. 'package=nano verson=2.8.7' This parameter and data are mutually exclusive.

Limitations

This is a pre 1.0.0 release and future versions may have breaking changes. This relies on the Puppet agent packaged ruby and the MCO gem to run.