Reindex User index to apply new mapping

Production Change

Change Summary

In a rails console, execute

Elastic::ReindexingTask.create!(targets: %w[User])

To reindex only the user index in order to apply a mapping change in gitlab-org/gitlab!102965 (merged).

Change Details

  1. Services Impacted - Elasticsearch global search
  2. Change Technician - @maddievn and @dgruzd
  3. Change Reviewer - @dgruzd
  4. Time tracking - 1 hour
  5. Downtime Component - None

Detailed steps for the change

Change Steps - steps to take to execute the change

Staging

To be executed by @maddievn

Estimated Time to Complete (mins) - 40 minutes

  • Get read-write access to a staging console

  • Log into a staging console via Teleport

  • Get the current mappings for the user index: (Grab a screenshot of the output)

    Gitlab::Elastic::Helper.default.client.indices.get_mapping(index: 'gitlab-production-users')

  • Execute the reindex task:

    task = Elastic::ReindexingTask.create!(targets: %w[User])

  • Track the progress of task every 10 minutes until the state is success. The reindexing will be executed by a cron worker that runs every 10 minutes (ElasticClusterReindexingCronWorker).

    task.reload

  • Once the state is success, get the new mappings for the user index: (Grab a screenshot of the output)

    Gitlab::Elastic::Helper.default.client.indices.get_mapping(index: 'gitlab-production-users')

Production

Estimated Time to Complete (mins) - 1 hour

  • Set label changein-progress /label ~change::in-progress

  • Request Teleport Access to production rails console

  • Ask SRE on call to approve teleport request and execute reindex: "@sre-oncall please note that we are wanting to reindex the user index in Elasticsearch. This will not impact any functionality as the index is not in use and will not need index pausing. Change request can be found here. Please can you approve the teleport access request (insert link to slack message) and execute Elastic::ReindexingTask.create!(targets: %w[User]) in a production console? Please paste the output in the thread so I can get the id of the task for monitoring. Much thanks!"

  • Get the current mappings for the user index: (Grab a screenshot of the output)

    Gitlab::Elastic::Helper.default.client.indices.get_mapping(index: 'gitlab-production-users')

  • Track the progress of task every 10 minutes until the state is success. The reindexing will be executed by a cron worker that runs every 10 minutes (ElasticClusterReindexingCronWorker). Elastic::ReindexingTask.last

  • Once the state is success, get the new mappings for the user index: (Grab a screenshot of the output)

    Gitlab::Elastic::Helper.default.client.indices.get_mapping(index: 'gitlab-production-users')

  • Set label changecomplete /label ~change::complete

Rollback

Rollback steps - steps to be taken in the event of a need to rollback this change

Estimated Time to Complete (mins) - 2 minutes

If the state is anything other than "success" after 1 hour, the reindexing is deemed unsuccessful. No functionality will be impacted since the index is not in use.

Monitoring

Key metrics to observe

Change Reviewer checklist

C4 C3 C2 C1:

  • Check if the following applies:
    • The scheduled day and time of execution of the change is appropriate.
    • The change plan is technically accurate.
    • The change plan includes estimated timing values based on previous testing.
    • The change plan includes a viable rollback plan.
    • The specified metrics/monitoring dashboards provide sufficient visibility for the change.

C2 C1:

  • Check if the following applies:
    • The complexity of the plan is appropriate for the corresponding risk of the change. (i.e. the plan contains clear details).
    • The change plan includes success measures for all steps/milestones during the execution.
    • The change adequately minimizes risk within the environment/service.
    • The performance implications of executing the change are well-understood and documented.
    • The specified metrics/monitoring dashboards provide sufficient visibility for the change.
      • If not, is it possible (or necessary) to make changes to observability platforms for added visibility?
    • The change has a primary and secondary SRE with knowledge of the details available during the change window.
    • The labels blocks deployments and/or blocks feature-flags are applied as necessary

Change Technician checklist

  • Check if all items below are complete:
    • The change plan is technically accurate.
    • This Change Issue is linked to the appropriate Issue and/or Epic
    • Change has been tested in staging and results noted in a comment on this issue.
    • A dry-run has been conducted and results noted in a comment on this issue.
    • The change execution window respects the Production Change Lock periods.
    • For C1 and C2 change issues, the change event is added to the GitLab Production calendar.
    • For C1 and C2 change issues, the SRE on-call has been informed prior to change being rolled out. (In #production channel, mention @sre-oncall and this issue and await their acknowledgement.)
    • For C1 and C2 change issues, the SRE on-call provided approval with the eoc_approved label on the issue.
    • For C1 and C2 change issues, the Infrastructure Manager provided approval with the manager_approved label on the issue.
    • Release managers have been informed (If needed! Cases include DB change) prior to change being rolled out. (In #production channel, mention @release-managers and this issue and await their acknowledgment.)
    • There are currently no active incidents that are severity1 or severity2
    • If the change involves doing maintenance on a database host, an appropriate silence targeting the host(s) should be added for the duration of the change.
Edited by Madelein van Niekerk