2023-04-24: Rollout Gitaly/Praefect configuration updates in `pre`
pre
Change
Change Summary
Update gitaly
and praefect
configuration structure due to deprecation/removal in upcoming release 16.0.
Reference issues:
Change Details
- Services Impacted - ServicePraefect / ServiceGitaly
-
Change Technician -
@Furhan Shabir
- Change Reviewer - @steveazz
- Time tracking - 60 minutes
- Downtime Component - none
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - 60 minutes
-
Set label changein-progress /label ~change::in-progress
-
Disable chef-client on pre
servers
knife ssh -C 3 "roles:pre-base" "chef-client-disable 'Updating praefect and gitaly configurations, see issue https://gitlab.com/gitlab-com/gl-infra/production/-/issues/9094'"
-
Update the structure of secrets in vault for praefect
vault kv get -mount=chef -format json -field data env/pre/shared/gitlab-omnibus-secrets > /tmp/omnibus-v5.json
cp /tmp/omnibus-v5.json /tmp/omnibus-v6.json
edit /tmp/omnibus-v6.json
diff /tmp/omnibus-v5.json /tmp/omnibus-v6.json
cat /tmp/omnibus-v6.json | vault kv patch -mount=chef env/pre/shared/gitlab-omnibus-secrets -
vault kv get -mount=chef -format json -field data env/pre/shared/gitlab-omnibus-secrets > /tmp/omnibus-v6-remote.json
diff /tmp/omnibus-v5.json /tmp/omnibus-v6-remote.json
rm /tmp/omnibus-v5.json /tmp/omnibus-v6.json /tmp/omnibus-v6-remote.json
-
Merge this MR: https://gitlab.com/gitlab-com/gl-infra/chef-repo/-/merge_requests/3264 -
Take gitaly config backup and run chef-client on gitaly-01-sv-pre.c.gitlab-pre.internal
and check if Gitaly updates successfully bydiff
knife ssh gitaly-01-sv-pre.c.gitlab-pre.internal "sudo cp -v /var/opt/gitlab/gitaly/config.toml /var/opt/gitlab/gitaly/config.toml.bkp.issue_9094"
knife ssh praefect-01-stor-pre.c.gitlab-pre.internal "sudo chef-client-enable"
knife ssh gitaly-01-sv-pre.c.gitlab-pre.internal "sudo chef-client"
knife ssh gitaly-01-sv-pre.c.gitlab-pre.internal "sudo gitlab-ctl status gitaly"
knife ssh gitaly-01-sv-pre.c.gitlab-pre.internal "sudo diff /var/opt/gitlab/gitaly/config.toml /var/opt/gitlab/gitaly/config.toml.bkp.issue_9094"
-
Take praefect config backup and run chef-client on praefect-01-stor-pre.c.gitlab-pre.internal
and verify configurationdiff
knife ssh praefect-01-stor-pre.c.gitlab-pre.internal "sudo cp -v /var/opt/gitlab/praefect/config.toml /var/opt/gitlab/praefect/config.toml.bkp.issue_9094"
knife ssh praefect-01-stor-pre.c.gitlab-pre.internal "sudo chef-client-enable"
knife ssh praefect-01-stor-pre.c.gitlab-pre.internal "sudo chef-client"
knife ssh praefect-01-stor-pre.c.gitlab-pre.internal "sudo gitlab-ctl praefect check"
knife ssh praefect-01-stor-pre.c.gitlab-pre.internal "sudo diff /var/opt/gitlab/praefect/config.toml /var/opt/gitlab/praefect/config.toml.bkp.issue_9094"
-
Remove backup of config files from above servers:
knife ssh gitaly-01-sv-pre.c.gitlab-pre.internal "sudo rm /var/opt/gitlab/gitaly/config.toml.bkp.issue_9094"
knife ssh praefect-01-stor-pre.c.gitlab-pre.internal "sudo rm /var/opt/gitlab/praefect/config.toml.bkp.issue_9094"
-
If both praefect and gitaly nodes are updated and running successfully then enable chef-client and let all the rest of servers converge automatically:
knife ssh "roles: pre-base" "sudo chef-client-enable"
-
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) - 60 minutes
-
Revert this MR: https://gitlab.com/gitlab-com/gl-infra/chef-repo/-/merge_requests/3264 -
Remove backup of config files from servers:
knife ssh gitaly-01-sv-pre.c.gitlab-pre.internal "sudo rm /var/opt/gitlab/gitaly/config.toml.bkp.issue_9094"
knife ssh praefect-01-stor-pre.c.gitlab-pre.internal "sudo rm /var/opt/gitlab/praefect/config.toml.bkp.issue_9094"
-
enable chef-client and let all the servers converge automatically
knife ssh "roles: pre-base" "sudo chef-client-enable"
-
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-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.
Edited by Furhan Shabir