Merge pull request #39 from seegno/enhancement/markdown-readme
Update README to markdown syntax
This commit is contained in:
37
README.md
Normal file
37
README.md
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
# postgres
|
||||||
|
|
||||||
|
It sets up [PostgreSQL](http://www.postgresql.org/).
|
||||||
|
|
||||||
|
For the best practises see [salt formulas installation and usage instructions](http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html)
|
||||||
|
|
||||||
|
## Available states
|
||||||
|
|
||||||
|
|
||||||
|
#### ``postgres``
|
||||||
|
|
||||||
|
Installs the postgresql package.
|
||||||
|
|
||||||
|
#### ``postgres.python``
|
||||||
|
|
||||||
|
Installs the postgresql python module
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
Testing is done wit kitchen-salt
|
||||||
|
|
||||||
|
#### ``kitchen converge``
|
||||||
|
|
||||||
|
Runs the postgres main state
|
||||||
|
|
||||||
|
#### ``kitchen verify``
|
||||||
|
|
||||||
|
Runs serverspec tests on the actual instance
|
||||||
|
|
||||||
|
#### ``kitchen test``
|
||||||
|
|
||||||
|
Builds and runs test from scratch
|
||||||
|
|
||||||
|
#### ``kitchen login``
|
||||||
|
|
||||||
|
Gives you ssh to the vagrant machine for manual testing
|
||||||
|
|
||||||
50
README.rst
50
README.rst
@@ -1,50 +0,0 @@
|
|||||||
========
|
|
||||||
postgres
|
|
||||||
========
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
See the full `Salt Formulas installation and usage instructions
|
|
||||||
<http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
|
|
||||||
|
|
||||||
Available states
|
|
||||||
================
|
|
||||||
|
|
||||||
.. contents::
|
|
||||||
:local:
|
|
||||||
|
|
||||||
``postgres``
|
|
||||||
------------
|
|
||||||
|
|
||||||
Installs the postgresql package.
|
|
||||||
|
|
||||||
``postgres.python``
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
Installs the postgresql python module
|
|
||||||
|
|
||||||
Testing
|
|
||||||
=======
|
|
||||||
|
|
||||||
Testing is done wit kitchen-salt
|
|
||||||
|
|
||||||
``kitchen converge``
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
Runs the postgres main state
|
|
||||||
|
|
||||||
``kitchen verify``
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Runs serverspec tests on the actual instance
|
|
||||||
|
|
||||||
``kitchen test``
|
|
||||||
----------------
|
|
||||||
|
|
||||||
Builds and runs test from scratch
|
|
||||||
|
|
||||||
``kitchen login``
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
Gives you ssh to the vagrant machine for manual testing
|
|
||||||
|
|
||||||
Reference in New Issue
Block a user