sgzijl/puppet-mcollective

Puppet module to manage the Mcollective ecosystem

Puppet module: mcollective¶ ↑

This is a Puppet module for mcollective based on the second generation layout (“NextGen”) of Example42 Puppet Modules.

Made by Alessandro Franceschi / Lab42

Official site: www.example42.com

Official git repository: github.com/example42/puppet-mcollective

Released under the terms of Apache 2 License.

This module requires functions provided by the Example42 Puppi module (you need it even if you don’t use and install Puppi)

For detailed info about the logic and usage patterns of Example42 modules check the DOCS directory on Example42 main modules set.

USAGE - Module specific¶ ↑

The main mcollective class may be configured to install the server agent only, the central client console or the Stomp server (ActiveMq currently)

• A single class definition (can be used on a common baseline class) that manages stomp credentials and installations of the mcollective ecosystem components, according to custom logic)

   class { 'mcollective':
     stomp_host           => 'mq.example42.com',
     stomp_user           => 'mcollective',
     stomp_password       => 'private_server',
     stomp_admin          => 'admin',
     stomp_admin_password => 'private_client',
     psk                  => 'aSecretPreSharedKey',
     install_client       => $::role ? {
       mco     => true,
       default => false,
     },
     install_stomp_server => $::role ? {
       mq      => true,
       default => false,
     },
  }

Currently only psk security is supported. Client and Servers have different users and passwors to improve (a bit) the security of this approach (an hijacked server can’t become a client without knowing the admin username and password).

USAGE - Basic management¶ ↑

• Install mcollective with default settings

  class { 'mcollective': }

• Install a specific version of mcollective package

  class { 'mcollective':
    version => '1.0.1',
  }

• Disable mcollective service.

  class { 'mcollective':
    disable => true
  }

• Remove mcollective package

  class { 'mcollective':
    absent => true
  }

• Enable auditing without without making changes on existing mcollective configuration files

  class { 'mcollective':
    audit_only => true
  }

USAGE - Overrides and Customizations¶ ↑

• Use custom sources for main config file

  class { 'mcollective':
    source => [ "puppet:///modules/lab42/mcollective/mcollective.conf-${hostname}" , "puppet:///modules/lab42/mcollective/mcollective.conf" ], 
  }

• Use custom source directory for the whole configuration dir

  class { 'mcollective':
    source_dir       => 'puppet:///modules/lab42/mcollective/conf/',
    source_dir_purge => false, # Set to true to purge any existing file not present in $source_dir
  }

• Use custom template for main config file. Note that template and source arguments are alternative.

  class { 'mcollective':
    template => 'example42/mcollective/mcollective.conf.erb',
  }

• Automatically include a custom subclass

  class { 'mcollective':
    my_class => 'mcollective::example42',
  }

USAGE - Example42 extensions management ¶ ↑

• Activate puppi (recommended, but disabled by default)

  class { 'mcollective':
    puppi    => true,
  }

• Activate puppi and use a custom puppi_helper template (to be provided separately with a puppi::helper define ) to customize the output of puppi commands

  class { 'mcollective':
    puppi        => true,
    puppi_helper => 'myhelper', 
  }

• Activate automatic monitoring (recommended, but disabled by default). This option requires the usage of Example42 monitor and relevant monitor tools modules

  class { 'mcollective':
    monitor      => true,
    monitor_tool => [ 'nagios' , 'monit' , 'munin' ],
  }

• Activate automatic firewalling. This option requires the usage of Example42 firewall and relevant firewall tools modules

  class { 'mcollective':       
    firewall      => true,
    firewall_tool => 'iptables',
    firewall_src  => '10.42.0.0/24',
    firewall_dst  => $ipaddress_eth0,
  }