odairmario / ntp-saltstack-formula

A saltstack formula to setup ntp client

ntp-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
• Testing

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 refer to:

• how to configure the formula with map.jinja
• the pillar.example file
• the Special notes section

Contributing to this repo

Commit messages

Commit message formatting is significant!!

Please see How to contribute for more details.

pre-commit

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

Special notes

None

Available states

• ntp
• ntp.package
• ntp.config
• ntp.service
• ntp.clean
• ntp.service.clean
• ntp.config.clean
• ntp.package.clean
• ntp.subcomponent
• ntp.subcomponent.config
• ntp.subcomponent.config.clean

ntp

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

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

ntp.package

This state will install the ntp package only.

ntp.config

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

ntp.service

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

ntp.clean

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

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

ntp.service.clean

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

ntp.config.clean

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

ntp.package.clean

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

ntp.subcomponent

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

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

ntp.subcomponent.config

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

ntp.subcomponent.config.clean

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