ENABLE_METRICS => clever_metrics ; default to false

[github/fretlink/ansible-clever.git] / README.md

diff --git a/README.md b/README.md
index 2ab86638bebe7529a3f48eab2879f2e99bf9c199..3e5b3d35815a4072eea712c49f348dd661fc2633 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,12 +17,15 @@ 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_entry_point`: the executable name to be executed by clever cloud, 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_role`: role to be executed after environment and addons variables where gathered. Specific to an app, should be use to run migrations. Optional.
+- `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.
 - `domain`: the domain from which the application should be reachable, optional
 - `syslog_server`: UDP Syslog server to be used as UDPSyslog drain for the application, optional. Example: `udp://198.51.100.51:12345`.
+- `clever_metrics`: a boolean to enable or disable metrics support. Optional, default to `false`.
 
 Variables specific to deployment, default should be fine:
 - `clever_cli_version`: Version of clever cli tools, default to `0.9.3`.