Update CA certs configurations for registry DB in staging
Staging Change (Registry DB)
Change Summary
Remove CA certs configurations for postgresql.conf in staging registry DB instances and see effects when these changes are reintroduced e.g. does it restart postgres or patroni. This is to enable CA certs configuration on production registry DB
Also, this will reset gcloud service account for root user on patroni-v12-registry-03-db-gstg.c.gitlab-staging-1.internal as per: https://gitlab.com/gitlab-com/gl-infra/reliability/-/issues/16439#note_1108508202
Change Details
- Services Impacted - ServicePatroni / ServiceContainer Registry
- Change Technician - @fshabir
- Change Reviewer - @rhenchen.gitlab
- Time tracking - 60 minutes
- Downtime Component - ~ approx 6 minutes (2 minutes x 3 servers) downtime for registry DB (configuration reloads and failover of primary)
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - Estimated Time to Complete in Minutes
-
Set label changein-progress /label ~change::in-progress -
Disable chef-client on registry DB servers (to run chef-client manually)
bundle exec knife ssh "role:gstg-base-db-patroni-registry" "sudo systemctl stop chef-client && sudo systemctl disable chef-client"
-
Reset default gcloud service account from database-snapshottoterraformonpatroni-v12-registry-03-db-gstg, as per: https://gitlab.com/gitlab-com/gl-infra/reliability/-/issues/16439#note_1108508202
bundle exec knife ssh patroni-v12-registry-03-db-gstg.c.gitlab-staging-1.internal "sudo gcloud config set account `terraform@gitlab-staging-1.iam.gserviceaccount.com`"
-
Merge MR for updating chef role: https://gitlab.com/gitlab-com/gl-infra/chef-repo/-/merge_requests/2337 -
Run chef client in dry-run mode on each of registry database replica servers to cross-check the changes to be applied:
bundle exec knife ssh patroni-v12-registry-02-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
bundle exec knife ssh patroni-v12-registry-03-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
-
Run chef client on each of registry database replica servers sequentially:
bundle exec knife ssh patroni-v12-registry-02-db-gstg.c.gitlab-staging-1.internal "sudo chef-client"
bundle exec knife ssh patroni-v12-registry-03-db-gstg.c.gitlab-staging-1.internal "sudo chef-client"
-
Run chef client in dry-run mode on registry database primary server to cross-check the changes to be applied:
bundle exec knife ssh patroni-v12-registry-01-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
-
Run chef client on registry database primary server:
bundle exec knife ssh patroni-v12-registry-01-db-gstg.c.gitlab-staging-1.internal "sudo chef-client"
-
Revert this MR for updating adding CA cert configs to postgresql.conf: https://gitlab.com/gitlab-com/gl-infra/chef-repo/-/merge_requests/2337 -
Run chef client in dry-run mode on each of registry database replica servers to cross-check the changes to be applied:
bundle exec knife ssh patroni-v12-registry-02-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
bundle exec knife ssh patroni-v12-registry-03-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
-
Run chef client on each of registry database replica servers sequentially:
bundle exec knife ssh patroni-v12-registry-02-db-gstg.c.gitlab-staging-1.internal "sudo chef-client"
bundle exec knife ssh patroni-v12-registry-03-db-gstg.c.gitlab-staging-1.internal "sudo chef-client"
-
Run chef client in dry-run mode on registry database primary server to cross-check the changes to be applied:
bundle exec knife ssh patroni-v12-registry-01-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
-
Run chef client on registry database primary server:
bundle exec knife ssh patroni-v12-registry-01-db-gstg.c.gitlab-staging-1.internal "sudo chef-client"
-
Enable chef-client on registry DB servers
bundle exec knife ssh "role:gstg-base-db-patroni-registry" "sudo systemctl enable chef-client && sudo systemctl start chef-client"
-
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) - 30 minutes
-
Make and merge a revert MR for https://gitlab.com/gitlab-com/gl-infra/chef-repo/-/merge_requests/2337 -
dry chef-client on all the servers to see if any changes are still being applied by our MR:
bundle exec knife ssh patroni-v12-registry-02-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
bundle exec knife ssh patroni-v12-registry-03-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
bundle exec knife ssh patroni-v12-registry-01-db-gstg.c.gitlab-staging-1.internal "sudo chef-client -W"
-
Enable the chef-client
bundle exec knife ssh "role:gstg-base-db-patroni-registry" "sudo systemctl enable chef-client && sudo systemctl start chef-client"
-
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
- Metric: Metric Name
- Location: Dashboard URL
- What changes to this metric should prompt a rollback: Describe Changes
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-oncalland 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-managersand 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 Furhan Shabir