Commit 90f401d0 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent d5fdfbdc

README.md

+8 −8
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ You can find a sample of dbt project here : https://gitlab.com/to-be-continuous/ 


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



| Name                  | description                            | default value     |

| Name                  | Description                            | Default value     |

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

| `DBT_IMAGE`           | The Docker image used to run dbt       | `registry.hub.docker.com/library/python:latest`   |

| `DBT_PROJECT_DIR`     | The [dbt_project.yml](https://docs.getdbt.com/reference/dbt_project.yml) dir       | `.`   |
@@ -79,7 +79,7 @@ They are **disabled by default** and can be enabled by setting the `DBT_REVIEW_T 


Here are variables supported to configure review environments:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `DBT_REVIEW_TARGET`      | dbt [target](https://docs.getdbt.com/reference/dbt-jinja-functions/target) for `review` env | _none_ (disabled) |
@@ -92,7 +92,7 @@ It is **disabled by default** and can be enabled by setting the `DBT_INTEG_TARGE 


Here are variables supported to configure the integration environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `DBT_INTEG_TARGET`       | dbt [target](https://docs.getdbt.com/reference/dbt-jinja-functions/target) for `integration` env | _none_ (disabled) |
@@ -104,7 +104,7 @@ It is **disabled by default** and can be enabled by setting the `DBT_STAGING_TAR 


Here are variables supported to configure the staging environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `DBT_STAGING_TARGET`     | dbt [target](https://docs.getdbt.com/reference/dbt-jinja-functions/target) for `staging` env | _none_ (disabled) |
@@ -116,7 +116,7 @@ It is **disabled by default** and can be enabled by setting the `DBT_PROD_TARGET 


Here are variables supported to configure the production environment:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `DBT_PROD_TARGET`        | dbt [target](https://docs.getdbt.com/reference/dbt-jinja-functions/target) for `production` env | _none_ (disabled) |

| `DBT_PROD_DEPLOY_STRATEGY`| Defines the deployment to production strategy. One of `manual` (i.e. _one-click_) or `auto`. | `manual` |
@@ -137,7 +137,7 @@ This job performs **SQL Lint**. 


`dbt-sqlfluff-lint` execute [sqlfluff linter with dbt plugin](https://pypi.org/project/sqlfluff-templater-dbt/) to lint SQL and uses the following variables:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `DBT_SQLFLUFF_ENABLED`   | set to `true` to enable SQLFluff lint  | _none_ (disabled) |

| `DBT_SQLFLUFF_LINT_ARGS` | Lint [options and arguments](https://docs.sqlfluff.com/en/stable/cli.html#sqlfluff-lint) | _none_ |
@@ -150,7 +150,7 @@ This job performs **deployment**. 


`dbt-deploy` execute generated SQL from models on target and uses the following variables:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `DBT_DEPLOY_ENABLED`     | set to `true` to enable deployment     | _none_ (disabled) |
@@ -199,7 +199,7 @@ Provided you successfully configured the [federated authentication using OpenID 


The variant requires the additional configuration parameters:



| Name              | description                            | default value     |

| Name              | Description                            | Default value     |

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

| `TBC_GCP_PROVIDER_IMAGE` | The [GCP Auth Provider](https://gitlab.com/to-be-continuous/tools/gcp-auth-provider) image to use (can be overridden) | `$CI_REGISTRY/to-be-continuous/tools/gcp-auth-provider:main` |

| `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_ |