Document how to implement incremental rollouts with GitLab CI
Problem to solve
Auto DevOps offers an incremental rollout feature which uses GitLab CI. Customers who are not using Auto DevOps could achieve the same functionality by:
- Defining incremental stages in the
gitlab-ci.yml
(mimicking auto devops https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml#L60) - Define
$INCREMENTAL_ROLLOUT_MODE
and$INCREMENTAL_ROLLOUT_ENABLED
as environment variables
However, this is not documented outside of Auto DevOps.
Further details
Proposal
Document something along the lines of: How to perform incremental rollouts with GitLab CI
Who can address the issue
We'll need some CI experts, not sure who would be best but perhaps @jlenny can point us in the right direction
Other links/references
Designs
- Show closed items
Relates to
Related merge requests 3
When these merge requests are accepted, this issue will be closed automatically.
Activity
-
Newest first Oldest first
-
Show all activity Show comments only Show history only
- Daniel Gruesso added documentation label
added documentation label
- Author Contributor
/cc @marcia
- Jason Yavorska added devopsrelease [DEPRECATED] + 1 deleted label
added devopsrelease [DEPRECATED] + 1 deleted label
- Jason Yavorska changed milestone to %12.0
changed milestone to %12.0
- 🤖 GitLab Bot 🤖 added [deprecated] Accepting merge requests label
added [deprecated] Accepting merge requests label
- Jason Yavorska added Category:Advanced Deployments label
added Category:Advanced Deployments label
- Jason Yavorska added Category:Continuous Delivery label
added Category:Continuous Delivery label
- Contributor
@cstasik this item is still in the 12.0 milestone but it doesn't look like it was done. It will need to move out to some future release.
- Corrina Stasik changed milestone to %12.3
changed milestone to %12.3
Thanks @jlenny Moved to %12.3 as @ogolowinski and will start prioritizing that backlog. Given this is in @ogolowinski group this would be good to bring forward as a potential for that release.
- Marcia Ramos added docs-missing label
added docs-missing label
- Contributor
Added label gitlab-ce~10690712
- Orit Golowinski added grouprelease [DEPRECATED] label
added grouprelease [DEPRECATED] label
- Contributor
@jlenny who can help close the documentation gap here?
Collapse replies - Contributor
Per https://about.gitlab.com/handbook/product/categories/#release-management-group @marcia is the writer for your group @ogolowinski.
Edited by Jason Yavorska
- Contributor
@marcia Can you take this issue for the upcoming release and do you need help from the dev team?
@darbyfrey @jhampton - id labelled docs-missing - should dev provide the missing docs?
Edited by Orit Golowinski Collapse replies - Developer
At first glance, this seems to be already be documented here: https://docs.gitlab.com/ee/topics/autodevops/index.html#incremental-rollout-to-production-premium
What is missing from the current docs?
- Contributor
@darbyfrey documentation for using incremental rollout without using autodevops
- Contributor
Thanks, @ogolowinski.
do you need help from the dev team?
Yes, I do. At GL, the workflow for docs always starts with the software engineers or SMEs drafting the content and then sending it over to us for review and improvement. We, as information designers, can work with them from there.
Can you take this issue for the upcoming release
In any situation, while I don't have an MR with the content, my hands are tied, so it's not up to me to tell if we can make it into a given release. If the dev submits an MR with the first draft and assigns it to me, I can most likely make it into any upcoming release. I just need a few days to be able to review and work on the content with them.
- Contributor
Moving forward to %12.4 since per @darbyfrey this did not fit into %12.3 planning.
- Jason Yavorska changed milestone to %12.4
changed milestone to %12.4
- Darby Frey assigned to @sean_carroll
assigned to @sean_carroll
- Darby Frey added Deliverable label
added Deliverable label
- 🤖 GitLab Bot 🤖 removed [deprecated] Accepting merge requests label
removed [deprecated] Accepting merge requests label
- 🤖 GitLab Bot 🤖 changed milestone to %12.4
changed milestone to %12.4
- Darby Frey added workflowready for development label
added workflowready for development label
- Sean Carroll added workflowin dev label and removed workflowready for development label
added workflowin dev label and removed workflowready for development label
- Contributor
@jlenny Should this be marked as direction?
Collapse replies - Contributor
@ogolowinski yes I think so, though it's unclear what this issue is actually going to deliver. It's not very concrete (
Document something sort of along the lines of..
) - Contributor
Added direction label , though it is mainly documentation
- Developer
I am working through an example on this, and will provide a summary with screenshots etc. It might need some review from a technical writer, but I assume the main intent is to delve into the mechanics and present them in plain English.
- Contributor
It might need some review from a technical writer, but I assume the main intent is to delve into the mechanics and present them in plain English.
Exactly, thanks, @sean_carroll. :)
- Orit Golowinski added direction label
added direction label
- Darby Frey changed milestone to %12.5
changed milestone to %12.5
- Darby Frey added missed-deliverable missed:12.4 labels
added missed-deliverable missed:12.4 labels
- Mike Lewis mentioned in issue #35398 (closed)
mentioned in issue #35398 (closed)
- Sean Carroll marked this issue as related to #5415 (closed)
marked this issue as related to #5415 (closed)
- Developer
Created an example Ruby app https://gitlab.com/sean_carroll/ruby-app-incremental-rollout
- Sean Carroll created merge request !19992 (merged) to address this issue
created merge request !19992 (merged) to address this issue
- Sean Carroll mentioned in merge request !19992 (merged)
mentioned in merge request !19992 (merged)
- John Hampton changed milestone to %12.6
changed milestone to %12.6
- John Hampton added missed:12.5 label
added missed:12.5 label
- Orit Golowinski added to epic &2264
added to epic &2264
- Orit Golowinski mentioned in issue #2231 (closed)
mentioned in issue #2231 (closed)
- Jason Yavorska changed title from How to implement incremental rollouts with GitLab CI to Document how to implement incremental rollouts with GitLab CI
changed title from How to implement incremental rollouts with GitLab CI to Document how to implement incremental rollouts with GitLab CI
- Sean Carroll mentioned in commit b954f050
mentioned in commit b954f050
- Developer
Define
$INCREMENTAL_ROLLOUT_MODE
and$INCREMENTAL_ROLLOUT_ENABLED
as environment variablesI think these will apply only to Autodevops, not manual configurations.
Collapse replies - Contributor
@danielgruesso can you assist @sean_carroll with this?
- Author Contributor
I think this is correct. Those variables may only work for Auto DevOps pipelines. @mayra-cabrera @ayufan do you recall?
- Developer
Thanks @danielgruesso @ogolowinski I think I am now clear on this issue. I have some updates to apply but it should be possible to submit for review today.
2 - Maintainer
@danielgruesso Yes that was the original purpose when they were introduced on #5415 (closed), gitlab-ci-yml!160 (merged).
1
- Sean Carroll mentioned in commit 7e2bcf4e
mentioned in commit 7e2bcf4e
- Sean Carroll mentioned in commit c4c267a0
mentioned in commit c4c267a0
- Sean Carroll added workflowin review label and removed workflowin dev label
added workflowin review label and removed workflowin dev label
Currently ~"workflow::In review", moving to %12.7
- John Hampton changed milestone to %12.7
changed milestone to %12.7
- John Hampton added missed:12.6 label
added missed:12.6 label
- 🤖 GitLab Bot 🤖 mentioned in issue gl-retrospectives/release#16 (closed)
mentioned in issue gl-retrospectives/release#16 (closed)
- Orit Golowinski mentioned in merge request gitlab-com/www-gitlab-com!37387 (merged)
mentioned in merge request gitlab-com/www-gitlab-com!37387 (merged)
- Sean Carroll mentioned in commit ea7750b6
mentioned in commit ea7750b6
- Sean Carroll mentioned in commit 2de144b5
mentioned in commit 2de144b5
- Sean Carroll mentioned in commit 1e2c4de5
mentioned in commit 1e2c4de5
- Marcia Ramos closed via merge request !19992 (merged)
closed via merge request !19992 (merged)
- Marcia Ramos mentioned in commit 46673705
mentioned in commit 46673705
- 🤖 GitLab Bot 🤖 mentioned in issue gl-retrospectives/release#17 (closed)
mentioned in issue gl-retrospectives/release#17 (closed)