aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorClément Delafargue <39330590+clementd-fretlink@users.noreply.github.com>2020-06-19 15:18:13 +0200
committerGitHub <noreply@github.com>2020-06-19 15:18:13 +0200
commitaf67286adea7da4e01883bb6c60f44a6141e439f (patch)
tree21fa5a6f7e5439c2548432f0c3b0f164cfb50fcb /README.md
parent18c278e2d8f19fe1066908bd6bc631bdb8472333 (diff)
parent8a5d45d789cdb5739f2f6e8490e02b9ffdfa8b2e (diff)
downloadansible-clever-af67286adea7da4e01883bb6c60f44a6141e439f.tar.gz
ansible-clever-af67286adea7da4e01883bb6c60f44a6141e439f.tar.zst
ansible-clever-af67286adea7da4e01883bb6c60f44a6141e439f.zip
Merge pull request #55 from clementd-fretlink/build-flavor
Add optional build flavor configuration
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 469667b..7a4557b 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ It handles the publication over git, as well as domain names, environment variab
13Requirements 13Requirements
14------------ 14------------
15 15
16This role requires `clever-tools` version `2.6.1` or higher.
16 17
17Role Variables 18Role Variables
18-------------- 19--------------
@@ -35,9 +36,10 @@ Variables for the application
35- _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`. 36- _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`.
36- `clever_disable_metrics`: a boolean to disable metrics support. Optional, default to `false`. 37- `clever_disable_metrics`: a boolean to disable metrics support. Optional, default to `false`.
37- `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. 38- `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.
39- `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.
38 40
39Variables specific to deployment, default should be fine: 41Variables specific to deployment, default should be fine:
40- `clever_cli_version`: Version of clever cli tools, default to `0.9.3`. 42- `clever_cli_version`: Version of clever cli tools, default to `2.6.1`.
41- `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`. 43- `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`.
42- `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. 44- `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.
43- `clever_app_confdir`: Path where to store clever cloud data specific to this application, default to `"{{ clever_app_root }}/.clever_cloud"` 45- `clever_app_confdir`: Path where to store clever cloud data specific to this application, default to `"{{ clever_app_root }}/.clever_cloud"`