Merge branch 'feat/dynamic-env-urls' into 'master'

This project implements a Gitlab CI template for [Ansible](https://www.ansible.com/).

## Overview

This template implements continuous delivery/continuous deployment for projects that deploy their environments with Ansible.

## Overview: managed environments

It provides several features, usable in different modes.

This template implements Ansible-based deployments.

It allows you to manage automatic deployment & cleanup of standard predefined environments.

Each environment can be enabled/disabled by configuration.

If you're not satisfied with predefined environments and/or their associated Git workflow, you may implement you own environments and

workflow, by reusing/extending the base (hidden) jobs. This is advanced usage and will not be covered by this documentation.

The following chapters present the managed predefined environments and their associated Git workflow.

### Review environments

### Production environments

Lastly, the template supports 2 environments associated to your production branch (`master` by default):

Lastly, the template supports 2 environments associated to your production branch (`master` or `main` by default):

* a **staging** environment (an iso-prod environment meant for testing and validation purpose),

* the **production** environment.

* `pre-ansible-playbook.sh` is executed **before** running `ansible-playbook`, to perform specific environment pre-initialization such as generating a dynamic inventory

* `post-ansible-playbook.sh` is executed **after** running `ansible-playbook`, to perform specific environment post-initialization

#### Static vs. Dynamic environment URLs

The Ansible template supports two ways of defining your environments url:

* a **static way**: when you know your environments url in advance, probably because you're exposing your routes through a DNS you manage,

* a [**dynamic way**](https://docs.gitlab.com/ee/ci/environments/#set-dynamic-environment-urls-after-a-job-finishes): when the url cannot be known before the

  deployment job is executed.

The static way can be implemented simply by setting the overridding the [`environment:url`](https://docs.gitlab.com/ee/ci/yaml/#environmenturl) attribute in each

deployment job.

Example:

```yaml

ansible-staging:

  environment:

    url: "https://myapp-staging.noprod.domain"

ansible-production:

  environment:

    url: "https://myapp.prod.domain"

```

To implement the dynamic way, your post deployment hook script shall simply generate a `environment_url.txt` file, containing only

the dynamically generated url. This will be considered by the template as the newly deployed environment url.

### Ansible lint job

The Ansible template enables [Ansible Lint](https://docs.ansible.com/ansible-lint/) analysis of your Ansible scripts.

    public_key=$6

    vault_password=$7

    # unset any upstream deployment env & artifacts

    unset environment_type

    unset environment_url

    rm -f ansible.env

    rm -f environment_url.txt

    # maybe execute pre ansible-playbook script

    prescript="$ANSIBLE_SCRIPTS_DIR/pre-ansible-playbook.sh"

    if [[ -f "$prescript" ]]; then

    fi

    # finally persist environment url

    echo "$CI_ENVIRONMENT_URL" > environment_url.txt

    echo -e "environment_type=$ENV_TYPE\\nenvironment_url=$CI_ENVIRONMENT_URL" > ansible.env

    if [[ -f environment_url.txt ]]

    then

      environment_url=$(cat environment_url.txt)

      export environment_url

      log_info "--- dynamic environment url found: (\\e[33;1m$environment_url\\e[0m)"

    elif [[ "$CI_ENVIRONMENT_URL" ]]

    then

      environment_url=$CI_ENVIRONMENT_URL

      echo "$environment_url" > environment_url.txt

      log_info "--- static environment url defined: (\\e[33;1m$environment_url\\e[0m)"

    fi

    echo -e "environment_type=$ENV_TYPE\\nenvironment_url=$environment_url" > ansible.env

  }

  function get_latest_template_version() {

      - "$ANSIBLE_PROJECT_DIR/environment_url.txt"

    reports:

      dotenv: "$ANSIBLE_PROJECT_DIR/ansible.env"

  environment:

    url: "$environment_url" # can be either static or dynamic

# Cleanup job prototype

# Can be extended for each deletable environment