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
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.
Commit message formatting is significant!!
Please see How to contribute for more details.
None
Meta-state (This is a state that includes other states).
This installs the firefox package, manages the firefox configuration file and then starts the associated firefox service.
This state will install the firefox package only.
This state will configure the firefox service and has a dependency on firefox.install
via include list.
This state will start the firefox service and has a dependency on firefox.config
via include list.
Meta-state (This is a state that includes other states).
this state will undo everything performed in the firefox meta-state in reverse order, i.e.
stops the service,
removes the configuration file and
then uninstalls the package.
This state will stop the firefox service and disable it at boot time.
This state will remove the configuration of the firefox service and has a
dependency on firefox.service.clean via include list.
This state will remove the firefox package and has a depency on
firefox.config.clean via include list.
Meta-state (This is a state that includes other states).
This state installs a subcomponent configuration file before configuring and starting the firefox service.
This state will configure the firefox subcomponent and has a
dependency on firefox.config via include list.
This state will remove the configuration of the firefox subcomponent
and reload the firefox service by a dependency on
firefox.service.running via include list and watch_in
requisite.
Linux testing is done with kitchen-salt.
- 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.
Creates the docker instance and runs the firefox main state, ready for testing.
Runs the inspec tests on the actual instance.
Removes the docker instance.
Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.
Gives you SSH access to the instance for manual testing.