Skip to content

saltstack/kitchen-salt

Repository files navigation

kitchen-salt

Gem Version Gem Downloads Build Status

A Test Kitchen Provisioner for Salt

The provider works by generating a salt-minion config, creating pillars based on attributes in .kitchen.yml and calling salt-call.

This provisioner is tested with kitchen-docker against CentOS, Ubuntu, and Debian.

Generate and locally view kitchen-salt docs

To view the docs that were originally generated by this repository and hosted by Salt Project, the following should generate a local copy of the documentation.

# Clear any locally generated documentation
rm -rf html/

# Generate HTML documentation of kitchen-salt
bundle install
bundle exec yard doc
firefox html/index.html

# OPTIONAL
# Start a local http server to view the rendered docs
# Accessible via http://localhost:8808/
bundle exec yard server docroot=html/

Installation and Setup

You'll need the test-kitchen and kitchen-salt gem's installed in your system, along with kitchen-vagrant or some other suitable driver for test-kitchen. Please see the gettingstarted documentation.

Provisioner Options

More details on all the configuration options are in the provisioner_options documentation.

Requirements

You'll need a driver box that is supported by the SaltStack bootstrap system.

Continuous Integration and Testing

PR's and other changes should validated using Github Actions, kitchen-docker, multiple state dependencies, the modified version of kitchen-salt and the latest version of test-kitchen.

Releasing

# hack. work. test.
git add stuff
git commit -v
gem bump --release --tag
gem build kitchen-salt.gemspec
gem push kitchen-salt-<version>.gem