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 role deploys applications on clever cloud (https://www.clever-cloud.com).
  11 It handles the publication over git, as well as domain names, environment variables and log drains configuration.
  12
  13 Requirements
  14 ------------
  15
  16
  17 Role Variables
  18 --------------
  19
  20 Variables for the application
  21 - `clever_token`: clever_cloud token, mandatory.
  22 - `clever_secret`: clever_cloud secret, mandatory.
  23 - `clever_app`: the id of the app to link, mandatory.
  24 - `clever_env`: a dict of environment variables for the application (without add_ons one already available), optional.
  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
  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 }`
  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.
  29 - `clever_haskell_entry_point`: the haskell executable name to be executed by clever cloud, optional.
  30 - _Obsolete_: `clever_entry_point`: Same as above but was replaced by `clever_haskell_entry_point` since v1.14 of this role.
  31 - `clever_domain`: the domain from which the application should be reachable, optional.
  32 - _Obsolete_: `domain`: Same as above but was replaced by `clever_domain` since v1.4 of this role.
  33 - `clever_syslog_server`: UDP Syslog server to be used as UDPSyslog drain for the application, optional. Example: `udp://198.51.100.51:12345`.
  34 - _Obsolete_: `syslog_server`: Same as above but was replaced by `clever_syslog_server` since v1.5 of this role.
  35 - _Obsolete_: `clever_metrics`: metrics used to be disabled by default. Now they are enabled by default and can be explicitly disabled with `clever_disable_metrics`.
  36 - `clever_disable_metrics`: a boolean to disable metrics support. Optional, default to `false`.
  37 - `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.
  38
  39 Variables specific to deployment, default should be fine:
  40 - `clever_cli_version`: Version of clever cli tools, default to `0.9.3`.
  41 - `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`.
  42 - `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.
  43 - `clever_app_confdir`: Path where to store clever cloud data specific to this application, default to `"{{ clever_app_root }}/.clever_cloud"`
  44 - `clever_login_file`: Path to store login information. Default to `"{{ clever_app_confdir }}/login"`.
  45
  46
  47 Dependencies
  48 ------------
  49
  50 None
  51
  52 Example Playbook
  53 ----------------
  54
  55 Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
  56
  57     - hosts: servers
  58       roles:
  59          - { role: fretlink.clever, clever_app: 42, clever_token: "{{ vault_clever_token }}", clever_secret: "{{ vault_clever_secret}}" }
  60
  61
  62 TODO
  63 ----
  64
  65 Add some tests and Travis integration
  66
  67 License
  68 -------
  69
  70 BSD
  71
  72 Author Information
  73 ------------------
  74
  75 Developped at Fretlink (https://www.fretlink.com) for our