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

docs: normalise table headers

parent a73a2674

README.md

+15 −15
Original line number Diff line number Diff line
@@ -64,7 +64,7 @@ You're free to enable whichever or both, and you can also choose your deployment 
In order to manage the various deployment environments, this template provides a couple of **dynamic variables**

that you might use in your hook scripts and Helm charts (as [values](https://helm.sh/docs/chart_best_practices/values/)):



| environment variable | template directive | description |

| environment variable | template directive | Description |

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

| `$environment_name`  | `{{ .Release.Name }}` | a generated application name to use for the current deployment environment (ex: `myproject-review-fix-bug-12` or `myproject-staging`). This is used as the **Helm release name** in deploy & delete jobs - _details below_ |

| `$environment_type`  | `{{ .Values.environmentType }}` | the current deployment environment type (`review`, `integration`, `staging` or `production`) |
@@ -232,7 +232,7 @@ Here are some advices about your **secrets** (variables marked with a :lock:): 


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



| Name                  | description                            | default value     |

| Name                  | Description                            | Default value     |

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

| `HELM_CLI_IMAGE`      | The Docker image used to run Helm <br/>:warning: **set the version required by your Kubernetes server** | `registry.hub.docker.com/alpine/helm:latest` |

| `HELM_CHART_DIR`      | The folder where the Helm chart is located | `.`  _(root project dir)_ |
@@ -257,7 +257,7 @@ They are **disabled by default** and can be enabled by setting the `HELM_REVIEW_ 


Here are variables supported to configure review environments:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `HELM_REVIEW_ENABLED`    | Set to `true` to enable `review` env   | _none_ (disabled) |

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


Here are variables supported to configure the integration environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `HELM_INTEG_ENABLED`     | Set to `true` to enable `integration` env | _none_ (disabled) |

| `HELM_INTEG_APP_NAME`    | Application name for `integration` env | `$HELM_BASE_APP_NAME-integration` |
@@ -293,7 +293,7 @@ It is **disabled by default** and can be enabled by setting the `HELM_STAGING_EN 


Here are variables supported to configure the staging environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `HELM_STAGING_ENABLED`   | Set to `true` to enable `staging` env  | _none_ (disabled) |

| `HELM_STAGING_APP_NAME`  | Application name for `staging` env     | `$HELM_BASE_APP_NAME-staging` |
@@ -311,7 +311,7 @@ It is **disabled by default** and can be enabled by setting the `HELM_PROD_ENABL 


Here are variables supported to configure the production environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `HELM_PROD_ENABLED`      | Set to `true` to enable `production` env | _none_ (disabled)  |

| `HELM_PROD_APP_NAME`     | Application name for `production` env  | `$HELM_BASE_APP_NAME` |
@@ -325,7 +325,7 @@ Here are variables supported to configure the production environment: 


This job [examines your chart for possible issues](https://helm.sh/docs/helm/helm_lint/) and uses the following variables:



| Name                  | description                              | default value     |

| Name                  | Description                              | Default value     |

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

| `HELM_LINT_DISABLED`  | Set to `true` to disable Helm lint                 | _none_ (enabled) |

| `HELM_LINT_ARGS`      | The Helm [command with options](https://helm.sh/docs/helm/helm_lint/) to trigger the analysis (_without dynamic arguments such as the chart path_) | `lint --strict` |
@@ -335,7 +335,7 @@ This job [examines your chart for possible issues](https://helm.sh/docs/helm/hel 


These jobs perform a [Yaml Lint](https://github.com/adrienverge/yamllint) of your Helm [values file](https://helm.sh/docs/chart_template_guide/values_files/) and uses the following variables:



| Name                     | description                           | default value     |

| Name                     | Description                           | Default value     |

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

| `HELM_YAMLLINT_IMAGE`    | The Docker image used to run YamlLint test | `registry.hub.docker.com/cytopia/yamllint` |

| `HELM_YAMLLINT_DISABLED` | Set to `true` to disable Yaml lint              | _none_ (enabled) |
@@ -346,7 +346,7 @@ These jobs perform a [Yaml Lint](https://github.com/adrienverge/yamllint) of you 


This job runs [Kube-Score](https://kube-score.com/) on the resources to be created by Helm and uses the following variables:



| Name                  | description                              | default value     |

| Name                  | Description                              | Default value     |

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

| `HELM_KUBE_SCORE_DISABLED`   | Set to `true` to disable [Kube-Score](https://kube-score.com/)   | _none_ (enabled) |

| `HELM_KUBE_SCORE_IMAGE`   | The Docker image used to run [Kube-Score](https://kube-score.com/)   | `registry.hub.docker.com/zegl/kube-score` |
@@ -357,7 +357,7 @@ This job runs [Kube-Score](https://kube-score.com/) on the resources to be creat 


This job [packages](https://helm.sh/docs/helm/helm_package/) the Helm chart. It uses the following variables:



| Name                                | description                                   | default value                     |

| Name                                | Description                                   | Default value                     |

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

| `HELM_PACKAGE_ARGS`                 | The Helm [command with options](https://helm.sh/docs/helm/helm_package/) to perform the packaging (_without dynamic arguments such as the chart path_)   | `package --dependency-update` |

| `HELM_PUBLISH_SNAPSHOT_ENABLED`     | Set to `true` to enable publishing the snapshot (untested) chart during the packaging step | _none_ (disabled) |
@@ -407,7 +407,7 @@ Those variables may be freely used in downstream jobs. 


This job publishes the packaged chart to a [chart repository](https://helm.sh/docs/topics/chart_repository/) or [OCI-based registry](https://helm.sh/docs/topics/registries/). It uses the following variables:



| Name                                | description                                   | default value                     |

| Name                                | Description                                   | Default value                     |

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

| `HELM_PUBLISH_METHOD`               | Method to use to publish the packaged chart (one of `auto`, `push`, `post`, `put`, `custom`, `disabled`) | `auto`                  |

| :lock: `HELM_PUBLISH_USER`          | Helm registry username                       | `$CI_REGISTRY_USER`     |
@@ -422,7 +422,7 @@ This job publishes the packaged chart to a [chart repository](https://helm.sh/do 


The Helm publish supports several methods, configurable with the `$HELM_PUBLISH_URL` variable:



| Value           | description                                   |

| Value           | Description                                   |

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

|`auto` (default) | tries to auto-detect the most appropriate method | 

|`disabled`       | disables the `helm-publish` job |
@@ -461,7 +461,7 @@ It is **disabled by default** and can be enabled by setting the ``HELM_TEST_ENAB 


It uses the following variables:



| Name                  | description                              | default value     |

| Name                  | Description                              | Default value     |

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

| `HELM_TEST_ENABLED`  | Set to `true` to enable Helm test                 | _none_ (disabled) |

| `HELM_TEST_ARGS`      | The Helm [command with options](https://helm.sh/docs/helm/helm_test/) to perform acceptance test (_without dynamic arguments such as the chart path_) | `test`        |
@@ -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 |