2023-07-31: Reindex Zoekt projects
Production Change
Change Summary
We've discovered an incompatibility between zoekt-dynamic-indexerver
and gitlab-zoekt-indexer
, which caused Zoekt indices to be incomplete. In this CR we need to re-index all Zoekt-enabled projects with the new gitlab-zoekt-indexer
.
Change Details
- Services Impacted - ServiceZoekt
- Change Technician - @dgruzd @johnmason
- Change Reviewer - @johnmason @skarbek
- Time tracking - 10m
- Downtime Component - No downtime
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - 5
-
Set label changein-progress /label ~change::in-progress
-
Execute the steps below on staging -
Truncate existing indices Gitlab::Search::Zoekt::Client.truncate
-
Trigger full reindexing Zoekt::IndexedNamespace.pluck(:namespace_id).each { |namespace_id| Search::Zoekt::NamespaceIndexerWorker.perform_async(namespace_id, 'index') }
-
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) - 1
-
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
- Metric: Kibana logs for
Zoekt::IndexerWorker
- Location: https://log.gprd.gitlab.net/app/r/s/iaBgU
- What changes to this metric should prompt a rollback: Repeated failures to index projects
Change Reviewer checklist
-
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.
-
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 change window has been agreed with Release Managers in advance of the change. If the change is planned for APAC hours, this issue has an agreed pre-change approval.
- The labels blocks deployments and/or blocks feature-flags are applied as necessary.
Change Technician checklist
IMPORTANT: We have modified the approval rules for Change requests until 2023-08-01, after this date this note can be removed:
-
All C1 and C2 change issues require Director level or above approval
-
All C3 change issues require staff+ engineer in Infrastructure to review (
@igorwwwwwwwwwwwwwwwwwwww
@abrandl
@reprazent
@msmiley
@cmiskell
@nolith
@andrewn
@sxuereb
@jarv
) -
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 prior to any C1, C2, or blocks deployments 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 Gonzalo Servat