aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index eaddbd5..499dced 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ Requirements
13 13
14This role requires [`clever-tools`](https://github.com/CleverCloud/clever-tools) CLI version `2.6.1` or higher. 14This role requires [`clever-tools`](https://github.com/CleverCloud/clever-tools) CLI version `2.6.1` or higher.
15 15
16If you want to configure this role with [Dhall](https://dhall-lang.org/) instead of YAML, the dhall bindings defined in the `dhall/` directory will need Dhall version `1.26.0` or higher. 16If you want to configure this role with [Dhall](https://dhall-lang.org/) instead of YAML, the role publishes dhall bindings defined in the `dhall/package.dhall` file. These bindings will need Dhall version `1.26.0` or higher.
17 17
18Role Variables 18Role Variables
19-------------- 19--------------
@@ -37,11 +37,11 @@ Variables for the application:
37- `clever_service_dependencies`: a list of the service dependencies needed by the application (each service being a dict containing either an `app_id` field, or an `addon_id` field), optional.<br/> 37- `clever_service_dependencies`: a list of the service dependencies needed by the application (each service being a dict containing either an `app_id` field, or an `addon_id` field), optional.<br/>
38 Example: `[{ addon_id: addon_00000000-0000-0000-0000-000000000000 }, { app_id: app_00000000-0000-0000-0000-000000000000 }]` 38 Example: `[{ addon_id: addon_00000000-0000-0000-0000-000000000000 }, { app_id: app_00000000-0000-0000-0000-000000000000 }]`
39 39
40Variables specific to deployment, defaults should be fine: 40Variables **specific to deployment**, defaults should be fine:
41 41
42- `clever_app_root`: Path of the application to deploy, default to `app_root` if defined or `"{{ playbook_dir }}/.."` otherwise. I.e. the default behaviour will work fine if you define a playbook using this role within a directory (e.g. `deployment/` located at the root of the application.
42- `clever_cli_version`: Version of clever cli tools, default to `2.6.1`. 43- `clever_cli_version`: Version of clever cli tools, default to `2.6.1`.
43- `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`. 44- `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`.
44- `clever_app_root`: Path of the application to deploy, default to `app_root` if defined or `"{{ playbook_dir }}/.."` otherwise. I.e. the default behavior will work fine if you define a playbook using this role in a one level deep directory (e.g. `deployment/`) of the root of the application.
45- `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"`
46- `clever_login_file`: Path to store login information. Default to `"{{ clever_app_confdir }}/login"`. 46- `clever_login_file`: Path to store login information. Default to `"{{ clever_app_confdir }}/login"`.
47- `clever_restart_only`: set to `true` to skip any deployment related tasks (domain, scaling, env, deploy, …) and only restart the application. Optional. 47- `clever_restart_only`: set to `true` to skip any deployment related tasks (domain, scaling, env, deploy, …) and only restart the application. Optional.
@@ -72,7 +72,7 @@ None
72Example Playbook 72Example Playbook
73---------------- 73----------------
74 74
75Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: 75This is the most basic usage of the role by specifying at least the clever app id and a clever token & secret pair.
76 76
77 - hosts: localhost 77 - hosts: localhost
78 roles: 78 roles:
@@ -82,6 +82,16 @@ Including an example of how to use your role (for instance, with variables passe
82 clever_token: "{{ vault_clever_token }}", 82 clever_token: "{{ vault_clever_token }}",
83 clever_secret: "{{ vault_clever_secret}}" 83 clever_secret: "{{ vault_clever_secret}}"
84 84
85If you only need a task to restart your clever application, this would be enough:
86
87 - hosts: localhost
88 roles:
89 - role: fretlink.clever,
90 vars:
91 clever_app: app_00000000-0000-0000-0000-000000000000,
92 clever_token: "{{ vault_clever_token }}",
93 clever_secret: "{{ vault_clever_secret}}"
94 clever_restart_only: true
85 95
86Tests 96Tests
87---- 97----
@@ -91,9 +101,9 @@ The role is tested with automated continuous integration on Travis. Please check
91License 101License
92------- 102-------
93 103
94BSD 104MIT (see LICENSE file for details)
95 105
96Author Information 106Author Information
97------------------ 107------------------
98 108
99Developped at Fretlink (https://www.fretlink.com) 109Developed at [Fretlink](https://tech.fretlink.com)