e6fb519c66
* Automated using: - https://github.com/myii/ssf-formula/pull/62 - https://github.com/myii/ssf-formula/pull/66 |
||
|---|---|---|
| bin | ||
| docs | ||
| template | ||
| test | ||
| .gitignore | ||
| .rubocop.yml | ||
| .salt-lint | ||
| .travis.yml | ||
| .yamllint | ||
| AUTHORS.md | ||
| CHANGELOG.md | ||
| commitlint.config.js | ||
| FORMULA | ||
| Gemfile | ||
| kitchen.yml | ||
| LICENSE | ||
| pillar.example | ||
| pre-commit_semantic-release.sh | ||
| release-rules.js | ||
| release.config.js | ||
template-formula
A SaltStack formula that is empty. It has dummy content to help with a quick start on a new formula and it serves as a style guide.
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.
Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute <CONTRIBUTING> for more
details.
Available states
template
Meta-state (This is a state that includes other states).
This installs the template package, manages the template configuration file and then starts the associated template service.
template.package
This state will install the template package only.
template.config
This state will configure the template service and has a dependency
on template.install via include list.
template.service
This state will start the template service and has a dependency on
template.config via include list.
template.clean
Meta-state (This is a state that includes other states).
this state will undo everything performed in the
template meta-state in reverse order, i.e. stops the
service, removes the configuration file and then uninstalls the
package.
template.service.clean
This state will stop the template service and disable it at boot time.
template.config.clean
This state will remove the configuration of the template service and
has a dependency on template.service.clean via include
list.
template.package.clean
This state will remove the template package and has a depency on
template.config.clean via include list.
template.subcomponent
Meta-state (This is a state that includes other states).
This state installs a subcomponent configuration file before configuring and starting the template service.
template.subcomponent.config
This state will configure the template subcomponent and has a
dependency on template.config via include list.
template.subcomponent.config.clean
This state will remove the configuration of the template subcomponent
and reload the template service by a dependency on
template.service.running via include list and
watch_in requisite.
Testing
Linux testing is done with kitchen-salt.
Requirements
- Ruby
- Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]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 template 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.