[Minor Version] Upgrade Global Search Elasticsearch cluster to 8.11.4
Production Change
Change Summary
The Global Search Elasticsearch cluster gprd-indexing-20220523
will be upgraded to Elasticsearch version 8.11.4
from 8.6.2
. The staging cluster gstg-indexing-20220519
will be upgraded first to verify.
Change Details
- Services Impacted - ServiceSearch
- Change Technician - @maddievn
- Change Reviewer - @terrichu
- Time tracking - 120 minutes (changes) + 360 minutes (rollback)
- Downtime Component - No downtime required for minor (rolling upgrade) or major (blue/green deployment) version upgrades.
- Scheduled time - Friday, 12 April at 7:00 UTC. We have coverage in APAC, EMEA and AMER.
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - 4 hours
Phase 0: Pre-flight
-
Create Elasticsearch Upgrade issue and link to this issue: Elasticsearch upgrade to 8.11.4 (gitlab-org/search-team/team-tasks#170 - closed) -
Upgrade CI pipelines in gitlab and gdk -
Upgrade QA nightly builds -
Add label C2 for major version upgrades or C3 for minor version upgrades -
Verify that there are no errors in the Staging or in the Production cluster and that both are healthy -
Verify that there are no alerts firing for the Advanced Search feature, Elasticsearch, Sidekiq workers, or redis -
Set label changein-progress /label ~change::in-progress
Phase 1: Monitoring cluster Upgrade
-
In the Elastic Cloud UI, create a snapshot -
In the Elastic Cloud UI, click Upgrade for the deployment -
Select the version, click the Upgrade button -
Check that metrics/logs are still being sent to the cluster for the indexing and logs clusters
Phase 2: Staging Upgrade
Minor version upgrades
-
In the Elastic Cloud UI, create a snapshot -
In the Elastic Cloud UI, click Upgrade for the deployment -
Select the version, click the Upgrade button -
Test read code paths -
Code -
Notes
-
-
Test write code paths -
Code -
Notes
-
Phase 3: Production Upgrade
Minor version upgrades
-
In the Elastic Cloud UI, create snapshot -
In the Elastic Cloud UI, click Upgrade for the deployment -
Select the version, click the Upgrade button -
Test read code paths -
Code -
Notes
-
-
Test write code paths -
Code -
Notes
-
Rollback
Rollback steps - steps to be taken in the event of a need to rollback this change
** Minor upgrades **
Estimated Time to Complete (mins) - 30-120 minutes (depending on how long the upgrade took and how much data needed to be restored)
-
If data loss occurs, data can be restored from snapshot. -
Any data added after the snapshot was taken, must be restored using the Advanced Search Disaster Recovery script
Monitoring
Key metrics to observe
sidekiq
- Metric: Search sidekiq indexing queues (Sidekiq Queues (Global Search))
- Location: https://dashboards.gitlab.net/d/sidekiq-main/sidekiq-overview?orgId=1
- What changes to this metric should prompt a rollback: Queues not draining
- Metric: Search sidekiq in flight jobs
- Location: https://dashboards.gitlab.net/d/sidekiq-shard-detail/sidekiq-shard-detail?orgId=1&from=now-30m&to=now&var-PROMETHEUS_DS=Global&var-environment=gprd&var-stage=main&var-shard=elasticsearch
- What changes to this metric should prompt a rollback: No jobs in flight
- Metric: sidekiq shard (elasticsearch) detail
- Location: https://dashboards.gitlab.net/d/sidekiq-shard-detail/sidekiq-shard-detail?orgId=1&var-PROMETHEUS_DS=Global&var-environment=gprd&var-stage=main&var-shard=catchall&var-shard=elasticsearch
- What changes to this metric should prompt a rollback: After unpausing indexing: Elevated queue length that does not resolve
Performance
- Metric: Search overview metrics
- Location: https://dashboards.gitlab.net/d/search-main/search-overview?orgId=1
- What changes to this metric should prompt a rollback: Flatline of RPS
- Metric: Search controller performance
- Location: https://dashboards.gitlab.net/d/web-rails-controller/web-rails-controller?orgId=1&var-PROMETHEUS_DS=Global&var-environment=gprd&var-stage=main&var-controller=SearchController&var-action=show
- What changes to this metric should prompt a rollback: Massive spike in latency
Elastic Cloud
- Metric: Elastic Cloud outages
- Location: https://status.elastic.co/#past-incidents
- What changes to this metric should prompt a rollback: Incidents which prevent upgrade of the cluster
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 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.
- 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.) - 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 Terri Chu