Skip to content
Snippets Groups Projects
Commit dd559bb4 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 382c4c45
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
Showing
with 10 additions and 10 deletions
README.md
+ 10
− 10
View file @ dd559bb4
......@@ -349,15 +349,15 @@ Here are some advices about your **secrets** (variables marked with a :lock:):
The Kubernetes template uses some global configuration used throughout all jobs.
| Name | description | default value |
| Name | Description | Default value |
| --------------------- | -------------------------------------- | ----------------- |
| `K8S_KUBECTL_IMAGE` | the Docker image used to run Kubernetes `kubectl` commands <br/>:warning: **set the version required by your Kubernetes server** | `registry.hub.docker.com/bitnami/kubectl:latest` |
| `K8S_BASE_APP_NAME` | default application name | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |
| `K8S_BASE_APP_NAME` | Default application name | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |
| `K8S_ENVIRONMENT_URL` | Default environments url _(only define for static environment URLs declaration)_<br/>_supports late variable expansion (ex: `https://%{environment_name}.k8s.acme.com`)_ | _none_ |
| :lock: `K8S_DEFAULT_KUBE_CONFIG`| The default kubeconfig to use (either content or file variable) | **required if not using exploded kubeconfig parameters** |
| `K8S_URL` | the Kubernetes API url | **required if using exploded kubeconfig parameters** |
| `K8S_CA_CERT` | the default Kubernetes server certificate authority | **optional if using exploded kubeconfig parameters** |
| :lock: `K8S_TOKEN` | default service account token | **required if using exploded kubeconfig parameters** |
| :lock: `K8S_TOKEN` | Default service account token | **required if using exploded kubeconfig parameters** |
| `K8S_SCRIPTS_DIR` | directory where k8s scripts (hook scripts) are located | `.` _(root project dir)_ |
| `K8S_KUSTOMIZE_ENABLED` | Set to `true` to force using [Kustomize](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/) | _none_ (disabled) |
| `K8S_KUSTOMIZE_ARGS` | Additional [`kubectl kustomize` options](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#kustomize)<br/>_for example: `--enable-helm`_ | _none_ |
......@@ -373,7 +373,7 @@ They are **disabled by default** and can be enabled by setting the `K8S_REVIEW_S
Here are variables supported to configure review environments:
| Name | description | default value |
| Name | Description | Default value |
| ------------------------ | -------------------------------------- | ----------------- |
| `K8S_REVIEW_SPACE` | k8s namespace for `review` env | _none_ (disabled) |
| `K8S_REVIEW_APP_NAME` | application name for `review` env | `"${K8S_BASE_APP_NAME}-${CI_ENVIRONMENT_SLUG}"` |
......@@ -392,7 +392,7 @@ It is **disabled by default** and can be enabled by setting the `K8S_INTEG_SPACE
Here are variables supported to configure the integration environment:
| Name | description | default value |
| Name | Description | Default value |
| ------------------------ | -------------------------------------- | ----------------- |
| `K8S_INTEG_SPACE` | k8s namespace for `integration` env | _none_ (disabled) |
| `K8S_INTEG_APP_NAME` | application name for `integration` env | `$K8S_BASE_APP_NAME-integration` |
......@@ -410,7 +410,7 @@ It is **disabled by default** and can be enabled by setting the `K8S_STAGING_SPA
Here are variables supported to configure the staging environment:
| Name | description | default value |
| Name | Description | Default value |
| ------------------------ | -------------------------------------- | ----------------- |
| `K8S_STAGING_SPACE` | k8s namespace for `staging` env | _none_ (disabled) |
| `K8S_STAGING_APP_NAME` | application name for `staging` env | `$K8S_BASE_APP_NAME-staging` |
......@@ -428,7 +428,7 @@ It is **disabled by default** and can be enabled by setting the `K8S_PROD_SPACE`
Here are variables supported to configure the production environment:
| Name | description | default value |
| Name | Description | Default value |
| ------------------------ | -------------------------------------- | ----------------- |
| `K8S_PROD_SPACE` | k8s namespace for `production` env | _none_ (disabled) |
| `K8S_PROD_APP_NAME` | application name for `production` env | `$K8S_BASE_APP_NAME` |
......@@ -446,7 +446,7 @@ This job is mapped to the `test` stage and is **active** by default.
Here are its parameters:
| Name | description | default value |
| Name | Description | Default value |
| ---------------------- | -------------------------------------------------------------------- | ----------------- |
| `K8S_KUBE_SCORE_IMAGE` | Docker image to run [kube-score](https://github.com/zegl/kube-score) | `registry.hub.docker.com/zegl/kube-score:latest-kustomize` **it is recommended to set a tool version compatible with your Kubernetes cluster** |
| `K8S_SCORE_DISABLED` | Set to `true` to disable the `kube-score` analysis | _none_ (enabled) |
......@@ -462,7 +462,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_ |
......@@ -480,7 +480,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 |
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment