[Feature flag] Clean up Jira Connect OAuth
Summary
This issue is to roll out the feature to self-managed users. This will be a breaking change (#387299 (closed))
Rollout summary
-
Staging rollout -
Staging OAuth application set up -
Staging test successfull -
Production OAuth application ID setup -
Production test successfull -
Production rollout -
Improve self-managed workaround documentation: #387298 (closed) -
Create a deprecation entry -
Remove the feature flag
Owners
- Team: ~"group::integrations"
- Most appropriate slack channel to reach out to:
#g_ecosystem_integrations
- Best individual to reach out to: @justin_ho and @Andysoiron
- PM: @m_frankiewicz
Stakeholders
Expectations
What are we expecting to happen?
When is the feature viable?
What might happen if this goes wrong?
What can we monitor to detect problems with this?
Consider mentioning checks for 5xx errors or other anomalies like an increase in redirects (302 HTTP response status)
What can we check for monitoring production after rollouts?
Consider adding links to check for Sentry errors, Production logs for 5xx, 302s, etc.
Rollout Steps
Rollout on non-production environments
- Ensure that the feature MRs have been deployed to non-production environments.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set jira_connect_oauth true --dev
-
/chatops run feature set jira_connect_oauth true --staging
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable.
Specific rollout on production
- Ensure that the feature MRs have been deployed to both production and canary.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
Preparation before global rollout
-
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). -
Announce on the feature issue an estimated time this 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.
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
).
-
Enable the feature globally on production environment. -
/chatops run feature set jira_connect_oauth true
-
-
Announce on the feature issue 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 jira_connect_oauth
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 deployed to both production and canary. If the merge request was deployed before the code cutoff, the feature can be officially announced in a release blog post. -
/chatops run auto_deploy status <merge-commit-of-cleanup-mr>
-
-
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 jira_connect_oauth --dev
-
/chatops run feature delete jira_connect_oauth --staging
-
/chatops run feature delete jira_connect_oauth
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set jira_connect_oauth false
Availability & Testing
Risks:
- Availability of the Jira Connect app.
- We don't currently run Jira cloud tests in CI.
Suggestions:
- Ensure the behavior feature flag works on staging-ref/staging
- Consider pulling in @sgregory2 to re-setup/run e2e specs against staging-ref