Forge Home

saltstack

saltstack - minion, master, api, cloud, syndic and ssh setup and configuration

10,222 downloads

5,694 latest version

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

Version information

  • 0.1.13 (latest)
  • 0.1.12
  • 0.1.11
  • 0.1.10
  • 0.1.7
  • 0.1.1
released Dec 17th 2018
This version is compatible with:
  • Puppet Enterprise 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.0.0
  • , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'eyp-saltstack', '0.1.13'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add eyp-saltstack
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install eyp-saltstack --version 0.1.13

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

eyp/saltstack — version 0.1.13 Dec 17th 2018

saltstack

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Reference
  6. Limitations
  7. Development

Overview

saltstack - minion, master, api, cloud, syndic and ssh setup and configuration

Module Description

This module installs saltstack components:

  • minion
  • master
  • api
  • cloud
  • syndic
  • ssh

Using a yum/apt repo as appropriate

Setup

What saltstack affects

  • Installs saltstack repo
  • Installs saltstack packages and dependencies
  • Manages configuration files
  • Manages services

Setup Requirements

This module requires pluginsync enabled for puppet <=3.8

Beginning with saltstack

A single node configuration example with ACLs:

class { 'saltstack::minion':
  master => '127.0.0.1'
}

class { 'saltstack::master': }

saltstack::master::fileroot { 'base':
  files => [ '/srv/salt-data/base' ],
}

saltstack::master::pillar { 'base':
  files => [ '/srv/salt-data/pillar' ],
}

class { 'saltstack::cloud': }

class { 'saltstack::api': }

class { 'saltstack::syndic': }

saltstack::master::key { $::fqdn:
  status => 'accepted'
}

saltstack::master::acl { 'saltuser':
  match => [ '.*', '@runner' ],
}

saltstack::master::acl { 'saltuser2':
  match => [ '.*', '@runner' ],
}

Usage

Installing a salt minion

class { 'saltstack::minion':
  master => 'salt-master.systemadmin.es'
}

Installing a salt master

class { 'saltstack::master': }

Selecting a specific salt version

class { 'saltstack::repo':
  version => '2017.7',
}

Reference

references

saltstack::master::key

WARNING: keys are not going to be accepted/rejected in the first run if saltstak is not yet installed

  • hostname: = $name,
  • status: = 'accepted',

classes

saltstack

Placeholder, not needed

saltstack::repo

saltstack repo installation

  • srcdir: Where to store temporal files (default: /usr/local/src)
  • version: saltstack version to install, does not update to the latest once it is already installed (default: latest)

saltstack::minion

  • master: 'saltmaster',
  • master_type: = 'failover',
  • master_failback: = false,
  • random_master: = false,
  • master_port: = '4506',
  • manage_package: = true,
  • package_ensure: = 'installed',
  • manage_service: = true,
  • manage_docker_service: = true,
  • service_ensure: = 'running',
  • service_enable: = true,
  • minion_id: = $::fqdn,
  • hash_type: = 'sha256',

saltstack::master

  • manage_package: = true,
  • package_ensure: = 'installed',
  • manage_service: = true,
  • manage_docker_service: = true,
  • service_ensure: = 'running',
  • service_enable: = true,
  • interface: = '0.0.0.0',
  • ipv6: = false,
  • user: = 'root',
  • publish_port: = '4505',
  • ret_port: = '4506',
  • keep_jobs: = '170',
  • max_event_size: = '10485760',
  • hash_type: = 'sha256',
  • masted_recurse: = true,
  • masted_purge: = true,

saltstack::api

  • manage_package: = true,
  • package_ensure: = 'installed',
  • manage_service: = true,
  • manage_docker_service: = true,
  • service_ensure: = 'running',
  • service_enable: = true,
  • port: = '8000',
  • host: = undef,
  • debug: = false,
  • ssl_crt: = undef,
  • ssl_key: = undef,
  • disable_ssl: = undef,
  • webhook_disable_auth: = false,
  • webhook_url: = undef,
  • thread_pool: = '100',
  • socket_queue_size: = '30',
  • expire_responses: = false,
  • max_request_body_size: = '1048576',
  • collect_stats: = false,
  • static: = undef,
  • static_path: = undef,
  • app: = undef,
  • app_path: = undef,
  • root_prefix: = '/',
  • generate_selfsigned_cert: = true,
  • rest_timeout: = '7200',

saltstack::cloud

  • manage_package: = true,
  • package_ensure: = 'installed',
  • keysize: = '2048',
  • script: = undef,
  • log_file: = '/var/log/salt/cloud',
  • log_level: = 'info',
  • log_level_logfile: = 'info',
  • log_datefmt: = '%Y-%m-%d %H:%M:%S',
  • log_fmt_logfile: = undef,
  • log_granular_levels: = undef,
  • delete_sshkeys: = false,
  • install_windows_dependencies: = true,
  • install_vsphere_dependencies: = true,

saltstack::ssh

  • manage_package: = true,
  • package_ensure: = 'installed',

saltstack::syndic

  • manage_package: = true,
  • package_ensure: = 'installed',
  • manage_service: = true,
  • manage_docker_service: = true,
  • service_ensure: = 'running',
  • service_enable: = true,

Limitations

salt-minion

  • RedHat 6 and derivatives
  • RedHat 7 and derivatives
  • Ubuntu 14.04
  • Ubuntu 16.04
  • Ubuntu 18.04

server components

  • RedHat 7 and derivatives
  • Ubuntu 16.04
  • Ubuntu 18.04

Development

We are pushing to have acceptance testing in place, so any new feature should have some test to check both presence and absence of any feature

TODO

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request