2023-07-05: GPRD roll out gateway for Zoekt

Production Change

Change Summary

We have add a TLS terminating gateway in front of our Zoekt webserver in gitlab-org/cloud-native/charts/gitlab-zoekt!15 (merged) rolled out in gitlab-com/gl-infra/k8s-workloads/gitlab-com!2806 (merged) . We are now changing GitLab to send requests to this new gateway URL instead of directly to the webserver. This URL can only be configured by the rails console for now.

Change Details

1. Services Impacted - ServiceZoekt
2. Change Technician - @johnmason
3. Change Reviewer - @dgruzd
4. Time tracking - 20 minutes
5. Downtime Component - none

Detailed steps for the change

Change Steps - steps to take to execute the change

Estimated Time to Complete (mins) - 10

• Set label changein-progress /label ~change::in-progress
• Merge gitlab-org/charts/gitlab!3257 (merged)
• Merge MR that bumps gitlab-zoekt chart version by chart-bumper bot.
• Wait until that finishes deploying
• From the rails console:
  • ::Zoekt::Shard.last.update!(index_base_url: "https://zoekt.gprd.gke.gitlab.net/")
• 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) - 10

• From the rails console:
  • ::Zoekt::Shard.last.update!(index_base_url: "http://10.216.8.36:6060/')
• Set label changeaborted /label ~change::aborted

Monitoring

Key metrics to observe

• Metric: Logs for Zoekt indexing worker
  • Location: logs
  • What changes to this metric should prompt a rollback: Indexing errors that we can't explain
• Metric: Sidekiq overview
  • Location: https://dashboards.gitlab.net/d/sidekiq-main/sidekiq-overview?orgId=1&var-PROMETHEUS_DS=Global&var-environment=gprd&var-stage=main
  • What changes to this metric should prompt a rollback: Lots of errors caused by new indexing process
• Metric: Search logs
  • Location: logs
  • What changes to this metric should prompt a rollback: Search errors for Zoekt that we can't explain

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.