[Experiment Rollout] ci_runner_templates - CI Runner Templates - ci_runner_templates
What
Track the status of an experiment through to removal.
- Experiment key:
ci_runner_templates
- Framework:
gitlab_experiment
- Feature flag name:
ci_runner_templates
This is an experiment tracking issue for: https://gitlab.com/gitlab-org/growth/team-tasks/-/issues/319
using the scoped experiment label.
As well as defining the experiment rollout and cleanup, this issue incorporates the relevant
Feature Flag Roll Out
steps.
Owners
- Team:
group::activation
- Most appropriate slack channel to reach out to:
#g_activation
- Best individual to reach out to: @alexbuijs
Expectations
What are we expecting to happen?
What might happen if this goes wrong?
What can we monitor to detect problems with this?
Tracked data
Measuring success
experiments
table
id | name |
---|---|
experiment_id | ci_runner_templates |
experiment_subjects
table
experiment_id | namespace_id | variant |
---|---|---|
experiment_id | namespace_id |
0 (control) or 1 (candidate) |
onboarding_progresses
table
namespace_id | pipeline_created_at |
---|---|
namespace_id |
NOT NULL (converted) or NULL (not converted) |
Snowplow tracking
The following events are tracked anonymously through Snowplow:
activity | category | action | context | sent from | variants |
---|---|---|---|---|---|
Visited a projects' empty pipelines page | ci_runner_templates |
assignment |
gitlab_experiment json schema | backend | control + candidate |
The user clicked on Instal GitLab Runners button |
projects:pipelines:index |
install_runners_button_clicked |
gitlab_experiment json schema | frontend | candidate |
The user clicked on Learn about Runners button |
projects:pipelines:index |
learn_button_clicked |
gitlab_experiment json schema | frontend | candidate |
The user clicked on a template link | projects:settings:ci_cd:show |
template_clicked_linux-docker-nonspot |
gitlab_experiment json schema | frontend | candidate |
The user clicked on a template link | projects:settings:ci_cd:show |
template_clicked_linux-docker-spotonly |
gitlab_experiment json schema | frontend | candidate |
The user clicked on a template link | projects:settings:ci_cd:show |
template_clicked_win2019-shell-nonspot |
gitlab_experiment json schema | frontend | candidate |
The user clicked on a template link | projects:settings:ci_cd:show |
template_clicked_win2019-shell-spot |
gitlab_experiment json schema | frontend | candidate |
Note: you can utilize CXL calculator to determine if your experiment has reached signifigance, it also includes an estimate for how much longer an experiment will need to run for before reaching signifigance.
Staging Test
- /chatops run feature set ci_runner_templates true --staging
- Create or go to an empty project
- Disable "Default to Auto DevOps pipeline" in the CI/CD settings of the project (
http://localhost:3000/<group_name>/<project_name>/-/settings/ci_cd
- Go to CI/CD -> Pipelines (
http://localhost:3000/<group_name>/<project_name>/-/pipelines
Experiment tracking log
Experiment Results
Roll Out Steps
-
Confirm that QA tests pass with the feature flag enabled (if you're unsure how, contact the relevant stable counterpart in the Quality department) -
Enable on staging ( /chatops run feature set feature_name true --staging
) -
Test on staging -
Ensure that documentation has been updated -
Enable on GitLab.com for individual groups/projects listed above and verify behaviour ( /chatops run feature set --project=gitlab-org/gitlab feature_name true
) -
Coordinate a time to enable the flag with the SRE oncall and release managers - In
#production
mention@sre-oncall
and@release-managers
. Once an SRE on call and Release Manager on call confirm, you can proceed with the rollout
- In
-
Announce on the issue an estimated time this will be enabled on GitLab.com -
Enable on GitLab.com by running chatops command in #production
(/chatops run feature set feature_name true
) -
Cross post chatops Slack command to #support_gitlab-com
(more guidance when this is necessary in the dev docs) and in your team channel -
Announce on the issue that the flag has been enabled -
Remove experiment code and feature flag and add changelog entry - a separate cleanup issue might be required -
After the flag removal is deployed, clean up the feature flag by running chatops command in #production
channel -
Assign to the product manager to update the knowledge base (if applicable)
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set ci_runner_templates false
Edited by Phil Calder