diff options
Diffstat (limited to 'doc/ci')
| -rw-r--r-- | doc/ci/variables/README.md | 3 | ||||
| -rw-r--r-- | doc/ci/yaml/README.md | 31 |
2 files changed, 34 insertions, 0 deletions
diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md index 25d189afb24..8abf3b0ba04 100644 --- a/doc/ci/variables/README.md +++ b/doc/ci/variables/README.md @@ -61,6 +61,9 @@ future GitLab releases.** | **CI_ENVIRONMENT_NAME** | 8.15 | all | The name of the environment for this job | | **CI_ENVIRONMENT_SLUG** | 8.15 | all | A simplified version of the environment name, suitable for inclusion in DNS, URLs, Kubernetes labels, etc. | | **CI_ENVIRONMENT_URL** | 9.3 | all | The URL of the environment for this job | +| **CI_ENVIRONMENT_TRACK** | 11.6 | all | The environment deployment track, default `stable` | +| **CI_ENVIRONMENT_ROLLOUT** | 11.6 | all | The environment deployment rollout percentage, when track==rollout | +| **CI_ENVIRONMENT_ACTION** | 11.6 | all | The environment deployment action: `start` or `stop` | | **CI_JOB_ID** | 9.0 | all | The unique id of the current job that GitLab CI uses internally | | **CI_JOB_MANUAL** | 8.12 | all | The flag to indicate that job was manually started | | **CI_JOB_NAME** | 9.0 | 0.5 | The name of the job as defined in `.gitlab-ci.yml` | diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index fb69d888b94..5192a8502ac 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -787,6 +787,36 @@ The `stop_review_app` job is **required** to have the following keywords defined - `stage` should be the same as the `review_app` in order for the environment to stop automatically when the branch is deleted +### `environment:rollout` + +> [Introduced][ce-21554] in GitLab 11.7. + +The `rollout` keyword defines the rollout deployment percentage. +The `rollout` accepts values between 1 and 99 (%). + +For values between 1 and 99 the `CI_ENVIRONMENT_TRACK=rollout` track is being deployed. +The value of `rollout` is passed as `CI_ENVIRONMENT_ROLLOUT` variable to CI job. + +Otherwise, when the `rollout:` is not defined the `CI_ENVIRONMENT_TRACK=stable` +is being deployed with `CI_ENVIRONMENT_ROLLOUT=100` set. + +``` +rollout 10%: + stage: incremental-deploy + script: echo "Rolling out $CI_ENVIRONMENT_TRACK / $CI_ENVIRONMENT_ROLLOUT ..." + environment: + name: production + rollout: 10 + +rollout 100%: + stage: deploy + script: echo "Rolling out $CI_ENVIRONMENT_TRACK / $CI_ENVIRONMENT_ROLLOUT ..." + environment: + name: production + rollout: 100 +``` + + ### Dynamic environments > **Notes:** @@ -2351,6 +2381,7 @@ GitLab CI/CD with various languages. [ce-7983]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7983 [ce-7447]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7447 [ce-12909]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/12909 +[ce-21554]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/21554 [environment]: ../environments.md "CI/CD environments" [schedules]: ../../user/project/pipelines/schedules.md "Pipelines schedules" [variables]: ../variables/README.md "CI/CD variables" |