aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md
index 916a671..2ab8663 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,63 @@
1# ansible-clever 1# ansible-clever
2Ansible role for clever cloud deployment 2Ansible role for clever cloud deployment
3=======
4Clever deploy
5=========
6
7This roles deploy an haskell app on clever cloud (https://www.clever-cloud.com).
8
9Requirements
10------------
11
12
13Role Variables
14--------------
15
16Variables for the application
17- `clever_token`: clever_cloud token, mandatory.
18- `clever_secret`: clever_cloud secret, mandatory.
19- `clever_app`: the id of the app to link, mandatory.
20- `clever_env`: a dict of environment variables for the application (without add_ons one already available), optional.
21- `clever_addons`: a list of dict describing addons enabled for the application from which we would use information during deploy, optional.<br/>
22 Example: `{ name: pg, env_prefix: POSTGRESQL_ADDON }`
23- `clever_app_role`: role to be executed after environment and addons variables where gathered. Specific to an app, should be use to run migrations. Optional.
24- `domain`: the domain from which the application should be reachable, optional
25- `syslog_server`: UDP Syslog server to be used as UDPSyslog drain for the application, optional. Example: `udp://198.51.100.51:12345`.
26
27Variables specific to deployment, default should be fine:
28- `clever_cli_version`: Version of clever cli tools, default to `0.9.3`.
29- `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`.
30- `clever_app_root`: Path of the application to deploy, default to `"{{ playbook_dir }}/.."`, ie ansible directory in the root of the application.
31- `clever_app_confdir`: Path where to store clever cloud data specific to this application, default to `"{{ clever_app_root }}/.clever_cloud"`
32- `clever_login_file`: Path to store login information. Default to `"{{ clever_app_confdir }}/login"`.
33
34
35Dependencies
36------------
37
38None
39
40Example Playbook
41----------------
42
43Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
44
45 - hosts: servers
46 roles:
47 - { role: fretlink.clever, clever_app: 42, clever_token: "{{ vault_clever_token }}", clever_secret: "{{ vault_clever_secret}}" }
48
49
50TODO
51----
52
53Add some tests and Travis integration
54
55License
56-------
57
58BSD
59
60Author Information
61------------------
62
63Developped at Fretlink (https://www.fretlink.com) for our