How to install Cumin

From ppwiki
Revision as of 23:47, 5 October 2019 by Admin (talk | contribs)
Jump to navigation Jump to search

Cumin is open Source program written in Python that allows you to execute multiple commands on multiple hosts in parallel. For more information on Cumin please see the references section.

Prerequisites

For this tutorial, you need:

- pupetmaster node

- puppetdb node

- cumin node

- some nodes for testing

Environment

Nodes names

All nodes in this tutorial are running Debian Stretch with Puppet 6

- Puppetmaster1002 : Puppet master node

- Puppetdb1002 : PuppetDb node

- cumin1001 : Running cumin

- lab1001: Test node

Installation

One of the required package for Cumin 3.0.2 is python3-clustershell. Debian Stretch doesn't have that package so you will need to download it manually on your puppetmaster and the cumin class will install it. ( See cumin class below) 

ppaul@cumin1001:~$ sudo apt-get install python3-clustershell
Reading package lists... Done
Building dependency tree       
Reading state information... Done
E: Unable to locate package python3-clustershell

You can also install Debian Buster if you want on the cumin node since Debian Buster has the package.

- Test from a node running Debian Buster 

ppaul@lab1002:~$ sudo apt-get install python3-clustershell
Reading package lists... Done
Building dependency tree       
Reading state information... Done
Suggested packages:
 vim-addon-manager
The following NEW packages will be installed:
 python3-clustershell
0 upgraded, 1 newly installed, 0 to remove and 1 not upgraded.
Need to get 126 kB of archives.
After this operation, 625 kB of additional disk space will be used.
Get:1 http://apt1001.dfw.labnet/debian buster/main amd64 python3-clustershell all 1.8.1-1 [126 kB]
Fetched 126 kB in 1s (249 kB/s)          
Selecting previously unselected package python3-clustershell.
(Reading database ... 57033 files and directories currently installed.)
Preparing to unpack .../python3-clustershell_1.8.1-1_all.deb ...
Unpacking python3-clustershell (1.8.1-1) ...
Setting up python3-clustershell (1.8.1-1) ...

cumin Class

On your puppetmaster create the cumin class 

cd /etc/puppetlabs/code/environments/production/modules
sudo mkdir cumin
cd cumin
sudo mkdir manifests
sudo mkdir templates
cd manifests

Create the master.pp file, copy and paste the contain below 

class profile::cumin::master (
   $puppetdb_host  = hiera('puppetdb_host'),
) {
   $cumin_log_path = '/var/log/cumin'
     require_package([
       'python3-dnspython',
       'python3-colorama',
       'python3-pyparsing',
       'python3-tqdm',
       'python3-requests',
       'python3-yaml',
   ])
   file { '/srv/cumin_3.0.2-1_amd64.deb':
     ensure    => present,
     owner      => 'root',
     group      => 'root',
     source     => 'puppet:///modules/cumin/cumin_3.0.2-1_amd64.deb',
   }
   file { '/srv/python3-clustershell_1.8.1-2_all.deb':
     ensure     => present,
     owner      => 'root',
     group      => 'root',
     source     => 'puppet:///modules/cumin/python3-clustershell_1.8.1-2_all.deb',
   }
  package { 'python3-clusterhsell':
     ensure     => installed,
     provider   => dpkg,
     source     => '/srv/python3-clustershell_1.8.1-2_all.deb',
     require    => File['/srv/python3-clustershell_1.8.1-2_all.deb'],
  }
   package { 'cumin':
     ensure     => installed,
     provider   => dpkg,
     source     => '/srv/cumin_3.0.2-1_amd64.deb',
     require    => File['/srv/cumin_3.0.2-1_amd64.deb'],
   } 
   file { $cumin_log_path:
       ensure => directory,
       owner  => 'root',
       group  => 'root',
       mode   => '0750',
   } 
file { '/etc/cumin':
       ensure => directory,
       owner  => 'root',
       group  => 'root',
       mode   => '0755',
   }
  file { '/etc/cumin/config.yaml':
       ensure  => present,
       owner   => 'root',
       group   => 'root',
       mode    => '0640',
       content => template('cumin/config.yaml.erb'),
       require => File['/etc/cumin'],
   }
   file { '/etc/cumin/config-installer.yaml':
       ensure  => present,
       owner   => 'root',
       group   => 'root',
       mode    => '0640',
       content => template('cumin/config-installer.yaml.erb'),
       require => File['/etc/cumin'],
   }
   file { '/etc/cumin/aliases.yaml':
       ensure  => present,
       owner   => 'root',
       group   => 'root',
       mode    => '0644',
       content => template('cumin/aliases.yaml.erb'),
       require => File['/etc/cumin'],
   }
if os_version('debian == stretch') {
       $python_version = '3.5'
   } else {
       $python_version = '3.6'
   }
}

