Commit 3894412f authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 869527bf

README.md

+6 −6
Original line number Diff line number Diff line
@@ -104,7 +104,7 @@ They are **disabled by default** and can be enabled by setting the `CF_REVIEW_SP 


Here are variables supported to configure review environments:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `CF_REVIEW_SPACE`     | CF space for `review` env              | _none_ (disabled) |

| `CF_REVIEW_URL`       | CF API url for `review` env _(only define if different from default)_    | `$CF_URL` |
@@ -130,7 +130,7 @@ It is **disabled by default** and can be enabled by setting the `CF_INTEG_SPACE` 


Here are variables supported to configure the integration environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `CF_INTEG_SPACE`      | CF space for `integration` env         | _none_ (disabled) |

| `CF_INTEG_URL`        | CF API url for `integration` env _(only define if different from default)_   | `$CF_URL` |
@@ -154,7 +154,7 @@ It is **disabled by default** and can be enabled by setting the `CF_STAGING_SPAC 


Here are variables supported to configure the staging environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `CF_STAGING_SPACE`    | CF space for `staging` env             | _none_ (disabled) |

| `CF_STAGING_URL`      | CF API url for `staging` env _(only define if different from default)_   | `$CF_URL` |
@@ -177,7 +177,7 @@ It is **disabled by default** and can be enabled by setting the `CF_PROD_SPACE` 


Here are variables supported to configure the production environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `CF_PROD_SPACE`       | CF space for `production` env          | _none_ (disabled) |

| `CF_PROD_URL`         | CF API url for `production` env _(only define if different from default)_| `$CF_URL` |
@@ -334,7 +334,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_ |
@@ -352,7 +352,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 |