X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=ef1439396f9ac90ba6bad127bfac77ea4e90f69e;hb=1c1393659bb8adb3273e2434725ae1664287a1c9;hp=916a671077b969655bbf29afc3c79510410159fe;hpb=4882b0d33ce42a3b01ac9689d1809e362f314d3f;p=github%2Ffretlink%2Fansible-clever.git

diff --git a/README.md b/README.md
index 916a671..ef14393 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,76 @@
 # ansible-clever
+
+[![Build Status](https://travis-ci.com/fretlink/ansible-clever.svg?token=D3nFpUxMu7vStDHwUNy4&branch=master)](https://travis-ci.com/fretlink/ansible-clever)
+
 Ansible role for clever cloud deployment
+=======
+Clever deploy
+=========
+
+This role deploys applications on clever cloud (https://www.clever-cloud.com).
+It handles the publication over git, as well as domain names, environment variables and log drains configuration.
+
+Requirements
+------------
+
+
+Role Variables
+--------------
+
+Variables for the application
+- `clever_token`: clever_cloud token, mandatory.
+- `clever_secret`: clever_cloud secret, mandatory.
+- `clever_app`: the id of the app to link, mandatory.
+- `clever_env`: a dict of environment variables for the application (without add_ons one already available), optional.
+- `clever_base_env`: a dict set in vars/main.yml with safe default and mandatory variables for an app to be run on clever. ` clever_base_env | combine(clever_env)` is passed to `clever env` command
+- `clever_addons`: a list of dict describing addons enabled for the application from which we would use information during deploy, optional.<br/>
+  Example: `{ name: pg, env_prefix: POSTGRESQL_ADDON }`
+- `clever_app_tasks_file`: tasks file to be executed after environment and addons variables where gathered. Specific to an app, should be use to run migrations. Optional.
+- `clever_haskell_entry_point`: the haskell executable name to be executed by clever cloud, optional.
+- _Obsolete_: `clever_entry_point`: Same as above but was replaced by `clever_haskell_entry_point` since v1.14 of this role.
+- `clever_domain`: the domain from which the application should be reachable, optional.
+- _Obsolete_: `domain`: Same as above but was replaced by `clever_domain` since v1.4 of this role.
+- `clever_syslog_server`: UDP Syslog server to be used as UDPSyslog drain for the application, optional. Example: `udp://198.51.100.51:12345`.
+- _Obsolete_: `syslog_server`: Same as above but was replaced by `clever_syslog_server` since v1.5 of this role.
+- _Obsolete_: `clever_metrics`: metrics used to be disabled by default. Now they are enabled by default and can be explicitly disabled with `clever_disable_metrics`.
+- `clever_disable_metrics`: a boolean to disable metrics support. Optional, default to `false`.
+- `clever_env_output_file`: as a post deploy task you might need to retrieve the full Clever environment configuration (i.e. with addon env variables). If this variable is set to a filename then the env will be retrieved after a successful deploy inside this file. Optional.
+- `clever_build_flavor`: an optional text value used to configure the size of the dedicated build instance (for instance `S` or `XL`). If not defined, it delegates to clever cloud default behaviour. Setting `disabled` disables the dedicated build instance altogether.
+
+Variables specific to deployment, default should be fine:
+- `clever_cli_version`: Version of clever cli tools, default to `0.9.3`.
+- `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`.
+- `clever_app_root`: Path of the application to deploy, default to `app_root` if defined or `"{{ playbook_dir }}/.."`, ie ansible directory in the root of the application.
+- `clever_app_confdir`: Path where to store clever cloud data specific to this application, default to `"{{ clever_app_root }}/.clever_cloud"`
+- `clever_login_file`: Path to store login information. Default to `"{{ clever_app_confdir }}/login"`.
+
+
+Dependencies
+------------
+
+None
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+    - hosts: servers
+      roles:
+         - { role: fretlink.clever, clever_app: 42, clever_token: "{{ vault_clever_token }}", clever_secret: "{{ vault_clever_secret}}" }
+
+
+TODO
+----
+
+Add some tests and Travis integration
+
+License
+-------
+
+BSD
+
+Author Information
+------------------
+
+Developped at Fretlink (https://www.fretlink.com) for our