projects / github / fretlink / ansible-clever.git / blame
| Commit | Line | Data |
|---|---|---|
| 4882b0d3 | 1 | # ansible-clever |
| 3ed1cca7 PB |
2 | |
| 3 | [](https://travis-ci.com/fretlink/ansible-clever) | |
| 4 | ||
| 4882b0d3 | 5 | Ansible role for clever cloud deployment |
| f7dd5848 GD |
6 | ======= |
| 7 | Clever deploy | |
| 8 | ========= | |
| 9 | ||
| 10 | This roles deploy an haskell app on clever cloud (https://www.clever-cloud.com). | |
| 11 | ||
| 12 | Requirements | |
| 13 | ------------ | |
| 14 | ||
| 15 | ||
| 16 | Role Variables | |
| 17 | -------------- | |
| 18 | ||
| 19 | Variables for the application | |
| 20 | - `clever_token`: clever_cloud token, mandatory. | |
| 21 | - `clever_secret`: clever_cloud secret, mandatory. | |
| 22 | - `clever_app`: the id of the app to link, mandatory. | |
| f7fe658a | 23 | - `clever_entry_point`: the executable name to be executed by clever cloud, mandatory |
| f7dd5848 | 24 | - `clever_env`: a dict of environment variables for the application (without add_ons one already available), optional. |
| f7fe658a | 25 | - `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 |
| f7dd5848 GD |
26 | - `clever_addons`: a list of dict describing addons enabled for the application from which we would use information during deploy, optional.<br/> |
| 27 | Example: `{ name: pg, env_prefix: POSTGRESQL_ADDON }` | |
| f7fe658a | 28 | - `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. |
| 1157a45f PB |
29 | - `clever_domain`: the domain from which the application should be reachable, optional. |
| 30 | - _Obsolete_: `domain`: Same as above but was replaced by `clever_domain` since v1.4 of this role. | |
| 23c0fc8a PB |
31 | - `clever_syslog_server`: UDP Syslog server to be used as UDPSyslog drain for the application, optional. Example: `udp://198.51.100.51:12345`. |
| 32 | - _Obsolete_: `syslog_server`: Same as above but was replaced by `clever_syslog_server` since v1.5 of this role. | |
| d1f83c59 | 33 | - `clever_metrics`: a boolean to enable or disable metrics support. Optional, default to `true`. |
| 56797728 | 34 | - `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. |
| f7dd5848 GD |
35 | |
| 36 | Variables specific to deployment, default should be fine: | |
| 37 | - `clever_cli_version`: Version of clever cli tools, default to `0.9.3`. | |
| 38 | - `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`. | |
| 8056915b | 39 | - `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. |
| f7dd5848 GD |
40 | - `clever_app_confdir`: Path where to store clever cloud data specific to this application, default to `"{{ clever_app_root }}/.clever_cloud"` |
| 41 | - `clever_login_file`: Path to store login information. Default to `"{{ clever_app_confdir }}/login"`. | |
| 42 | ||
| 43 | ||
| 44 | Dependencies | |
| 45 | ------------ | |
| 46 | ||
| 47 | None | |
| 48 | ||
| 49 | Example Playbook | |
| 50 | ---------------- | |
| 51 | ||
| 52 | Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: | |
| 53 | ||
| 54 | - hosts: servers | |
| 55 | roles: | |
| 56 | - { role: fretlink.clever, clever_app: 42, clever_token: "{{ vault_clever_token }}", clever_secret: "{{ vault_clever_secret}}" } | |
| 57 | ||
| 58 | ||
| 59 | TODO | |
| 60 | ---- | |
| 61 | ||
| 62 | Add some tests and Travis integration | |
| 63 | ||
| 64 | License | |
| 65 | ------- | |
| 66 | ||
| 67 | BSD | |
| 68 | ||
| 69 | Author Information | |
| 70 | ------------------ | |
| 71 | ||
| 72 | Developped at Fretlink (https://www.fretlink.com) for our |