README.md

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