/saltplusplus-formula

Primary LanguageJinjaOtherNOASSERTION

saltplusplus-formula ================

Travis CI Build Status Semantic Release

A SaltStack formula that performs extra configuration steps on a salt master.

Table of Contents

General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

If you need (non-default) configuration, please pay attention to the pillar.example file and/or Special notes section.

Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

Special notes

None

Available states

saltplusplus ^^^^^^^^^^^^

Meta-state (This is a state that includes other states).

This installs the saltplusplus package, manages the saltplusplus configuration file and then starts the associated saltplusplus service. Testing -------

Linux testing is done with kitchen-salt.

Requirements

  • Ruby
  • Docker

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

bin/kitchen converge

Creates the docker instance and runs the saltplusplus main state, ready for testing.

bin/kitchen verify

Runs the inspec tests on the actual instance.

bin/kitchen destroy

Removes the docker instance.

bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.

bin/kitchen login

Gives you SSH access to the instance for manual testing.