Updated documentation

README.rst

@@ -0,0 +1,47 @@
+=======
+cerebro
+=======
+
+Install and configure a Cerebro.
+
+.. note::
+
+ See the full `Salt Formulas installation and usage instructions
+ <http:https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
+
+Available states
+================
+
+.. contents::
+ :local:
+
+``cerebro.user``
+----------------
+
+It creates the ``cerebro`` user and group.
+
+``cerebro.binaries``
+--------------------
+
+It downloads and extracts Cerebro binaries from the tarball.
+
+``cerebro.config``
+------------------
+
+It configures Cerebro by reading from pillar.
+
+``cerebro.service``
+-------------------
+
+It adds and enables a systemd unit for Cerebro.
+
+``cerebro.purge``
+-----------------
+
+It purges the environment generated by this formula.
+
+References
+==========
+
+- `Cerebro <https://github.com/lmenezes/cerebro>`__
+- `Salt Formulas <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`__

pillar.example

@@ -0,0 +1,30 @@
+cerebro:
+ # binaries
+ version: '0.6.5'
+ hash: 'e0fab203496c3216561070df0b2dbd90ade83dfa0dc2fb380a88369958dc1e28'
+ home: /opt/cerebro
+ # user
+ user: cerebro
+ group: cerebro
+ # config
+ secret: 'c@N8<xC@vCq!)&832BtF?`lRi+T)JjV_PT>=J@*g>8qPz->qdr7BKF~a:lG9Ux+T'
+ auth_ldap:
+ enabled: False
+ url: 'ldap:https://host:port'
+ base-dn: 'ou=active,ou=Employee'
+ method: simple
+ user-domain: domain.com
+ auth_basic:
+ enabled: False
+ username: admin
+ password: s3cr3t
+ hosts:
+ - name: "Some Cluster"
+ host: http:https://localhost:9200
+ - name: "Some Authenticated Cluster"
+ host: http:https://authenticated-localhost:9200
+ username: admin
+ password: s3cr3t
+ # service
+ service: cerebro
+ java_home: /path/to/java