======================= saltstack-mysql-formula

.. image:: https://img.shields.io/badge/donate-flattr-red.svg :alt: Donate via flattr :target: https://flattr.com/profile/bechtoldt

.. image:: https://img.shields.io/gratipay/bechtoldt.svg :alt: Donate via Gratipay :target: https://www.gratipay.com/bechtoldt/

.. image:: https://img.shields.io/badge/license-Apache--2.0-blue.svg :alt: Apache-2.0-licensed :target: https://github.com/bechtoldt/saltstack-mysql-formula/blob/master/LICENSE

.. image:: https://img.shields.io/badge/chat-gitter-brightgreen.svg :alt: Join Gitter Chat :target: https://gitter.im/bechtoldt/saltstack-mysql-formula?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. image:: https://img.shields.io/badge/chat-%23salt%20@%20Freenode-brightgreen.svg :alt: Join Internet Relay Chat :target: http://webchat.freenode.net/?channels=%23salt&uio=d4

SaltStack formula to set up and configure MySQL and MariaDB, a relational database management system

.. contents:: :backlinks: none :local:

Instructions

Please refer to https://github.com/bechtoldt/formula-docs to learn how to use this formula, how it is built and how you can add your changes.

NOTICE: This formula might uses the formhelper module which is a very useful Salt execution module that isn't available in upstream yet. Please consider retrieving it manually from https://github.com/bechtoldt/salt-modules and make it available to your Salt installation. Read SaltStack documentation <http://docs.saltstack.com/en/latest/ref/modules/#modules-are-easy-to-write>_ to see how this can be achieved.

Take a look at older releases (branches) to get a version that isn't using the formhelper yet (if any).

Contributing

Contributions are welcome! All development guidelines we ask you to follow can be found at https://github.com/bechtoldt/formula-docs.

In general:

Fork this repo on Github
Add changes, test them, update docs (README.rst) if possible
Submit your pull request (PR) on Github, wait for feedback

But it’s better to file an issue <https://github.com/bechtoldt/saltstack-mysql-formula/issues/new>_ with your idea first.

TODO

add instructions how to use formhelper, add information about it in the formula-docs (dependency), show up alternative?
table/ matrix: os/salt compatibility (dedicated file)
add list of available states
add tests
manage self-built packages
create galera formula that deploys a notify script (e.g. https://github.com/gguillen/galeranotify)
add doc how to deploy a galera/ xtrabackup cluster
rewrite using #!py renderer
add custom grain modules to determine replication status and more

Authors

Arnold Bechtoldt mail@arnoldbechtoldt.com

Miscellaneous

Recommended formulas:

repo management (see pillarexamples/mariadb.sls): saltstack-repos-formula <https://github.com/bechtoldt/saltstack-repos-formula>
installation of Percona packages: saltstack-percona-formula <https://github.com/bechtoldt/saltstack-percona-formula>_