[Feature flag] Enable "real_time_issue_due_date"
Summary
This issue is to rollout Update Issue Due Date in real time on production,
that is currently behind the real_time_issue_due_date
feature flag.
Owners
- Team: application performance
- Most appropriate slack channel to reach out to:
#g_application_performance
- Best individual to reach out to:
@alipniagov
- PM:
@rogerwoo
Stakeholders
- Name of a
@gweaver
- groupproject management
Expectations
What are we expecting to happen?
The Due Date
field on the Issue page will be real-time powered.
See the recording in the MR: !114927 (merged)
When is the feature viable?
Enable the FF
What might happen if this goes wrong?
We may see FE errors related to GraphQL Subscriptions / Appollo layer.
What can we monitor to detect problems with this?
We could keep an eye on the:
- Sentry: https://new-sentry.gitlab.net/
- Websockets dashboards: https://dashboards.gitlab.net/d/websockets-main/websockets-overview?orgId=1
- Redis: https://dashboards.gitlab.net/d/redis-main/redis-overview?orgId=1
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. - Verify that the feature MRs have been deployed to non-production environments with:
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set <feature-flag-name> true --dev --staging --staging-ref
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Note you will need to make sure you are configured to use canary as outlined here when accessing the staging environment in order to make sure you are testing appropriately.
Specific 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 (#g_TEAM_NAME
).
N/A
Preparation before global rollout
-
Set a milestone to the rollout issue to signal for enabling and removing the feature flag when it is stable. - [-] Check if the feature flag change needs to be accompanied with a change management issue. Cross link the issue here if it does.
-
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. - [-] Ensure that documentation has been updated (More info).
- [-] 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
#support_gitlab-com
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 (#g_TEAM_NAME
).
-
/chatops run feature set real_time_issue_due_date true
-
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 <feature-flag-name>
feature flag. Ask for review and merge it.-
Remove all references to the feature flag from the codebase. -
Remove the YAML definitions for the feature from the repository. -
Create a changelog entry.
-
-
Ensure that the cleanup MR has been included in the release package. If the merge request was deployed before the monthly release was tagged, the feature can be officially announced in a release blog post. -
/chatops run release check <merge-request-url> <milestone>
-
-
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 real_time_issue_due_date --dev --staging --staging-ref --production
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set real_time_issue_due_date false