Commit ee1b354d authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 358afede

README.md

+8 −8
Original line number Diff line number Diff line
@@ -204,7 +204,7 @@ Here are some advices about your **secrets** (variables marked with a :lock:): 


The Azure template uses some global configuration used throughout all jobs and environments.



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `AZURE_CLI_IMAGE`        | the Docker image used to run Azure CLI commands| `mcr.microsoft.com/azure-cli:latest` |

| `AZURE_BASE_APP_NAME`    | Base application name                  | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |
@@ -223,7 +223,7 @@ They are **disabled by default** and can be enabled by setting the `AZURE_REVIEW 


Here are variables supported to configure review environments:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `AZURE_REVIEW_ENABLED`   | Azure project ID for `review` env | _none_ (disabled) |

| `AZURE_REVIEW_APP_NAME`  | Application name for `review` env      | `"${AZURE_BASE_APP_NAME}-${CI_ENVIRONMENT_SLUG}"` (ex: `myproject-review-fix-bug-12`) |
@@ -241,7 +241,7 @@ It is **disabled by default** and can be enabled by setting the `AZURE_INTEG_ENA 


Here are variables supported to configure the integration environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `AZURE_INTEG_ENABLED`      | Azure project ID for `integration` env | _none_ (disabled) |

| `AZURE_INTEG_APP_NAME`     | Application name for `integration` env | `${AZURE_BASE_APP_NAME}-integration` |
@@ -259,7 +259,7 @@ It is **disabled by default** and can be enabled by setting the `AZURE_STAGING_E 


Here are variables supported to configure the staging environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `AZURE_STAGING_ENABLED`  | Azure project ID for `staging` env | _none_ (disabled) |

| `AZURE_STAGING_APP_NAME` | Application name for `staging` env     | `${AZURE_BASE_APP_NAME}-staging` |
@@ -276,7 +276,7 @@ It is **disabled by default** and can be enabled by setting the `AZURE_PROD_ENAB 


Here are variables supported to configure the production environment:



| Name                      | description                            | default value     |

| Name                      | Description                            | Default value     |

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

| `AZURE_PROD_ENABLED`      | Azure project ID for `production` env | _none_ (disabled) |

| `AZURE_PROD_APP_NAME`     | Application name for `production` env  | `$AZURE_BASE_APP_NAME` |
@@ -307,7 +307,7 @@ That means you'll be able to use it from **only one GitLab project and branch**. 


The variant supports the following configuration:



| Name                         | description                            | default value     |

| Name                         | Description                            | Default value     |

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

| `AZURE_OIDC_AUD`             | The `aud` claim for the JWT | `api://AzureADTokenExchange` ([recommended default value](https://learn.microsoft.com/en-us/azure/active-directory/workload-identities/workload-identity-federation-create-trust?pivots=identity-wif-apps-methods-azp#important-considerations-and-restrictions)) |

| `AZURE_OIDC_CLIENT_ID`       | Default Service Principal client ID associated with GitLab to [authenticate using OpenID Connect](https://docs.gitlab.com/ee/ci/cloud_services/azure/) | _none_ (disabled)    |
@@ -350,7 +350,7 @@ This variant allows delegating your secrets management to a [Vault](https://www. 


In order to be able to communicate with the Vault server, the variant requires the additional configuration parameters:



| Name              | description                            | default value     |

| Name              | Description                            | Default value     |

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

| `TBC_VAULT_IMAGE` | The [Vault Secrets Provider](https://gitlab.com/to-be-continuous/tools/vault-secrets-provider) image to use (can be overridden) | `$CI_REGISTRY/to-be-continuous/tools/vault-secrets-provider:master` |

| `VAULT_BASE_URL`  | The Vault server base API url          | _none_ |
@@ -368,7 +368,7 @@ Then you may retrieve any of your secret(s) from Vault using the following synta 


With:



| Name                             | description                            |

| Name                             | Description                            |

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

| `secret_path` (_path parameter_) | this is your secret location in the Vault server |

| `field` (_query parameter_)      | parameter to access a single basic field from the secret JSON payload |