Add documentation of variables usage for disabling/enabling jobs in Auto DevOps
This commit is contained in:
parent
63379a2ae7
commit
e7de169a7d
1 changed files with 24 additions and 0 deletions
|
@ -496,7 +496,16 @@ also be customized, and you can easily use a [custom buildpack](#custom-buildpac
|
||||||
| `POSTGRES_DB` | The PostgreSQL database name; defaults to the value of [`$CI_ENVIRONMENT_SLUG`](../../ci/variables/README.md#predefined-variables-environment-variables). Set it to use a custom database name. |
|
| `POSTGRES_DB` | The PostgreSQL database name; defaults to the value of [`$CI_ENVIRONMENT_SLUG`](../../ci/variables/README.md#predefined-variables-environment-variables). Set it to use a custom database name. |
|
||||||
| `BUILDPACK_URL` | The buildpack's full URL. It can point to either Git repositories or a tarball URL. For Git repositories, it is possible to point to a specific `ref`, for example `https://github.com/heroku/heroku-buildpack-ruby.git#v142` |
|
| `BUILDPACK_URL` | The buildpack's full URL. It can point to either Git repositories or a tarball URL. For Git repositories, it is possible to point to a specific `ref`, for example `https://github.com/heroku/heroku-buildpack-ruby.git#v142` |
|
||||||
| `STAGING_ENABLED` | From GitLab 10.8, this variable can be used to define a [deploy policy for staging and production environments](#deploy-policy-for-staging-and-production-environments). |
|
| `STAGING_ENABLED` | From GitLab 10.8, this variable can be used to define a [deploy policy for staging and production environments](#deploy-policy-for-staging-and-production-environments). |
|
||||||
|
| `CANARY_ENABLED` | From GitLab 11.0, this variable can be used to define a [deploy policy for canary environments](#deploy-policy-for-canary-environments). |
|
||||||
| `INCREMENTAL_ROLLOUT_ENABLED`| From GitLab 10.8, this variable can be used to enable an [incremental rollout](#incremental-rollout-to-production) of your application for the production environment. |
|
| `INCREMENTAL_ROLLOUT_ENABLED`| From GitLab 10.8, this variable can be used to enable an [incremental rollout](#incremental-rollout-to-production) of your application for the production environment. |
|
||||||
|
| `TEST_DISABLED` | From GitLab 11.0, this variable can be used to disable the `test` job. If the variable is present, the job will not be created. |
|
||||||
|
| `CODEQUALITY_DISABLED` | From GitLab 11.0, this variable can be used to disable the `codequality` job. If the variable is present, the job will not be created. |
|
||||||
|
| `SAST_DISABLED` | From GitLab 11.0, this variable can be used to disable the `sast` job. If the variable is present, the job will not be created. |
|
||||||
|
| `DEPENDENCY_SCANNING_DISABLED` | From GitLab 11.0, this variable can be used to disable the `dependency_scanning` job. If the variable is present, the job will not be created. |
|
||||||
|
| `CONTAINER_SCANNING_DISABLED` | From GitLab 11.0, this variable can be used to disable the `sast:container` job. If the variable is present, the job will not be created. |
|
||||||
|
| `REVIEW_DISABLED` | From GitLab 11.0, this variable can be used to disable the `review` and the manual `review:stop` job. If the variable is present, these jobs will not be created. |
|
||||||
|
| `DAST_DISABLED` | From GitLab 11.0, this variable can be used to disable the `dast` job. If the variable is present, the job will not be created. |
|
||||||
|
| `PERFORMANCE_DISABLED` | From GitLab 11.0, this variable can be used to disable the `performance` job. If the variable is present, the job will not be created. |
|
||||||
|
|
||||||
TIP: **Tip:**
|
TIP: **Tip:**
|
||||||
Set up the replica variables using a
|
Set up the replica variables using a
|
||||||
|
@ -579,6 +588,21 @@ If `STAGING_ENABLED` is defined in your project (e.g., set `STAGING_ENABLED` to
|
||||||
to a `staging` environment, and a `production_manual` job will be created for
|
to a `staging` environment, and a `production_manual` job will be created for
|
||||||
you when you're ready to manually deploy to production.
|
you when you're ready to manually deploy to production.
|
||||||
|
|
||||||
|
#### Deploy policy for canary environments **[PREMIUM]**
|
||||||
|
|
||||||
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ci-yml/merge_requests/171)
|
||||||
|
in GitLab 11.0.
|
||||||
|
|
||||||
|
A [canary environment](https://docs.gitlab.com/ee/user/project/canary_deployments.html) can be used
|
||||||
|
before any changes are deployed to production.
|
||||||
|
|
||||||
|
If `CANARY_ENABLED` is defined in your project (e.g., set `CANARY_ENABLED` to
|
||||||
|
`1` as a secret variable) then two manual jobs will be created:
|
||||||
|
|
||||||
|
- `canary` which will deploy the application to the canary environment
|
||||||
|
- `production_manual` which is to be used by you when you're ready to manually
|
||||||
|
deploy to production.
|
||||||
|
|
||||||
#### Incremental rollout to production **[PREMIUM]**
|
#### Incremental rollout to production **[PREMIUM]**
|
||||||
|
|
||||||
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5415) in GitLab 10.8.
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5415) in GitLab 10.8.
|
||||||
|
|
Loading…
Reference in a new issue