README.md

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