https://github.com/saltstack/kitchen-salt

SaltStack provisioner for test-kitchen
https://github.com/saltstack/kitchen-salt

Last synced: 9 months ago
JSON representation

SaltStack provisioner for test-kitchen

• Host: GitHub
• URL: https://github.com/saltstack/kitchen-salt
• Owner: saltstack
• License: mit
• Created: 2014-01-13T01:39:21.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-05-25T08:40:51.000Z (almost 2 years ago)
• Last Synced: 2025-04-08T10:26:42.694Z (11 months ago)
• Language: Ruby
• Size: 728 KB
• Stars: 198
• Watchers: 30
• Forks: 112
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGE.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# kitchen-salt #

[![Gem Version](https://badge.fury.io/rb/kitchen-salt.svg)](https://badge.fury.io/rb/kitchen-salt)

[![Gem Downloads](https://ruby-gem-downloads-badge.herokuapp.com/kitchen-salt?type=total&color=brightgreen)](https://rubygems.org/gems/kitchen-salt)

[![Build Status](https://github.com/saltstack/kitchen-salt/workflows/Tests/badge.svg)](https://github.com/saltstack/kitchen-salt/actions)

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](docs/gettingstarted.md).

## Provisioner Options ##

More details on all the configuration options are in the [provisioner_options documentation](docs/provisioner_options.md).

## Requirements ##

You'll need a driver box that is supported by the SaltStack [bootstrap](https://github.com/saltstack/salt-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