History

semantic-release-bot 032b522078 chore(release): 0.6.1 [skip ci] ## [0.6.1](https://github.com/saltstack-formulas/keepalived-formula/compare/v0.6.0...v0.6.1) (2021-06-04) ### Bug Fixes * osfamilymap: add package for Gentoo ([`f07212d`](`f07212dfbb`)) * service: service restart handling with watch requisite ([`1ae8918`](`1ae8918f1e`)) ### Continuous Integration * add `arch-master` to matrix and update `.travis.yml` [skip ci] ([`fbc97db`](`fbc97db940`)) * commitlint: ensure `upstream/master` uses main repo URL [skip ci] ([`7bc7b0d`](`7bc7b0d002`)) * gemfile+lock: use `ssf` customised `kitchen-docker` repo [skip ci] ([`5eb060c`](`5eb060cde7`)) * gitlab-ci: add `rubocop` linter (with `allow_failure`) [skip ci] ([`b4ec26c`](`b4ec26cffb`)) * kitchen+ci: use latest pre-salted images (after CVE) [skip ci] ([`d8bce5f`](`d8bce5ff94`)) * kitchen+gitlab: adjust matrix to add `3003` [skip ci] ([`7732d92`](`7732d92457`)) * kitchen+gitlab-ci: use latest pre-salted images [skip ci] ([`bbb13d1`](`bbb13d1b18`)) * pre-commit: update hook for `rubocop` [skip ci] ([`afb12f1`](`afb12f1fa8`)) ### Tests * standardise use of `share` suite & `_mapdata` state [skip ci] ([`89986bf`](`89986bfe5f`))		2021-06-04 15:29:05 +00:00
..
AUTHORS.rst	chore(release): 0.6.1 [skip ci]	2021-06-04 15:29:05 +00:00
CHANGELOG.rst	chore(release): 0.6.1 [skip ci]	2021-06-04 15:29:05 +00:00
README.rst	feat(scripts): deploy helper scripts	2020-11-30 18:10:54 +03:00
TOFS_pattern.rst	ci(pre-commit): finalise `rstcheck` configuration [skip ci]	2020-10-10 06:48:36 +01:00

README.rst

keepalived-formula

Formula to set up and configure keepalived

Table of Contents

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.

Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

Available states

`keepalived`

Installs and configures the keepalived package.

`keepalived.package`

Installs the keepalived package.

`keepalived.config`

This state manages the file keepalived.conf under /etc/keepalived (template found in "keepalived/files"). The configuration is populated by values in "keepalived/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar.

`keepalived.scripts`

Put arbitrary helper scripts on the minion. Default scripts location: /etc/keepalived This state can deploy script, set its permissions like file mode, user and group, but it won't create new user / group if they do not exist.

`keepalived.service`

This state ensures that keepalived service is running.

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 keepalived 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.