feat(post_deploy): Add a post deploy task to fetch deployed env

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

diff --git a/README.md b/README.md
index 86153aff492061f226ab7f3dec2113fad80d13a4..f156f5cdd5a3b148749894758209c3304f7383d9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -30,7 +30,8 @@ Variables for the application
 - _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.
-- `clever_metrics`: a boolean to enable or disable metrics support. Optional, default to `false`.
+- `clever_metrics`: a boolean to enable or disable metrics support. Optional, default to `true`.
+- `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.
 
 Variables specific to deployment, default should be fine:
 - `clever_cli_version`: Version of clever cli tools, default to `0.9.3`.