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

docs: normalise table headers

parent e2ef8577

README.md

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


The Google Cloud template uses some global configuration used throughout all jobs.



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `GCP_CLI_IMAGE`          | the Docker image used to run Google Cloud CLI commands| `gcr.io/google.com/cloudsdktool/cloud-sdk:latest` |

| :lock: `GCP_KEY_FILE`    | Default [Service Account key file](https://cloud.google.com/bigquery/docs/authentication/service-account-file) | _none_ |
@@ -220,7 +220,7 @@ They are **disabled by default** and can be enabled by setting the `GCP_REVIEW_P 


Here are variables supported to configure review environments:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `GCP_REVIEW_PROJECT`     | Google Cloud project ID for `review` env | _none_ (disabled) |

| :lock: `GCP_REVIEW_KEY_FILE`| [Service Account key file](https://cloud.google.com/bigquery/docs/authentication/service-account-file) to authenticate on `review` env  _(only define if different from default)_    | `$GCP_KEY_FILE` |
@@ -236,7 +236,7 @@ It is **disabled by default** and can be enabled by setting the `GCP_INTEG_PROJE 


Here are variables supported to configure the integration environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `GCP_INTEG_PROJECT`      | Google Cloud project ID for `integration` env | _none_ (disabled) |

| :lock: `GCP_INTEG_KEY_FILE`|[Service Account key file](https://cloud.google.com/bigquery/docs/authentication/service-account-file) to authenticate on `integration` env  _(only define if different from default)_    | `$GCP_KEY_FILE` |
@@ -252,7 +252,7 @@ It is **disabled by default** and can be enabled by setting the `GCP_STAGING_PRO 


Here are variables supported to configure the staging environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `GCP_STAGING_PROJECT`    | Google Cloud project ID for `staging` env | _none_ (disabled) |

| :lock: `GCP_STAGING_KEY_FILE`|[Service Account key file](https://cloud.google.com/bigquery/docs/authentication/service-account-file) to authenticate on `staging` env  _(only define if different from default)_    | `$GCP_KEY_FILE` |
@@ -267,7 +267,7 @@ It is **disabled by default** and can be enabled by setting the `GCP_PROD_PROJEC 


Here are variables supported to configure the production environment:



| Name                      | description                            | default value     |

| Name                      | Description                            | Default value     |

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

| `GCP_PROD_PROJECT`        | Google Cloud project ID for `production` env | _none_ (disabled) |

| :lock: `GCP_PROD_KEY_FILE`|[Service Account key file](https://cloud.google.com/bigquery/docs/authentication/service-account-file) to authenticate on `production` env  _(only define if different from default)_    | `$GCP_KEY_FILE` |
@@ -411,7 +411,7 @@ The following commands may help you retrieve the different values: 


The variant supports the following configuration:



| Name              | description                            | default value     |

| Name              | Description                            | Default value     |

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

| `GCP_OIDC_AUD`    | The `aud` claim for the JWT | `$CI_SERVER_URL` |

| `GCP_OIDC_PROVIDER`      | Default Workload Identity Provider associated with GitLab to [authenticate with OpenID Connect](https://docs.gitlab.com/ee/ci/cloud_services/google_cloud/) | _none_ |
@@ -457,7 +457,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_ |
@@ -475,7 +475,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 |