Skip to content

[Feature flag] Rollout of `user_search_secondary_email`

What

This is a global API change, when searching users on /api/v4/users?search=<string>, to also search through users' secondary emails for <string> instead of just the primary email.

Owners

  • Team: Manage::Access
  • Most appropriate slack channel to reach out to: #g_manage_access
  • Best individual to reach out to: @cat

Expectations

What are we expecting to happen?

User searches include secondary emails (API, admin searches)

What might happen if this goes wrong?

Performance problems? Unexpected timeouts in api/v4/users with ?search=? Slowness when searching for users in the UI?

What can we monitor to detect problems with this?

  1. Users API search logs in Kibana: https://log.gprd.gitlab.net/goto/5a549e7225209f7676d37290a1112414
  2. Visualize endpoint for the above: https://log.gprd.gitlab.net/goto/558a1ad359fadfa89d32bd5a1e26922b

Beta groups/projects

N/A - API "global" change

Roll Out Steps

  • Enable on staging (/chatops run feature set user_search_secondary_email true --staging)
  • Test on staging
  • Ensure that documentation has been updated
  • Enable on GitLab.com for individual groups/projects listed above and verify behaviour (/chatops run feature set --project=gitlab-org/gitlab user_search_secondary_email true)
  • Coordinate a time to enable the flag with the SRE oncall and release managers
    • In #production by pinging @sre-oncall
    • In #g_delivery by pinging @release-managers
  • Announce on the issue an estimated time this will be enabled on GitLab.com
  • Enable on GitLab.com by running chatops command in #production (/chatops run feature set user_search_secondary_email true)
  • Cross post chatops Slack command to #support_gitlab-com (more guidance when this is necessary in the dev docs) and in your team channel
  • Announce on the issue that the flag has been enabled
  • Remove feature flag and add changelog entry
  • After the flag removal is deployed, clean up the feature flag by running chatops command in #production channel

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set user_search_secondary_email false
Edited by Catalin Irimie