[Feature Flag] .com Rollout: enable_add_on_users_pagesize_selection

As a part of [Duo Provisioning] Expand UI-based bulk assignm... (&15050 - closed), we would like to allow customers to be able to choose number of user items(20/50/100) shown on Duo eligible users list. This issue covers the rollout procedures of the Feature flag that enables this feature.

This is the Rollout issue for: #500068 (closed)

Owners

Expectations

An additional UI dropdown element will be visible in the Usage Quotas section that lets customers choose the number of user items to display in the eligible users list between choices from 20/50/100 items.

When is the feature viable?

What might happen if this goes wrong?

The feature flag should be turned off. Nothing else would be needed.

What can we monitor to detect problems with this?

  • TODO: dashboard

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

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 enable_add_on_users_pagesize_selection true --dev --staging --staging-ref
    • If the feature flag causes QA end-to-end tests to fail:
      • Disable the feature flag on staging to avoid blocking deployments.
  • 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.

For assistance with QA end-to-end test failures, please reach out via the #quality Slack channel. Note that QA test failures on staging-ref don't block deployments.

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

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

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][main-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).

  • Incrementally roll out the feature.
    • Between every step wait for at least 15 minutes and monitor the appropriate graphs on https://dashboards.gitlab.net.
    • If the feature flag in code has an actor, perform actor-based rollout.
      • /chatops run feature set enable_add_on_users_pagesize_selection <rollout-percentage> --actors
      • If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
        • /chatops run feature set enable_add_on_users_pagesize_selection <rollout-percentage> --random
        • Enable the feature globally on production environment.
          • /chatops run feature set enable_add_on_users_pagesize_selection true
  • Observe appropriate graphs on https://dashboards.gitlab.net and verify that services are not affected.
  • Leave a comment on [the feature issue][main-issue] announcing that the feature has been globally enabled.
  • Wait for at least one day for the verification term.
Edited by Divya Mahadevan