Commit 5c369f19 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent ac0cab05

README.md

+8 −8
Original line number Diff line number Diff line
@@ -263,7 +263,7 @@ Then, when deploying to `production`, the parameters will be evaluated as follow 
| -------------- | --------------------------------------------- |

| `environment_name`      | dynamic variable set by the deployment script |

| `hostname`     | dynamic variable set by the deployment script |

| `MEMORY`       | default `openshift.env` file (undefined in specific `openshift-production.env` file) |

| `MEMORY`       | Default `openshift.env` file (undefined in specific `openshift-production.env` file) |

| `INSTANCES`    | specific `openshift-production.env` file      |

| `SECRET_TOKEN` | project CI/CD variables                       |
@@ -356,7 +356,7 @@ Here are some advices about your **secrets** (variables marked with a :lock:): 


The OpenShift template uses some global configuration used throughout all jobs.



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `OS_CLI_IMAGE`           | the Docker image used to run OpenShift Client (OC) CLI commands <br/>:warning: **set the version required by your OpenShift server** | `quay.io/openshift/origin-cli:latest` |

| `OS_URL`                 | Default OpenShift API url              | **has to be defined** |
@@ -377,7 +377,7 @@ They are **disabled by default** and can be enabled by setting the `OS_REVIEW_PR 


Here are variables supported to configure review environments:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `OS_REVIEW_PROJECT`      | OpenShift [project](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/projects_and_users.html#projects) for `review` env | _none_ (disabled) |

| `OS_REVIEW_URL`          | OpenShift API url for `review` env  _(only define if different from default)_    | `$OS_URL` |
@@ -394,7 +394,7 @@ It is **disabled by default** and can be enabled by setting the `OS_INTEG_PROJEC 


Here are variables supported to configure the integration environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `OS_INTEG_PROJECT`       | OpenShift [project](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/projects_and_users.html#projects) for `integration` env | _none_ (disabled) |

| `OS_INTEG_URL`           | OpenShift API url for `integration` env  _(only define if different from default)_    | `$OS_URL` |
@@ -410,7 +410,7 @@ It is **disabled by default** and can be enabled by setting the `OS_STAGING_PROJ 


Here are variables supported to configure the staging environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `OS_STAGING_PROJECT`     | OpenShift [project](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/projects_and_users.html#projects) for `staging` env | _none_ (disabled) |

| `OS_STAGING_URL`         | OpenShift API url for `staging` env  _(only define if different from default)_   | `$OS_URL` |
@@ -426,7 +426,7 @@ It is **disabled by default** and can be enabled by setting the `OS_PROD_PROJECT 


Here are variables supported to configure the production environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `OS_PROD_PROJECT`        | OpenShift [project](https://docs.openshift.com/container-platform/3.11/architecture/core_concepts/projects_and_users.html#projects) for `production` env | _none_ (disabled) |

| `OS_PROD_URL`            | OpenShift API url for `production` env  _(only define if different from default)_| `$OS_URL` |
@@ -476,7 +476,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_ |
@@ -494,7 +494,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 |