File needed

Download cumin_3.0.2-1_amd64.deb and python3-clustershell_1.8.1-2_all.deb and save those files in /etc/puppetlabs/code/environments/production/modules/cumin/files 

http://ftp.us.debian.org/debian/pool/main/c/clustershell/python3-clustershell_1.8.1-2_all.deb
https://github.com/wikimedia/cumin/releases/download/v3.0.2/cumin_3.0.2-1_amd64.deb

Create aliases.yaml.erb, config-installer.yaml.erb and config.yaml.erb in /etc/puppetlabs/code/environments/production/modules/cumin/templates For now we are going just to focus on the config.yaml.erb file. Open the config.yaml.erb and copy and paste the contain below. Leave the other files empty for now. 

transport: clustershell
 log_file: <%= @cumin_log_path %>/cumin.log
default_backend: puppetdb
environment:
    SSH_AUTH_SOCK: /run/keyholder/proxy.sock
puppetdb:
    host: <%= @puppetdb_host %>
    port: 8081
    api_version: 4
<% if scope.function_os_version(['debian >= stretch']) -%>
    urllib3_disable_warnings:
      - SubjectAltNameWarning
<% end -%>
knownhosts:
    files:
        - /etc/ssh/ssh_known_hosts
clustershell:
    ssh_options:
        - '-o BatchMode=yes'
        - '-o ConnectTimeout=2'
        - '-o StrictHostKeyChecking=yes'

Configure hiera

-Add puppetdb_host to cumin1001.yaml in hiera 

puppetdb_host: puppetdb1002.dfw.labnet

-Add cumin IP address to common.yaml in hiera 

 cumin_masters:
- 10.192.48.13

Apply the cumin class

Open your site.pp file and apply the cumin class to your cumin node 

node 'cumin1001.dfw.labnet' {
       include cumin::master
}

Install Cumin

On the cumin node run 

sudo puppet agent -t

verification

navigate to /usr/lib/python3/dist-packages/ and make sure that the cumin folder is there 

ppaul@cumin1001:/usr/lib/python3/dist-packages/cumin$ ls -l
total 60
drwxr-xr-x 3 root root  4096 Oct  5 12:56 backends
-rw-r--r-- 1 root root 19656 Jul 30  2018 cli.py
-rw-r--r-- 1 root root  6051 Jul 30  2018 grammar.py
-rw-r--r-- 1 root root  4852 Jul 30  2018 __init__.py
drwxr-xr-x 2 root root  4096 Oct  5 12:56 __pycache__
-rw-r--r-- 1 root root  6877 Jul 30  2018 query.py
-rw-r--r-- 1 root root  2068 Jul 30  2018 transport.py
drwxr-xr-x 3 root root  4096 Oct  5 12:56 transports

We have now Cumin installed on our node. The next setup is to configure our cumin node to talk to the puppetdb node

Configuration

Firewall

On the puppetdb node puppetdb1002 only the puppetmaster node and the icinga node are allowed to talk to the puppetdb node. 

8081/tcp                   ALLOW       10.192.16.12      #allow icinga1002.dfw.labnet        
8081/tcp                   ALLOW       10.192.32.4       #allow puppetmaster1002.dfw.labnet

We are going to allow cumin1001.dfw.labnet to talk to the puppetdb node 

8081/tcp                   ALLOW       10.192.48.13 

-Testing

ppaul@cumin1001:/srv$ telnet puppetdb1002.dfw.labnet 8081
Trying 10.192.32.10...
Connected to puppetdb1002.dfw.labnet.
Escape character is '^]'.

We see that our cumin is allow to connect on port 8081 on the puppetdb node

Testing

References

Retrieved from "https://papaulgigitech.com/index.php?title=How_to_install_Cumin&oldid=2855"