2022-11-29: Update Kubernetes secrets for gitlab.com to External Secrets
Production Change
Change Summary
Issue: https://gitlab.com/gitlab-com/gl-infra/reliability/-/issues/16357
We want to update the secrets in production to use the new secrets from External Secrets that are pulled from Vault, and then decommission the project gitlab-secrets
.
Change Details
- Services Impacted - ServiceKube ServiceAPI ServiceGitLab Rails ServiceGitlab Shell ServiceGitLab SSHD ServiceContainer Registry ServiceSidekiq ServiceMailroom ServiceKAS
-
Change Technician -
@pguinoiseau
- Change Reviewer - @f_santos @ggillies @skarbek
- Time tracking - 120 minutes
- Downtime Component - none
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - 120 minutes
-
Get approval for the following MRs: -
Ping @ggillies on Slack 1 hour prior -
Set label changein-progress /label ~change::in-progress
-
Mark gitlab-com/gl-infra/k8s-workloads/gitlab-com!2368 (merged) as ready and merge it -
Immediately go the master
branch pipeline and cancel the upgrade jobs -
One by one, run the apply job for each cluster and check that all pods are starting successfully: -
gprd-cny
-
gprd
-
gprd-us-east1-b
-
gprd-us-east1-c
-
gprd-us-east1-d
-
-
Mark https://gitlab.com/gitlab-com/gl-infra/k8s-workloads/gitlab-secrets/-/merge_requests/30 as ready and merge it -
Immediately go the main
branch pipeline and cancel the upgrade jobs -
One by one, run the apply job for each cluster, restart each deployment in that cluster and check that all pods are starting successfully: kubectl -n gitlab get deployments kubectl -n gitlab rollout restart deployment/... kubectl -n gitlab get pods
-
gprd-cny
-
gprd
-
gprd-us-east1-b
-
gprd-us-east1-c
-
gprd-us-east1-d
-
-
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
-
Revert and merge the following MRs: -
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
- Metric: All apdex and error ratios
- Location: https://dashboards.gitlab.net/d/general-triage/general-platform-triage?orgId=1
- What changes to this metric should prompt a rollback: Any apdex drop or error ratio increase on the related services
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 Pierre Guinoiseau