core: cleanup the README to better document the role

Part of #66

Merge pull request #67 from clementd-fretlink/scaling

scalability configuration

add tests for scalability settings

They make sure that ansible does not crash while calling `clever scale`

Add support for scalability configuration

Closes #52

Merge pull request #68 from paulrbr-fl/bug-fix

fix: make sure not to include unecessary ENV variable

fix: make sure not to include unecessary ENV variable

This is a fix to an unfortunate bug introduced by #64 because we had a
default value set to `None` on the
`clever_haskell_entry_point`. Ansible considers `None` as a defined
value so the `is defined` condition doesn't match our need

core: fix execution mode on shell script

tests: Add more test cases

Merge pull request #55 from clementd-fretlink/build-flavor

Add optional build flavor configuration

Update default `clever-tools` version in the readme

Co-authored-by: paulrbr-fl <43074087+paulrbr-fl@users.noreply.github.com>

Specify clever-tools version constaints in README

Inline `clever scale --build-flavor` command

Add optional build flavor configuration

Merge pull request #64 from clementd-fretlink/json-env

Use JSON import for environment variables

Extract environment building tasks from the JSON template

Use JSON import for environment variables

The env can be provided as a JSON list `[{"name": "PORT", "value": "8080"}]`.
The `dict2items` filter provided by ansible is _almost_ what we want, but it
keeps the value original types (a boolean is kept as a boolean in the JSON value).
Since environment variables are strings and `clever-tools` does not want to make
the implicit coercion for us, we need to do it ourselves.

Merge pull request #63 from paulrbr-fl/upgrade-clever-cli

deploy: remove custom polling script now that the CLI does it for us

deploy: remove custom polling script now that the CLI does it for us

