Skip to content

Enable and remove remove_sha_from_releases_json feature flag

Summary

This issue is to rollout removing sha from releases/index.json field on production, that is currently behind the remove_sha_from_releases_json feature flag.

We currently expose release.sha in the internal API, not all users should have access to it, and it's not being used anywhere. This feature flag just removes the field from the internal JSON endpoint.

Owners

  • Team: ~"group::release"
  • Most appropriate slack channel to reach out to: #s_release
  • Best individual to reach out to: @vshushlin
  • PM: @cbalane

Stakeholders

Are there any other stages or teams involved that need to be kept in the loop?

I don't think so.

Expectations

What are we expecting to happen?

https://gitlab.com/gitlab-org/gitlab/-/releases.json should not have the sha field.

What might happen if this goes wrong?

If some frontend code actually uses this sha it can break. But AFAIK, this endpoint is only used in the MR filter by releases, and it uses only tag field.

What can we monitor to detect problems with this?

Errors on this controllers:

Strange front-end behavior? (I don't really know how to monitor this 🤷 )

What can we check for monitoring production after rollouts?

  • See dashboards above

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 <feature-flag-name> true --dev
    • /chatops run feature set <feature-flag-name> true --staging
  • 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

  • Ensure that the feature MRs have been deployed to both production and canary.
    • /chatops run auto_deploy status <merge-commit-of-your-feature>
  • If you're using project-actor, you must enable the feature on these entries:
    • /chatops run feature set --project=gitlab-org/gitlab <feature-flag-name> true
    • /chatops run feature set --project=gitlab-org/gitlab-foss <feature-flag-name> true
    • /chatops run feature set --project=gitlab-com/www-gitlab-com <feature-flag-name> true
  • If you're using user-actor, you must enable the feature on these entries:
    • /chatops run feature set --user=<your-username> <feature-flag-name> true
  • Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable.

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.
  • Notify #support_gitlab-com and your team channel (more guidance when this is necessary in the dev docs).

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).

  • Incrementally roll out the feature.
    • If the feature flag in code has an actor, perform actor-based rollout.
      • /chatops run feature set <feature-flag-name> <rollout-percentage> --actors
    • If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
      • /chatops run feature set <feature-flag-name> <rollout-percentage> --random
    • Enable the feature globally on production environment.
      • /chatops run feature set <feature-flag-name> 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 <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 <feature-flag-name> --dev
    • /chatops run feature delete <feature-flag-name> --staging
    • /chatops run feature delete <feature-flag-name>
  • Close this rollout issue.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set <feature-flag-name> false
Edited by Vladimir Shushlin