X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=f156f5cdd5a3b148749894758209c3304f7383d9;hb=567977285542274d3fef0fd3df556e5f9bbc1f79;hp=3e5b3d35815a4072eea712c49f348dd661fc2633;hpb=914223acdcfa382721ade8d05bd1627867c31370;p=github%2Ffretlink%2Fansible-clever.git diff --git a/README.md b/README.md index 3e5b3d3..f156f5c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # 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 @@ -23,14 +26,17 @@ Variables for the application - `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. -- `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`. +- `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 `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"`.