1 files changed, 103 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f07f2d4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,103 @@
+## PostgreSQL Ansible role [![Build Status](https://travis-ci.org/trainline-eu/postgresql.svg?branch=master)](https://travis-ci.org/trainline-eu/postgresql)
+
+Ansible role which installs and configures PostgreSQL clusters, databases and users.
+
+#### Installation
+
+This role has been tested on Ansible 2.3.0 and higher.
+
+To install:
+
+```
+ansible-galaxy install trainline-eu.postgresql
+```
+
+
+#### Dependencies
+
+No dependencies
+
+Recommended dependencies:
+- trainline-eu.barman
+
+#### Compatibility matrix
+
+This table lists the tested version of OS/PostgreSQL couples.
+
+| Distribution / PostgreSQL | 9.1 | 9.4 | 9.5 | 9.6 | 10  | 11  |
+| ------------------------- |:---:|:---:|:---:|:---:|:---:|:---:|
+| Debian 8.x | :no_entry: :white_check_mark:| :white_check_mark:| :white_check_mark:| :white_check_mark:| :white_check_mark:| :grey_question:|
+| Debian 9.x | :no_entry: :white_check_mark:| :white_check_mark:| :white_check_mark:| :white_check_mark:| :white_check_mark:| :grey_question:|
+
+- :white_check_mark: - tested, works fine
+- :grey_question: - will work in the future (help out if you can)
+- :interrobang: - maybe works, not tested
+- :no_entry: - PostgreSQL has reached EOL
+
+
+#### Variables
+
+```yaml
+# Basic settings
+postgres_listen_addresses: [ '127.0.0.1' ] # Optional
+postgres_log_dir: '/home/postgres-logs'    # Optional
+postgres_data_dir: '/home/postgres'        # Optional
+postgres_clusters:                         # Mandatory
+  - version: 10                              # Mandatory
+    name: 'main'                             # Mandatory
+    port: 5432                               # Mandatory
+    checksums: True                          # Optional
+    fsync_enabled: False                     # Optional
+    archive_enabled: False                   # Optional
+    # List of users to be created (optional)
+    users:
+      - username: 'replicator'                 # Mandatory
+        password: 'SuperSecret'                # Mandatory
+        permissions: 'REPLICATION'             # Mandatory
+    # List of databases to be created (optional)
+    databases:
+      - dbname: my_database                    # Mandatory
+        owner: john                            # Mandatory
+
+# Postgres config (Optional)
+postgres_log_line_prefix: '%m [%p] database: %d host: %h user: %u '
+postgres_datestyle: 'iso, dmy'
+postgres_locale_formats: fr_FR.UTF-8
+postgres_text_search_config: pg_catalog.french
+
+# Postgres pg_hba config (optional)
+postgres_allowed_hosts:
+  - user: all
+    range: 10.0.0.0/24
+postgres_replication_hosts:
+  - user: replicator
+    range: 10.0.0.0/24
+```
+
+#### Testing
+
+This project comes with a `test/main.yml` testing playbook. It uses `Docker` to provision containers locally and sets up a 3 node postgresql cluster with a barman server.
+
+Coverage of this playbook is probably not complete but at least it's there.
+
+If you are contributing, please first test your changes in a new playbook in the `test/` directory within docker containers, (using the targeted distribution), and if possible, ensure your change is covered in the tests found in [.travis.yml](./.travis.yml).
+
+#### License
+
+Licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
+
+
+#### Thanks
+
+Creators:
+- [Gaëtan Duchaussois](https://twitter.com/gduchaussois)
+- [Théophile Helleboid](https://twitter.com/chtitux)
+- [Paul Bonaud](https://twitter.com/paulRb_r)
+
+Maintainers:
+- [Théophile Helleboid](https://twitter.com/chtitux)
+- [Paul Bonaud](https://twitter.com/paulRb_r)
+
+#### Feedback, bug-reports, requests, ...
+
+Are [welcome](https://github.com/trainline-eu/postgresql/issues)!