{"id":19871880,"url":"https://github.com/saltstack-formulas/rabbitmq-formula","last_synced_at":"2025-04-04T15:09:52.230Z","repository":{"id":8924574,"uuid":"10653563","full_name":"saltstack-formulas/rabbitmq-formula","owner":"saltstack-formulas","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-06T23:10:51.000Z","size":590,"stargazers_count":22,"open_issues_count":9,"forks_count":134,"subscribers_count":36,"default_branch":"master","last_synced_at":"2025-03-28T14:08:58.440Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html","language":"SaltStack","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saltstack-formulas.png","metadata":{"files":{"readme":"docs/README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-06-12T22:14:03.000Z","updated_at":"2023-07-25T13:48:33.000Z","dependencies_parsed_at":"2024-12-29T09:12:34.839Z","dependency_job_id":"82f8d963-0fe3-40ca-be80-cd2e0ca463e8","html_url":"https://github.com/saltstack-formulas/rabbitmq-formula","commit_stats":null,"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Frabbitmq-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Frabbitmq-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Frabbitmq-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Frabbitmq-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack-formulas","download_url":"https://codeload.github.com/saltstack-formulas/rabbitmq-formula/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247198463,"owners_count":20900080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T16:13:53.033Z","updated_at":"2025-04-04T15:09:52.208Z","avatar_url":"https://github.com/saltstack-formulas.png","language":"SaltStack","funding_links":[],"categories":[],"sub_categories":[],"readme":".. _readme:\n\nrabbitmq-formula\n================\n\n|img_travis| |img_sr| |img_pc|\n\n.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/rabbitmq-formula.svg?branch=master\n   :alt: Travis CI Build Status\n   :scale: 100%\n   :target: https://travis-ci.com/saltstack-formulas/rabbitmq-formula\n.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :alt: Semantic Release\n   :scale: 100%\n   :target: https://github.com/semantic-release/semantic-release\n.. |img_pc| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\n   :alt: pre-commit\n   :scale: 100%\n   :target: https://github.com/pre-commit/pre-commit\n\nThis formula installs and configures RabbitMQ server on GNU/Linux.\n\n.. contents:: **Table of Contents**\n   :depth: 1\n\nGeneral notes\n-------------\n\nSee the full `SaltStack Formulas installation and usage instructions\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html\u003e`_.\n\nIf you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas\u003e`_.\n\nIf you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,\nwhich contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.\n\nSee `Formula Versioning Section \u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nIf you need (non-default) configuration, please refer to:\n\n- `how to configure the formula with map.jinja \u003cmap.jinja.rst\u003e`_\n- the ``pillar.example`` file\n- the `Special notes`_ section\n\nContributing to this repo\n-------------------------\n\nCommit messages\n^^^^^^^^^^^^^^^\n\n**Commit message formatting is significant!!**\n\nPlease see `How to contribute \u003chttps://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst\u003e`_ for more details.\n\npre-commit\n^^^^^^^^^^\n\n`pre-commit \u003chttps://pre-commit.com/\u003e`_ is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.\nFirst install  the ``pre-commit`` package manager using the appropriate `method \u003chttps://pre-commit.com/#installation\u003e`_, then run ``bin/install-hooks`` and\nnow ``pre-commit`` will run automatically on each ``git commit``. ::\n\n  $ bin/install-hooks\n  pre-commit installed at .git/hooks/pre-commit\n  pre-commit installed at .git/hooks/commit-msg\n\nSpecial notes\n-------------\n\nThe default node in any rabbitmq installation is 'rabbit@localhost'. Multiple nodes per host are allowed if defined in pillar data under `rabbitmq:nodes`.  Clustering is supported, see `pillar.example`.\n\nAvailable states\n----------------\n\n.. contents::\n   :local:\n\n``rabbitmq``\n^^^^^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nThis installs the rabbitmq package,\nmanages the rabbitmq configuration file and then\nstarts the associated rabbitmq service.\n\n``rabbitmq.package``\n^^^^^^^^^^^^^^^^^^^^\n\nThis state will install the rabbitmq package and has a dependency on ``rabbitmq.install``\nvia include list.\n\n``rabbitmq.config``\n^^^^^^^^^^^^^^^^^^^\n\nThis state will configure the rabbitmq service and has a dependency on ``rabbitmq.install``\nvia include list. It excludes ``rabbitmq.config.cluster`` state\n\n``rabbitmq.service``\n^^^^^^^^^^^^^^^^^^^^\n\nThis state will start the rabbitmq service and has a dependency on ``rabbitmq.config``\nvia include list.\n\n``rabbitmq.clean``\n^^^^^^^^^^^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nthis state will undo everything performed in the ``rabbitmq`` meta-state in reverse order, i.e.\nstops the service,\nremoves the configuration file and\nthen uninstalls the package.\n\n``rabbitmq.service.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will stop the rabbitmq service and disable it at boot time.\n\n``rabbitmq.config.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will remove the configuration of the rabbitmq service and has a\ndependency on ``rabbitmq.service.clean`` via include list.\n\n``rabbitmq.package.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will remove the rabbitmq package and has a depency on\n``rabbitmq.config.clean`` via include list.\n\n*Meta-state (This is a state that includes other states)*.\n\nTesting\n-------\n\nLinux testing is done with ``kitchen-salt``.\n\nRequirements\n^^^^^^^^^^^^\n\n* Ruby\n* Docker\n\n.. code-block:: bash\n\n   $ gem install bundler\n   $ bundle install\n   $ bin/kitchen test [platform]\n\nWhere ``[platform]`` is the platform name defined in ``kitchen.yml``,\ne.g. ``debian-9-2019-2-py3``.\n\n``bin/kitchen converge``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nCreates the docker instance and runs the ``rabbitmq`` main state, ready for testing.\n\n``bin/kitchen verify``\n^^^^^^^^^^^^^^^^^^^^^^\n\nRuns the ``inspec`` tests on the actual instance.\n\n``bin/kitchen destroy``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nRemoves the docker instance.\n\n``bin/kitchen test``\n^^^^^^^^^^^^^^^^^^^^\n\nRuns all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.\n\n``bin/kitchen login``\n^^^^^^^^^^^^^^^^^^^^^\n\nGives you SSH access to the instance for manual testing.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Frabbitmq-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack-formulas%2Frabbitmq-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Frabbitmq-formula/lists"}