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 refer to:
- how to configure the formula with map.jinja
- the
pillar.examplefile - the Special notes section
Commit message formatting is significant!!
Please see How to contribute for more details.
pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.
First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and
now pre-commit will run automatically on each git commit.
$ bin/install-hooks pre-commit installed at .git/hooks/pre-commit pre-commit installed at .git/hooks/commit-msg
None
victoriametricsvictoriametrics.packagevictoriametrics.configvictoriametrics.servicevictoriametrics.cleanvictoriametrics.service.cleanvictoriametrics.config.cleanvictoriametrics.package.cleanvictoriametrics.subcomponentvictoriametrics.subcomponent.configvictoriametrics.subcomponent.config.clean
Meta-state (This is a state that includes other states).
This installs the victoriametrics package, manages the victoriametrics configuration file and then starts the associated victoriametrics service.
This state will install the victoriametrics package only.
This state will configure the victoriametrics service and has a dependency on victoriametrics.install
via include list.
This state will start the victoriametrics service and has a dependency on victoriametrics.config
via include list.
Meta-state (This is a state that includes other states).
this state will undo everything performed in the victoriametrics meta-state in reverse order, i.e.
stops the service,
removes the configuration file and
then uninstalls the package.
This state will stop the victoriametrics service and disable it at boot time.
This state will remove the configuration of the victoriametrics service and has a
dependency on victoriametrics.service.clean via include list.
This state will remove the victoriametrics package and has a depency on
victoriametrics.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 victoriametrics service.
This state will configure the victoriametrics subcomponent and has a
dependency on victoriametrics.config via include list.
This state will remove the configuration of the victoriametrics subcomponent
and reload the victoriametrics service by a dependency on
victoriametrics.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 victoriametrics 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.