PRs are welcome :)

Due to a new job I have only limited posibilities to test this module

Salt Puppet Module

Table of Contents

• Salt Puppet Module

  - [Table of Contents](#table-of-contents)
  

  • Module description
  • Setup
    • What Salt affects
  • Usage
    • Manage Salt minion / master / api / syndic
      • Basic setup
      • Install specific Salt version
        • Pin to Major release
        • Pin to Minor release
      • Install additional packages needed for Salt
    • Manage Salt Pepper
  • Reference
  • Limitations

Module description

The salt module installs, configures, and maintains your SaltStack.

It follows the new Puppet 4 code style guides (no params.pp class -> data dir). Furthermore all parameters are fully configurable over Hiera.

This module is only compatible with Puppet 5.5.8+

Setup

What Salt affects

It can manage

• salt-minion
• salt-master
• salt-api
• salt-syndic
• salt-pepper

It will manage

• salt repo

Usage

For every part to install, minion, master, api, syndic and pepper there is a extra class you'll have to call.

Manage Salt minion / master / api / syndic

The classes for the minion, master, api and syndic are mostly the same.

The following example shows how to manage a Salt master. You can use the same examples to manage the minion, api or syndic. The minion, api and syndic have the same parameters.

Any other parameters are documented in the REFERENCE.md

Basic setup

Include the salt::master class:

include salt::master

Set some configuration parameters:

salt::master::configs:
  log_level: info
  fileserver_backend:
    - roots

You can copy the YAML structure from your existing config file and paste it here. It will paste the YAML as is into the config file.

Per default the deep merging for all hashes is enabled (including the configs hash).

You could also use the salt::master::config::create resource to append some config parameter:

salt::master::config::create { 'append logging config':
  data   => {
    'log_level' => 'info',
  },
}

Install specific Salt version

You can disable the management of the repo:

salt::master::repo_manage: false

Pin to Major release

salt::master::package_release: "major"
salt::master::package_release_version: "3002"

• Installs the package repo for the release given with salt::master::package_release_version

Pin to Minor release

salt::master::package_release: "minor"
salt::master::package_release_version: "3002.1"
salt::master::package_ensure: "%{lookup('salt::master::package_release')}+ds-1"

• Installs the package repo for the release given with salt::master::package_release_version
• Installs the Salt master package in the version given with salt::master::package_ensure

Install additional packages needed for Salt

salt::master::additional_packages:
  - git
  - python3-pygit2

This is for example to use the gitfs backend in the Salt master config.

More information, what you can set in salt::master::additional_packages visit: https://forge.puppet.com/puppetlabs/stdlib/5.2.0/readme#ensure_packages

Manage Salt Pepper

Pepper contains a Python library and CLI scripts for accessing a remote salt-api instance. Official repo ist here

The Pepper Puppet module creates per default the file /etc/profile.d/saltstack-pepper.sh. In this file you can set variables that should be available as exported variables in your login shell. Per default it will set the PEPPERRC environment variable to set the path of the Pepper config file.

salt::pepper::environment_dir: /etc/profile.d
salt::pepper::environment_file: "%{lookup('salt::pepper::environment_dir')}/saltstack-pepper.sh"
salt::pepper::environments:
  - "export PEPPERRC='%{lookup('salt::pepper::config_file')}'"

If you don't want to create and set environment variables, set salt::pepper::environments to undef:

salt::pepper::environments: ~

Per default it will install the Pepper module from pip3 (this is the official recommendation):

salt::pepper::package_ensure: 'latest'
salt::pepper::package_provider: pip3

You can change the provider and the version if needed.

To configure pepper:

salt::pepper::configs:
  main:
    SALTAPI_URL: "https://salt.abc.com/"

The .pepperrc config file needs to be in the INI format.

Reference

See REFERENCE.md

Limitations

Currently this module only works for distros using apt as package manager.

If you want to use this module with any other package manager or any other distro, patch the repo.pp and open a pull request on GitHub.

Reference

Table of Contents

Classes

• salt::api: Init class for the salt-api. Contains all necessary classes and dependencies to manage salt-api.
• salt::api::config: Class: salt::api::config
• salt::api::install: Class: salt::api::install
• salt::api::service: Class: salt::api::service
• salt::master: Init class for the salt-master. Contains all necessary classes and dependencies to manage salt-master.
• salt::master::config: Class: salt::master::config
• salt::master::install: Class: salt::master::install
• salt::master::service: Class: salt::master::service
• salt::minion: Init class for the salt-minion. Contains all necessary classes and dependencies to manage salt-minion.
• salt::minion::config: Class: salt::minion::config
• salt::minion::install: Class: salt::minion::install
• salt::minion::service: Class: salt::minion::service
• salt::pepper: Class: salt::pepper
• salt::pepper::config: Class: salt::pepper::config
• salt::pepper::install: Class: salt::pepper::install

Defined types

• salt::api::config::create: Define: salt::api::config::create
• salt::generate_concat: Define: salt::generate_concat
• salt::master::config::create: Define: salt::master::config::create
• salt::minion::config::create: Define: salt::minion::config::create
• salt::repo: Define for the SaltStack Repo Adds the nessesary package repo to download the SaltStack packages.

Functions

• to_direct_yaml: Convert a data structure and output it as YAML

Classes

salt::api

Init class for the salt-api. Contains all necessary classes and dependencies to manage salt-api.

Examples

install salt-api

include salt::api

Parameters

The following parameters are available in the salt::api class.

package_manage

Data type: Boolean

true or false. Manage the package Default: true

package_name

Data type: String[1]

Name of the package to install Default: salt-api

package_ensure

Data type: String

absent or present or any valid package version. Example: 2019.2.0+ds-1 (to install a specific version) Default: lookup('salt::master::package_ensure')

package_release

Data type: String

latest or any valid release. This variable is used for the repo url. More infos here: [https://repo.saltstack.com/] Example: 2019.2.0 (To pin the repo url to a specific version) Default: lookup('salt::master::package_release')

additional_packages

Data type: Optional[Variant[Array, Hash]]

Any additional packages you want to install. More infos, what you can set here: [https://forge.puppet.com/puppetlabs/stdlib/5.2.0/readme#ensure_packages] Default: undef

service_enable

Data type: Boolean

true or false. Enable or disable the service Default: true

service_ensure

Data type: Enum['stopped', 'running']

stopped or running. Default: running

service_name

Data type: String

Set the service name to manage. Default: salt-api

config_dir

Data type: Optional[Stdlib::Absolutepath]

Set the config dir. Default: /etc/salt

config_file

Data type: Stdlib::Absolutepath

Set the absolute config file path. Default: %{lookup('salt::api::config_dir')}/master

configs

Data type: Optional[Hash]

Any config parameter you want to deploy. You can copy the YAML structure from your existing config file and paste it here. Default: undef

salt::api::config

Class: salt::api::config

salt::api::install

Class: salt::api::install

salt::api::service

Class: salt::api::service

salt::master

Init class for the salt-master. Contains all necessary classes and dependencies to manage salt-master.

Examples

install salt-master

include salt::master

Parameters

The following parameters are available in the salt::master class.

package_manage

Data type: Boolean

true or false. Manage the package Default: true

package_name

Data type: String[1]

Name of the package to install Default: salt-master

package_ensure

Data type: String

absent or present or any valid package version. Example: 2019.2.0+ds-1 (to install a specific version) Default: present

package_release

Data type: String

latest or any valid release. This variable is used for the repo url. More infos here: [https://repo.saltstack.com/] Example: 2019.2.0 (To pin the repo url to a specific version) Default: latest

additional_packages

Data type: Optional[Variant[Array, Hash]]

Any additional packages you want to install. More infos, what you can set here: [https://forge.puppet.com/puppetlabs/stdlib/5.2.0/readme#ensure_packages] Default: undef

service_enable

Data type: Boolean

true or false. Enable or disable the service Default: true

service_ensure

Data type: Enum['stopped', 'running']

stopped or running. Default: running

service_name

Data type: String

Set the service name to manage. Default: salt-master

config_dir

Data type: Optional[Stdlib::Absolutepath]

Set the config dir. Default: /etc/salt

config_file

Data type: Stdlib::Absolutepath

Set the absolute config file path. Default: %{lookup('salt::master::config_dir')}/master

configs

Data type: Optional[Hash]

Any config parameter you want to deploy. You can copy the YAML structure from your existing config file and paste it here. Example: log_level: info fileserver_backend:

- roots

Default: undef

salt::master::config

Class: salt::master::config

salt::master::install

Class: salt::master::install

salt::master::service

Class: salt::master::service

salt::minion

Init class for the salt-minion. Contains all necessary classes and dependencies to manage salt-minion.

Examples

install salt-minion

include salt::minion

Parameters

The following parameters are available in the salt::minion class.

package_manage

Data type: Boolean

true or false. Manage the package Default: true

package_name

Data type: String[1]

Name of the package to install Default: salt-minion

package_ensure

Data type: String

absent or present or any valid package version. Example: 2019.2.0+ds-1 (to install a specific version) Default: lookup('salt::master::package_ensure')

package_release

Data type: String

latest or any valid release. This variable is used for the repo url. More infos here: [https://repo.saltstack.com/] Example: 2019.2.0 (To pin the repo url to a specific version) Default: lookup('salt::master::package_release')

additional_packages

Data type: Optional[Variant[Array, Hash]]

Any additional packages you want to install. More infos, what you can set here: [https://forge.puppet.com/puppetlabs/stdlib/5.2.0/readme#ensure_packages] Default: undef

service_enable

Data type: Boolean

true or false. Enable or disable the service Default: true

service_ensure

Data type: Enum['stopped', 'running']

stopped or running. Default: running

service_name

Data type: String

Set the service name to manage. Default: salt-minion

config_dir

Data type: Optional[Stdlib::Absolutepath]

Set the config dir. Default: /etc/salt

config_file

Data type: Stdlib::Absolutepath

Set the absolute config file path. Default: %{lookup('salt::minion::config_dir')}/minion

configs

Data type: Optional[Hash]

Any config parameter you want to deploy. You can copy the YAML structure from your existing config file and paste it here. Default: undef

salt::minion::config

Class: salt::minion::config

salt::minion::install

Class: salt::minion::install

salt::minion::service

Class: salt::minion::service

salt::pepper

Class: salt::pepper

Parameters

The following parameters are available in the salt::pepper class.

package_manage

Data type: Boolean

package_name

Data type: String[1]

package_ensure

Data type: String

package_provider

Data type: String

additional_packages

Data type: Optional[Variant[Array, Hash]]

config_dir

Data type: Optional[Stdlib::Absolutepath]

config_file

Data type: Optional[Stdlib::Absolutepath]

configs

Data type: Optional[Hash]

environment_dir

Data type: Optional[Stdlib::Absolutepath]

environment_file

Data type: Optional[Stdlib::Absolutepath]

environments

Data type: Optional[Array]

salt::pepper::config

Class: salt::pepper::config

salt::pepper::install

Class: salt::pepper::install

Defined types

salt::api::config::create

Define: salt::api::config::create

Parameters

The following parameters are available in the salt::api::config::create defined type.

data

Data type: Hash

target

Data type: String

Default value: $salt::api::config_file

priority

Data type: Integer

Default value: 50

salt::generate_concat

Define: salt::generate_concat

Parameters

The following parameters are available in the salt::generate_concat defined type.

target

Data type: Stdlib::Absolutepath

Default value: $title

salt::master::config::create

Define: salt::master::config::create

Parameters

The following parameters are available in the salt::master::config::create defined type.

data

Data type: Hash

target

Data type: String

Default value: $salt::master::config_file

priority

Data type: Integer

Default value: 50

salt::minion::config::create

Define: salt::minion::config::create

Parameters

The following parameters are available in the salt::minion::config::create defined type.

data

Data type: Hash

target

Data type: String

Default value: $salt::minion::config_file

priority

Data type: Integer

Default value: 50

salt::repo

Define for the SaltStack Repo Adds the nessesary package repo to download the SaltStack packages.

Parameters

The following parameters are available in the salt::repo defined type.

salt_release

Data type: String

latest or any valid release. This variable is used for the repo url. More infos here: [https://repo.saltstack.com/] Example: 2019.2.0 (To pin the repo url to a specific version)

Default value: $title

base_repo_url

Data type: String

Base Repo URL from which to use to download the packages.

Default value: 'http://repo.saltstack.com'

Functions

to_direct_yaml

Type: Ruby 4.x API

Convert a data structure and output it as YAML

Examples

how to output YAML

# output yaml to a file
  file { '/tmp/my.yaml':
    ensure  => file,
    content => to_direct_yaml($myhash),
  }

to_direct_yaml(Any $data)

The to_direct_yaml function.

Returns: String

Examples

how to output YAML

# output yaml to a file
  file { '/tmp/my.yaml':
    ensure  => file,
    content => to_direct_yaml($myhash),
  }

data

Data type: Any

x.x.x (Month Day, Year)

Features

Fixes

2.1.4 (Februar 27, 2023)

Fixes

• Update Repo URL according to latest install instructions (#4, @michaelvdnet)

2.1.3 (Januar 03, 2023)

Features

• Added Ubuntu 22.04 as supported os release
• Update module dependencies (#3, @webmeister)

2.1.2 (August 31, 2022)

Features

• Update module dependencies (#2, @kvedder-amplex)

2.1.1 (December 02, 2021)

Features

• ensure salt-minion package is installed before attempting to start service (#1, @whorka)

2.1.0 (November 09, 2020)

Features

• !! changed parameter salt::(master|minion|api|syndic)::package_release to set latest, major or minor
• added parameter salt::(master|minion|api|syndic)::package_release_version to specify version for major or minor releases

2.0.0 (May 06, 2020)

Features

• !! REMOVED parameter salt::repo::base_repo_url
• added parameter salt::repo::repo_url to set full custom repo url
• added parameter salt::repo::release to set release to use in the apt source string
• added parameter salt::(master|minion|api|syndic)::repo_manage to disable / enable repo management

1.1.0 (January 28, 2020)

Features

• added class to manage salt-syndic

1.0.1 (October 30, 2019)

Features

• added Debian 10 support

Fixes

• fix some package dependencies

1.0.0 (September 9, 2019)

• initial release