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.
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.
This formula uses the Template Override and Files Switch (TOFS) pattern. Refer back to the TOFS docs for more information.
Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute 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. the include list.
template.service
This state will start the template service
and has a dependency on template.config via. the 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. the include list.
template.package.clean
This state will remove the template package
and has a depency on template.config.clean via. the include list.