See recent changes (https://github.com/CleverCloud/clever-tools/pull/415)
introduced in 2.5.0+ version of the clever cli tools

Merge pull request #61 from paulrbr-fl/fix-env-file

fix: there was a bug in the generate env file

fix: there was a bug in the generate env file

Bug Introduced by #57 because the `to_json` filter quotes the given
value if it's a string, so the PR was "double quoting" each values.

Merge pull request #60 from paulrbr-fl/fix-base-env

fix `clever_base_env`  by removing a variable if not necessary

vars: fix `clever_base_env`  by removing a variable if not necessary

The `CC_RUN_COMMAND` variable was defined in case we use haskell
binary as entrypoints. However if the `clever_haskell_entry_point`
variable is not defined we shouldn't define the `CC_RUN_COMMAND` env variable.

Merge pull request #59 from paulrbr-fl/add-dhall-types-addons

config(dhall): adding redis and mysql addon types

config(dhall): adding redis and mysql addon types

Merge pull request #57 from clementd-fretlink/quoted-env-vars

Quote env vars to support multiline values

Quote env vars to support multiline values

clever-tools now supports multiline env vars. It did so by supporting
quotes in the formats it reads from.
This commit quotes the exported values using the `tojson` filter.

Of course, a better solution would be for clever env to directly read
json value, but it's not there yet

Merge pull request #58 from paulrbr-fl/fix-ci

ci: fix nix version and nix channel version

ci: fix nix version and nix channel version

In order to avoid having bad surprises with automatic updates let's
fix the nix channel version. For now the default travis behavior is to
use `nixpkgs-unstable` (see
https://docs.travis-ci.com/user/languages/nix#overview).

Merge pull request #56 from paulrbr-fl/moar-compat

fix: addon environment variables fetch for clever >= 1.5.0

fix: addon environment variables fetch for clever >= 1.5.0

It seems the output of `clever env` has changed and now env values are
surrounded by quotes with the latest 1.5.0 clever tools version.

We used to add quotes ourselves because they were missing in the
output. So this commit is adapting its parsing depending of the clever
tools' version.

Merge pull request #54 from clementd-fretlink/polykinds

Migrate to dhall 1.26.1 and merge types and terms

Migrate to dhall 1.26.1 and merge types and terms

Merge pull request #53 from paulrbr-fl/moar-compat

scripts: use short options instead of long ones

ci: fix nix packages due to Travis nix update to 19.09 packages

scripts: use short options instead of long ones

In order to be compatible with more `grep` versions (notably busybox
ones which don't have long option names in our new CI environments) we
need to use short cli options.

Merge pull request #51 from paulrbr-fl/clever-deploy-back-to-polling

clevertools: upgrade to latest stable version as default

clevertools: upgrade to latest stable version as default

Upgrade to 1.4.2 as default version installed by the role

Merge pull request #50 from paulrbr-fl/clever-deploy-back-to-polling

deploy: add a timeout in the polling waiting script

deploy: add a timeout in the polling waiting script

Merge pull request #49 from paulrbr-fl/clever-deploy-back-to-polling

deploy: revert back to git push + polling

lint(scripts): apply shellcheck suggestions on dhall checking script

ci: add shellcheck to lint shell scripts in automatic tests

deploy: revert back to git push + polling

In #19 we removed the polling script to rely on the clever cli's
ability to wait on `clever deploy` command.

After more than 6 months of experimentation it seems the command is
still not reliable (sometimes the command never returns, sometimes it
returns even when the deployment has finished..).

Thus we are reverting back to our manual process of polling `clever
activity` every 5 seconds.

The timeout for this polling is set at the Ansible level (not in the
bash script) and set for 40 minutes. This should give enough time for
any of our applications to deploy.

Merge pull request #48 from clementd-fretlink/remove-ssh-key

Remove `sshKey` from the vault type

Remove `sshKey` from the vault type

It's not actually used by the role, but by code that uses this role.

Merge pull request #47 from clementd-fretlink/debug

Fix `CC_DISABLE_METRICS` computation

Fix `CC_DISABLE_METRICS` computation

Merge pull request #46 from clementd-fretlink/cleanup

update metrics and entrypoint default definitions

Clever Cloud metrics are now enabled by default

Merge pull request #45 from clementd-fretlink/new-clever-vault

Clean up `dhall` type definitions

dhall: remove optional arguments from mkConfig

It was just constructing a record without adding any information. Now
it constructs a record from its mandatory parts. The caller can then
override fields as they please.

dhall: expose optional fields as optional values

Instead of `nonifying` them

Remove default environment from Dhall config

remove org_id from vault type, add sshKey in vault

Merge pull request #44 from gaetanfl/fix_shell_pipefail

use bash with -o pipefail

use bash with -o pipefail

Merge pull request #42 from paulrbr-fl/deploy-errors-on-application-is-up-to-date

fix(deploy): fail the task correctly when last deploymt failed

fix(deploy): fail the task correctly when last deploymt failed

Merge pull request #41 from paulrbr-fl/dhall-version-upgrade

dhall(upgrade): upgrade code to be compatible with dhall 1.21.0

dhall(upgrade): upgrade code to be compatible with dhall 1.21.0

Merge pull request #40 from gaetanfl/fix_ansible_lint_4.1

fix(lint): ansible lint 4.1.0 compatibiliy

fix(lint): ansible 4.1.0 compatibiliy

Merge pull request #39 from paulrbr-fl/fix-login

Fix login by removing any existing linked app

login: make sure no existing apps are linked to the clever tools

Revert "login: force the `.clever.json` file to be created"

This reverts commit 85d1a7838d032ec7dfe858fce5dca3f5535199e4.

Merge pull request #38 from paulrbr-fl/fix-login

login: force the `.clever.json` file to be created

login: force the `.clever.json` file to be created

In case a project already has a `.clever.json` file (for debugging
purpose to communicate with dev environment for instance) this step
was never done because of the `creates:`.

Removing it forces the role to always create a new clever.json file.

Merge pull request #37 from gaetanfl/fix_path

Missing /

Missing /

Merge pull request #36 from gaetanfl/fix_typo

Fix duplicate version number in url

Fix duplicate version number in url

Merge pull request #35 from gaetanfl/use_path_tool

use full path for clever helper invocation

liniting

use full path for clever helper invocation

Merge pull request #34 from paulrbr-fl/domain-case

domain: DNS names are case insensitive

domain: DNS names are case insensitive

Merge pull request #33 from paulrbr-fl/successful-deploy-up-to-date

deploy: check "up-to-date" error to succeeded if last commit is OK

deploy: check "up-to-date" error to succeeded if last commit is OK

Merge pull request #22 from paulrbr-fl/fix-v1.10

Upgrade clever tools to latest version

fix: Fail module takes one argument

deploy_task: Update clever CLI tools and use it instead of git push

Updating to latest version of 1.1.1 helps to have a stable `clever
deploy` command.

This commit relies on the output of the command instead of manually
pooling the results with `clever activity` command.

Merge pull request #32 from clementd-fretlink/quote-env

fix(deploy): properly quote variables in environment files

fix(deploy): properly quote variables in environment files

adding exports in the env file also quotes the variable values

tags: add clever-env tag to post-deploy tasks

Merge pull request #31 from paulrbr-fl/fix-tags

fix: statically include sub tasks for 'tags' to work

fix: statically include sub tasks for 'tags' to work

In ansible the `include_tasks` loads the tasks dynamically. Thus it
does not apply the tag specified at the include level to all sub
tasks.

In order to make sure all included tasks inherit the specified `tags:`
we need to include the tasks files "statically". It is very similar to
cases where we have a `when:` condition that we want to apply to all
included subtasks. cf https://docs.ansible.com/ansible/latest/user_guide/playbooks_conditionals.html#applying-when-to-roles-imports-and-includes

Merge pull request #30 from paulrbr-fl/rename-entry-point

app: rename `clever_entry_point`. It's only used by Haskell apps

app: rename `clever_entry_point`. It's only used by Haskell apps

Merge pull request #29 from paulrbr-fl/missing-chdir

fix: Yet again a missing chdir for "clever" command

fix: Yet again a missing chdir for "clever" command

This is a followup of #26

Merge pull request #28 from paulrbr-fl/fix-post-deploy

Fix: post depoy tasks were not launched. This fixes it.

Fix: post depoy tasks were not launched. This fixes it.

Merge pull request #27 from paulrbr-fl/chdir-all-the-things

fix(deploy): Yet again a missing chdir to execute from app root

fix(deploy): Yet again a missing chdir to execute from app root

Merge pull request #26 from paulrbr-fl/chdir-all-the-things

fix(deploy): Make sure to execute clever commands in app_root dir

fix(deploy): Make sure to execute clever commands in app_root dir

Merge pull request #25 from paulrbr-fl/feat-get-env

feat(post_deploy): Add a post deploy task to fetch deployed env

feat(post_deploy): Add a post deploy task to fetch deployed env

In some cases you might need to retrieve the ENV which is currently in
use by your clever application recently deployed.

If you specify a `clever_env_output_file` that is exactly what you
will get!

Merge pull request #24 from paulrbr-fl/revert-clever-cli-update

Reverting upgrade of clever-tools CLI

Revert "Merge pull request #19 from paulrbr-fl/update-clever-tools"

This reverts commit 695ceaa28821660e17a1cf819cffebe1b5d8c7ca, reversing
changes made to 5485dbc4db3e141673457475bcda5fc88057739f.