2023-04-25: Hotpatch `deprecations.rb` on `gprd` gitaly/praefect
Production Change
Change Summary
We need to hotpatch deprecations.rb
file on gprd
gitaly and praefect servers in order to unblock deployments as migration jobs are failing due to deprecation warnings for 16.0 omnibus package.
Related issue: #9091 (closed)
Change Details
- Services Impacted - ServicePraefect / ServiceGitaly
-
Change Technician -
@Furhan Shabir
- Change Reviewer - @rehab / @f_santos
- 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) - 30 minutes
-
Set label changein-progress /label ~change::in-progress
-
Get list of gitaly servers in gprd
via chef role:
knife search node "roles:gprd-base-stor-gitaly-common OR roles:gprd-base-stor-praefect" -i | sort > target_servers
-
Make a backup copy of previous deprecations.rb
:
for server in $(cat target_servers);
do
knife ssh -C 10 $server "sudo cp -v /opt/gitlab/embedded/cookbooks/package/libraries/deprecations.rb /opt/gitlab/embedded/cookbooks/package/libraries/deprecations.rb.bkp.issue_9112; sudo cp -v /opt/gitlab/embedded/cookbooks/cache/cookbooks/package/libraries/deprecations.rb /opt/gitlab/embedded/cookbooks/cache/cookbooks/package/libraries/deprecations.rb.bkp.issue_9112";
done
-
Copy the deprecations.rb
file from local to remote servers:
for server in $(cat target_servers); do echo $server; scp deprecations.rb $server:~/; done
-
Diff original and uploaded deprecations.rb
files to confirm changes:
knife ssh -C 10 "roles:gprd-base-stor-gitaly-common OR roles:gprd-base-stor-praefect" "diff deprecations.rb /opt/gitlab/embedded/cookbooks/package/libraries/deprecations.rb"
-
Update deprecations.rb
file on remote servers:
knife ssh -C 10 "roles:gprd-base-stor-gitaly-common OR roles:gprd-base-stor-praefect" "sudo cp -v ~/deprecations.rb /opt/gitlab/embedded/cookbooks/package/libraries/deprecations.rb; sudo cp -v ~/deprecations.rb /opt/gitlab/embedded/cookbooks/cache/cookbooks/package/libraries/deprecations.rb"
-
Wait for deployment pipeline to get completed after replacing files and get confirmation from release manager -
Remove backup files
knife ssh -C 10 "roles:gprd-base-stor-gitaly-common OR roles:gprd-base-stor-praefect" "sudo rm -v /opt/gitlab/embedded/cookbooks/package/libraries/deprecations.rb.bkp.issue_9112; sudo rm -v /opt/gitlab/embedded/cookbooks/cache/cookbooks/package/libraries/deprecations.rb.bkp.issue_9112"
-
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
-
Restore old files:
knife ssh -C 10 "roles:gprd-base-stor-gitaly-common OR roles:gprd-base-stor-praefect" "sudo cp -v /opt/gitlab/embedded/cookbooks/package/libraries/deprecations.rb.bkp.issue_9112 /opt/gitlab/embedded/cookbooks/package/libraries/deprecations.rb; sudo cp -v /opt/gitlab/embedded/cookbooks/cache/cookbooks/package/libraries/deprecations.rb.bkp.issue_9112 /opt/gitlab/embedded/cookbooks/cache/cookbooks/package/libraries/deprecations.rb"
-
Remove backup files
knife ssh -C 10 "roles:gprd-base-stor-gitaly-common OR roles:gprd-base-stor-praefect" "sudo rm -v /opt/gitlab/embedded/cookbooks/package/libraries/deprecations.rb.bkp.issue_9112; sudo rm -v /opt/gitlab/embedded/cookbooks/cache/cookbooks/package/libraries/deprecations.rb.bkp.issue_9112"
-
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