[Feature flag] Enable use_only_onboarding_status_db_value
Summary
This issue is to roll out the feature on production,
that is currently behind the use_only_onboarding_status_db_value
feature flag.
Owners
- Most appropriate Slack channel to reach out to:
#g_acquisition
- Best individual to reach out to: @dstull
Expectations
What are we expecting to happen?
We will be driving registration navigation and types of registration in the code off the stored database value in user_details.onboarding_status
What can go wrong and how would we detect it?
Users could be routed to the wrong onboarding steps during registration and possibly get trapped in registration.
We'd be able to see from validations.
Rollout Steps
Note: Please make sure to run the chatops commands in the Slack channel that gets impacted by the command.
Rollout on non-production environments
- Verify the MR with the feature flag is merged to
master
and have been deployed to non-production environments with/chatops run auto_deploy status https://gitlab.com/gitlab-org/gitlab/-/merge_requests/148752
-
Enable the feature globally on non-production environments with /chatops run feature set use_only_onboarding_status_db_value true --dev --pre --staging --staging-ref
-
Verify that the feature works as expected. The best environment to validate the feature in is staging-canary
as this is the first environment deployed to. Make sure you are configured to use canary.-
Staging: Verify Free registration works from start to finish(LearnGitLab) as expected. -
Staging: Verify Free converted to trial registration works from start to finish(LearnGitLab) as expected. -
Staging: Verify Trial registration works from start to finish(LearnGitLab) as expected. -
Staging: Verify Invite registration works from start to finish as expected. -
Staging: Verify Subscription registration works from start to finish as expected. - This one may not be possible and maybe ok to only handle in Production verification.
-
-
If the feature flag causes end-to-end tests to fail, disable the feature flag on staging to avoid blocking deployments. - See
#qa-staging
Slack channel and look for the following messages:- test kicked off:
Feature flag <feature-flag-name> has been set to true on **gstg**
- test result:
This pipeline was triggered due to toggling of <feature-flag-name> feature flag
- test kicked off:
- See
For assistance with end-to-end test failures, please reach out via the #test-platform
Slack channel. Note that end-to-end test failures on staging-ref
don't block deployments.
Preparation before global rollout
-
Set a milestone to this rollout issue to signal for enabling and removing the feature flag when it is stable. -
Ensure that you or a representative in development can be available for at least 2 hours after feature flag updates in production. If a different developer will be covering, or an exception is needed, please inform the oncall SRE by using the @sre-oncall
Slack alias. -
Leave a comment on the feature issue announcing estimated time when this feature flag will be enabled on GitLab.com. -
Ensure that any breaking changes have been announced following the release post process to ensure GitLab customers are aware. -
Notify the #support_gitlab-com
Slack channel and your team channel (more guidance when this is necessary in the dev docs). -
Ensure that the feature flag rollout plan is reviewed by another developer familiar with the domain.
Global rollout on production
For visibility, all /chatops
commands that target production should be executed in the #production
Slack channel
and cross-posted (with the command results) to the responsible team's Slack channel (#<slack-channel-of-dri-team>
).
-
Enable the feature globally on production environment: /chatops run feature set use_only_onboarding_status_db_value true
-
Verify that the feature works as expected. The best environment to validate the feature in is staging-canary
as this is the first environment deployed to. Make sure you are configured to use canary.-
Production: Verify Free registration works from start to finish(LearnGitLab) as expected. -
Production: Verify Free converted to trial registration works from start to finish(LearnGitLab) as expected. -
Production: Verify Trial registration works from start to finish(LearnGitLab) as expected. -
Production: Verify Invite registration works from start to finish as expected. -
Production: Verify Subscription registration works from start to finish as expected.
-
-
Observe appropriate graphs on https://dashboards.gitlab.net and verify that services are not affected. -
Leave a comment on the feature issue announcing that the feature has been globally enabled. -
Wait for at least one day for the verification term.
Release the feature
After the feature has been deemed stable, the clean up should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase.
You can either create a follow-up issue for Feature Flag Cleanup or use the checklist below in this same issue.
-
Create a merge request to remove the use_only_onboarding_status_db_value
feature flag. Ask for review/approval/merge as usual. The MR should include the following changes:- Remove all references to the feature flag from the codebase.
- Remove the YAML definitions for the feature from the repository.
- Create a changelog entry.
-
Close the feature issue to indicate the feature will be released in the current milestone. -
Clean up the feature flag from all environments by running these chatops command in #production
channel:/chatops run feature delete use_only_onboarding_status_db_value --dev --pre --staging --staging-ref --production
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled on production by running the following Chatops command:
/chatops run feature set use_only_onboarding_status_db_value false
-
Disable the feature flag on non-production environments:
/chatops run feature set use_only_onboarding_status_db_value false --dev --pre --staging --staging-ref
-
Delete feature flag from all environments:
/chatops run feature delete use_only_onboarding_status_db_value --dev --pre --staging --staging-ref --production