X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=9141b117936266830758603e431f2e6438dcda54;hb=65b86d1f9c763b4a0cbb29b76d8f21035ef703af;hp=ff316532233ba8e2118f4ba15232f37ccd34a62d;hpb=36858ff42eae09bd653d7fec8b770c93d91a06ab;p=github%2Ffretlink%2Fansible-clever.git diff --git a/README.md b/README.md index ff31653..9141b11 100644 --- a/README.md +++ b/README.md @@ -20,22 +20,24 @@ 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.
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. -- `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`. - `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 `"{{ playbook_dir }}/.."`, ie ansible directory in the root of the application. +- `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"`.