https://github.com/saltstack-formulas/zookeeper-formula
https://github.com/saltstack-formulas/zookeeper-formula
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/saltstack-formulas/zookeeper-formula
- Owner: saltstack-formulas
- License: other
- Created: 2014-01-13T14:26:22.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T20:03:30.000Z (about 1 year ago)
- Last Synced: 2025-06-23T05:07:59.501Z (12 months ago)
- Language: Jinja
- Homepage: http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html
- Size: 260 KB
- Stars: 27
- Watchers: 39
- Forks: 81
- Open Issues: 2
-
Metadata Files:
- Readme: docs/README.rst
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
.. _readme:
zookeeper-formula
=================
Installs and Configures Apache Zookeeper from from a tar file.
|img_travis| |img_sr| |img_pc|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/zookeeper-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/zookeeper-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:alt: Semantic Release
:scale: 100%
:target: https://github.com/semantic-release/semantic-release
.. |img_pc| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:alt: pre-commit
:scale: 100%
:target: https://github.com/pre-commit/pre-commit
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.
.. contents:: **Table of Contents**
:depth: 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 pay attention to the ``pillar.example`` file and/or `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
----------------
.. contents::
:local:
``zookeeper``
^^^^^^^^^^^^^
*Meta-state (This is a state that includes other states)*.
This installs the zookeeper package,
manages the zookeeper configuration file and then
starts the associated zookeeper service.
``zookeeper.package``
^^^^^^^^^^^^^^^^^^^^^
This state will install the zookeeper package only.
``zookeeper.config``
^^^^^^^^^^^^^^^^^^^^
This state will configure the zookeeper service and has a dependency on ``zookeeper.install``
via include list.
``zookeeper.service``
^^^^^^^^^^^^^^^^^^^^^
This state will start the zookeeper service and has a dependency on ``zookeeper.config``
via include list.
``zookeeper.clean``
^^^^^^^^^^^^^^^^^^^
*Meta-state (This is a state that includes other states)*.
this state will undo everything performed in the ``zookeeper`` meta-state in reverse order, i.e.
stops the service,
removes the configuration file and
then uninstalls the package.
``zookeeper.service.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will stop the zookeeper service and disable it at boot time.
``zookeeper.config.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove the configuration of the zookeeper service and has a
dependency on ``zookeeper.service.clean`` via include list.
``zookeeper.package.clean``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will remove the zookeeper package and has a depency on
``zookeeper.config.clean`` via include list.
Testing
-------
Linux testing is done with ``kitchen-salt``.
Requirements
^^^^^^^^^^^^
* Ruby
* Docker
.. code-block:: bash
$ 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 ``zookeeper`` 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.