Forge Home

salt

Puppet module to install and configure SaltStack.

8,458 downloads

8,089 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.2 (latest)
  • 0.1.1
  • 0.1.0
released Dec 7th 2015
This version is compatible with:

Start using this module

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

Add this module to your Puppetfile:

mod 'beardedeagle-salt', '0.1.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add beardedeagle-salt
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install beardedeagle-salt --version 0.1.2

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

beardedeagle/salt — version 0.1.2 Dec 7th 2015

#puppet-salt Build Status

####Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with salt
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. TODO

salt Puppet Module

Manage salt server, client, cloud, api, syndic and ssh via Puppet. By default no parameters are set for master, minion, cloud, api, syndic and salt-ssh because SaltStack provides sane defaults for most of these (exceptions being api_port and syndic_syndic_master).

##Module Description

This module can be used to install a single salt master, minion, cloud, api, syndic, ssh or all on one machine.

##Setup

###What salt affects

  • salt master/minion/cloud/api/syndic/ssh package.
  • salt master/minion/cloud/api/syndic/ssh configuration files.
  • salt master/minion/api/syndic service.

###Beginning with salt

Just add manifest:

include salt

Or if you want to change params you need to include the underlying modules:

class { 'salt::minion': minion_package_name => 'salt-minion-git', }
class { 'salt::master': master_package_name => 'salt-master-git', }

##Usage

All interaction with the salt module can be done through the main salt class. All services EXCEPT salt-minion rely on salt-master and will be installed along side whatever additional service you specify.

###I just want salt, what's the minimum I need?

include '::salt'

###I just want a salt minion?

include '::salt::minion'

###I just want a salt master?

this will install a salt master and a minion for itself.

include '::salt::master'

This is applicable to all salt-$PACKAGENAME included in this module.

##Reference

###Classes

  • 'salt': Main class, includes all the rest.
  • 'salt::minion': Handles salt-minion.
  • 'salt::master': Handles salt-master.
  • 'salt::cloud': Handles salt-cloud.
  • 'salt::api': Handles salt-api.
  • 'salt::syndic': Handles salt-syndic.
  • 'salt::ssh': Handles salt-ssh.
  • 'salt::params': all parameters needed for the rest.

##Limitations

This module has been built on and tested against CentOS >= 5, Puppet >= 3.8.4 and Ruby >=2.0.0.

##TODO

  • Add multi-distro support for latest package installs
  • Add multi-os support
  • Better test coverage