GPRD: Rollout USE_CI_BUILDS_ROUTING_TABLE environment variable
Production Change
Change Summary
gitlab-org/gitlab!129812 (merged) introduced the USE_CI_BUILDS_ROUTING_TABLE
environment variable that changes CommitStatus.table_name = :ci_builds
to CommitStatus.table_name = :p_ci_builds
(and all models that inherit from CommitStatus
, i.e. Ci::Build
). We can't use a feature flag here because the code is evaluated at boot time and a feature flag toggle will not take effect until the next deployment/restart, which defeats the FF purpose.
ci_builds
is a partition of p_ci_builds
and querying p_ci_builds
should behave exactly as querying ci_builds
directly, but since we're working with ci_builds
the unexpected is always a possibility.
Staging issue: #16942 (closed)
Change Details
- Services Impacted - ServiceWeb ServiceAPI ServiceGitLab Rails ServiceSidekiq
-
Change Technician -
@gsgl
-
Change Reviewer -
@gsgl
- Time tracking - 20m
- Downtime Component - No downtime
Set Maintenance Mode in GitLab
If your change involves scheduled maintenance, add a step to set and unset maintenance mode per our runbooks. This will make sure SLA calculations adjust for the maintenance period.
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
-
Apply to production-canary
-
Merge the MR that adds the environment variable to gprd-cny
- gitlab-com/gl-infra/k8s-workloads/gitlab-com!3066 (merged). -
Wait for the deployment to complete and verify
-
-
Monitor for 2 hours -
Apply to production
-
Merge the MR that adds the environment variable to gprd
- gitlab-com/gl-infra/k8s-workloads/gitlab-com!3067 (merged). -
Wait for the deployment to complete and verify
-
-
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) - Estimated Time to Complete in Minutes
-
In case we want to rollback the canary stage of environment we can disable it with -
Disable production-canary - /chatops run canary --disable --production
-
-
In case we want to rolling back the change from main stage of an environment, we need to revert the MR that introduced the environment variable and apply the configuration change -
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
-
Metric: rails_primary_sql SLI Apdex
- Location: https://dashboards.gitlab.net/d/patroni-ci-main/patroni-ci-overview?orgId=1&var-PROMETHEUS_DS=Global&var-environment=gprd
- What changes to this metric should prompt a rollback: Any drop in apdex
-
Metric: PostgreSQL Overview dashboard
- Location: https://dashboards.gitlab.net/d/000000144/postgresql-overview?orgId=1&from=now-6h&to=now&var-prometheus=Global&var-environment=gprd&var-type=patroni-ci
- What changes to this metric should prompt a rollback: Any deviation from the normal state
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 change window has been agreed with Release Managers in advance of the change. If the change is planned for APAC hours, this issue has an agreed pre-change approval.
- 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 prior to any C1, C2, or blocks deployments 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.