rabbitmq-formula

Travis CI Build Status Semantic Release pre-commit

This formula installs and configures RabbitMQ server on GNU/Linux.

1. 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:

2. Contributing to this repo

2.1. Commit messages

Commit message formatting is significant!!

Please see How to contribute for more details.

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

3. Special notes

None

4. Available states

4.1. rabbitmq

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

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

4.2. rabbitmq.package

This state will install the rabbitmq package and has a dependency on rabbitmq.install via include list.

4.3. rabbitmq.rabbitmqadmin

This state will install the rabbitmqadmin package only.

4.4. rabbitmq.config

This state will configure the rabbitmq service and has a dependency on rabbitmq.install via include list. See pillar.example.

4.5. rabbitmq.service

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

4.6. rabbitmq.clean

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

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

4.7. rabbitmq.service.clean

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

4.8. rabbitmq.rabbitmqadmin.clean

This state will remote the rabbitmqadmin package only.

4.9. rabbitmq.config.clean

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

4.10. rabbitmq.package.clean

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

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

5. Testing

Linux testing is done with kitchen-salt.

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

5.2. bin/kitchen converge

Creates the docker instance and runs the rabbitmq main state, ready for testing.

5.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

5.4. bin/kitchen destroy

Removes the docker instance.

5.5. bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

5.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.