Container Registry: Apply post-deployment migrations in v3.63.0
Production Change
Change Summary
Request to manually apply the database post-deployment migrations included in the container registry v3.63.0 in pre
, gstg
and gprd
environments.
Please read the Context
section in this runbook to understand why this is needed.
Target post-deployment migrations:
-
20221123174403_post_add_layers_simplified_usage_index_batch_1
: Adds a new index to partitions0
and1
of thelayers
table.
This change has been reviewed and approved by the Database team (including the execution timings on a production replica) in gitlab-org/container-registry!1163 (merged).
There will be two additional migrations (with another change request) to introduce the same index in the remaining 62 partitions.
This is the first time we're shipping a post-deployment migration, so we want to start small. For this same reason, this time we're deploying v3.63.0 to pre
and gstg
separately. In the future, there is likely no reason why we can't deploy to all environments first and then apply post-deployment migrations in all environments "immediately" one after the other.
Change Details
- Services Impacted - ServiceContainer Registry
- Change Technician - @skarbek
- Change Reviewer - @jdrpereira
- Time tracking - 15 minutes (sum of all environments)
- Downtime Component - NA
Detailed steps for the change
Repeat for each environment once v3.63.0 is deployed there. @jdrpereira will signal once it can be done for each:
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - 5 minutes
-
Set label changein-progress /label ~change::in-progress
-
Proceed as described here. - If able, run the
time
command such that we can measure how long the command takes
- If able, run the
-
Set label changescheduled /label ~change::scheduled
if there are other environments left -
Set label changecomplete /label ~change::complete
if no environments left
Rollback
Rollback steps - steps to be taken in the event of a need to rollback this change
NA. The post-deployment migration included in this release introduces two new indexes. In the worst case scenario, the creation of an index fails and aborts the execution. The only side effect is that we would have to repeat this change after a fix was released.
Monitoring
Key metrics to observe
- Metric: Postgres CPU Usage
- Location: https://dashboards.gitlab.net/d/patroni-registry-main/patroni-registry-overview?orgId=1&viewPanel=92
- What changes to this metric should prompt a rollback: If an abnormal CPU usage spike is observed around the execution of this change, please abort the ongoing CLI command.
There are no relevant application metrics to observe here as the introduced index will remain unused until it is created in all layers
table partitions.
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.
- 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.