Commit 982c80f9 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: remove nbsp

parent 7efa1685

README.md

+5 −5
Original line number Diff line number Diff line
@@ -265,7 +265,7 @@ This template can be configured with the following **environment variables**: 
| `image` / `ANSIBLE_IMAGE` | The Docker image used to run Ansible. The image may contain your Ansible sources. <br/>:warning: **set the version required by your project** | `registry.hub.docker.com/cytopia/ansible:latest-tools` |

| `project-dir` / `ANSIBLE_PROJECT_DIR` | Ansible project root directory                                                       | `.`                                            |

| `base-app-name` / `ANSIBLE_BASE_APP_NAME` | Base application name                  | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |

| `environment-url` / `ANSIBLE_ENVIRONMENT_URL`       | Default environments url _(only define for static environment URLs declaration)_<br/>_supports late variable expansion (ex: `https://%{environment_name}.acme.com`)_ | _none_ |

| `environment-url` / `ANSIBLE_ENVIRONMENT_URL`       | Default environments url _(only define for static environment URLs declaration)_<br/>_supports late variable expansion (ex: `https://%{environment_name}.acme.com`)_ | _none_ |

| :lock: `ANSIBLE_VAULT_PASSWORD` | The Ansible vault password used to decrypt vars.                                     | **has to be defined in gitlab secret if used** |

| :lock: `ANSIBLE_PRIVATE_KEY`    | The Ansible SSH private key to use in all stages (can be overridden per env)         | **has to be defined in gitlab secret if used** |

| `public-key` / `ANSIBLE_PUBLIC_KEY` | The Ansible SSH public key associated to the private key to be use in all stages (can be overridden per env) | **has to be defined if used** |
@@ -290,7 +290,7 @@ Here are variables supported to configure the integration environment: 
| Input / Variable | Description                                        | Default value                                   |

| ------------------------------- | -------------------------------------------------- | ----------------------------------------------- |

| `review-app-name` / `ANSIBLE_REVIEW_APP_NAME` | Application name for `review` env      | `"${ANSIBLE_BASE_APP_NAME}-${CI_ENVIRONMENT_SLUG}"` (ex: `myproject-review-fix-bug-12`) |

| `review-environment-url` / `ANSIBLE_REVIEW_ENVIRONMENT_URL`| The review environments url _(only define for static environment URLs declaration and if different from default)_ | `$ANSIBLE_ENVIRONMENT_URL` |

| `review-environment-url` / `ANSIBLE_REVIEW_ENVIRONMENT_URL`| The review environments url _(only define for static environment URLs declaration and if different from default)_ | `$ANSIBLE_ENVIRONMENT_URL` |

| `review-inventory` / `ANSIBLE_REVIEW_INVENTORY` | The inventory for `review` env                     | `$ANSIBLE_DEFAULT_INVENTORY`                    |

| `review-tags` / `ANSIBLE_REVIEW_TAGS` | The tags for `review` env                          | `$ANSIBLE_DEFAULT_TAGS`                         |

| `review-cleanup-tags` / `ANSIBLE_REVIEW_CLEANUP_TAGS` | The tags to cleanup the `review` env               | **has to be defined if used**                   |
@@ -313,7 +313,7 @@ Here are variables supported to configure the integration environment: 
| Input / Variable | Description                                        | Default value                                   |

| ------------------------------- | -------------------------------------------------- | ----------------------------------------------- |

| `integ-app-name` / `ANSIBLE_INTEG_APP_NAME` | Application name for `integration` env | `${ANSIBLE_BASE_APP_NAME}-integration` |

| `integ-environment-url` / `ANSIBLE_INTEG_ENVIRONMENT_URL` | The integration environment url _(only define for static environment URLs declaration and if different from default)_ | `$ANSIBLE_ENVIRONMENT_URL` |

| `integ-environment-url` / `ANSIBLE_INTEG_ENVIRONMENT_URL` | The integration environment url _(only define for static environment URLs declaration and if different from default)_ | `$ANSIBLE_ENVIRONMENT_URL` |

| `integ-inventory` / `ANSIBLE_INTEG_INVENTORY` | The inventory for `integration` env                | `$ANSIBLE_DEFAULT_INVENTORY`                    |

| `integ-tags` / `ANSIBLE_INTEG_TAGS` | The tags for `integration` env                     | `$ANSIBLE_DEFAULT_TAGS`                         |

| `integ-cleanup-tags` / `ANSIBLE_INTEG_CLEANUP_TAGS` | The tags to cleanup the `integration` env          | **has to be defined if used**                   |
@@ -336,7 +336,7 @@ Here are variables supported to configure the staging environment: 
| Input / Variable | Description                                        | Default value                                   |

| ------------------------------- | -------------------------------------------------- | ----------------------------------------------- |

| `staging-app-name` / `ANSIBLE_STAGING_APP_NAME` | Application name for `staging` env     | `${ANSIBLE_BASE_APP_NAME}-staging` |

| `staging-environment-url` / `ANSIBLE_STAGING_ENVIRONMENT_URL`| The staging environment url _(only define for static environment URLs declaration and if different from default)_ | `$ANSIBLE_ENVIRONMENT_URL` |

| `staging-environment-url` / `ANSIBLE_STAGING_ENVIRONMENT_URL`| The staging environment url _(only define for static environment URLs declaration and if different from default)_ | `$ANSIBLE_ENVIRONMENT_URL` |

| `staging-inventory` / `ANSIBLE_STAGING_INVENTORY` | The inventory for `staging` env                    | `$ANSIBLE_DEFAULT_INVENTORY`                    |

| `staging-tags` / `ANSIBLE_STAGING_TAGS` | The tags for `staging` env                         | `$ANSIBLE_DEFAULT_TAGS`                         |

| `staging-cleanup-tags` / `ANSIBLE_STAGING_CLEANUP_TAGS` | The tags to cleanup the `staging` env              | **has to be defined if used**                   |
@@ -353,7 +353,7 @@ Here are variables supported to configure the staging environment: 
| Input / Variable | Description                                        | Default value                                             |

| ------------------------------- | -------------------------------------------------- | --------------------------------------------------------- |

| `prod-app-name` / `ANSIBLE_PROD_APP_NAME` | Application name for `production` env  | `$ANSIBLE_BASE_APP_NAME` |

| `prod-environment-url` / `ANSIBLE_PROD_ENVIRONMENT_URL`  | The production environment url _(only define for static environment URLs declaration and if different from default)_ | `$ANSIBLE_ENVIRONMENT_URL` |

| `prod-environment-url` / `ANSIBLE_PROD_ENVIRONMENT_URL`  | The production environment url _(only define for static environment URLs declaration and if different from default)_ | `$ANSIBLE_ENVIRONMENT_URL` |

| `prod-deploy-strategy` / `ANSIBLE_PROD_DEPLOY_STRATEGY` | Defines the deployment to production strategy. One of `manual` (i.e. _one-click_) or `auto`. | `manual` |

| `prod-inventory` / `ANSIBLE_PROD_INVENTORY` | The inventory for `production` env                 | `$ANSIBLE_DEFAULT_INVENTORY`                              |

| `prod-tags` / `ANSIBLE_PROD_TAGS` | The tags for `production` env                      | `$ANSIBLE_DEFAULT_TAGS`                                   |