vboxapi-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
• Contributing to this repo
• Special notes
• Available states
  • vboxapi
  • vboxapi.package
  • vboxapi.config
  • vboxapi.service
  • vboxapi.clean
  • vboxapi.service.clean
  • vboxapi.config.clean
  • vboxapi.package.clean
  • vboxapi.subcomponent
  • vboxapi.subcomponent.config
  • vboxapi.subcomponent.config.clean
• Testing
  • Requirements
  • bin/kitchen converge
  • bin/kitchen verify
  • bin/kitchen destroy
  • bin/kitchen test
  • bin/kitchen login

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

• vboxapi
• vboxapi.package
• vboxapi.config
• vboxapi.service
• vboxapi.clean
• vboxapi.service.clean
• vboxapi.config.clean
• vboxapi.package.clean
• vboxapi.subcomponent
• vboxapi.subcomponent.config
• vboxapi.subcomponent.config.clean

vboxapi

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

This installs the vboxapi package, manages the vboxapi configuration file and then starts the associated vboxapi service.

vboxapi.package

This state will install the vboxapi package only.

vboxapi.config

This state will configure the vboxapi service and has a dependency on vboxapi.install via include list.

vboxapi.service

This state will start the vboxapi service and has a dependency on vboxapi.config via include list.

vboxapi.clean

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

this state will undo everything performed in the vboxapi meta-state in reverse order, i.e. stops the service, removes the configuration file and then uninstalls the package.

vboxapi.service.clean

This state will stop the vboxapi service and disable it at boot time.

vboxapi.config.clean

This state will remove the configuration of the vboxapi service and has a dependency on vboxapi.service.clean via include list.

vboxapi.package.clean

This state will remove the vboxapi package and has a depency on vboxapi.config.clean via include list.

vboxapi.subcomponent

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

This state installs a subcomponent configuration file before configuring and starting the vboxapi service.

vboxapi.subcomponent.config

This state will configure the vboxapi subcomponent and has a dependency on vboxapi.config via include list.

vboxapi.subcomponent.config.clean

This state will remove the configuration of the vboxapi subcomponent and reload the vboxapi service by a dependency on vboxapi.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 vboxapi 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.