2023-10-03: Add clickhouse configuration to staging/production
Production Change
Change Summary
We're working on multiple features using ClickHouse.
Clickhouse clusters for staging and production have already been created:
- https://gitlab.com/gitlab-com/gl-infra/production/-/issues/16276+
- https://gitlab.com/gitlab-com/gl-infra/production/-/issues/16283+
In Configure ClickHouse YML file (gitlab-org/charts/gitlab!3383 - merged) we added an ability to configure ClickHouse credentials via Helm chart.
Those credentials are already available in 1 password vault.
Only 2 things left to do:
- create secrets
- fill
values
for gstg/gprd to enable clickhouse
See more in Configuration for ClickHouse on SaaS (gitlab-org/charts/gitlab#4924 - closed)
Change Details
- Services Impacted - ServiceClickHouseCloud ServiceGitLab Rails ServiceSidekiq
-
Change Technician -
@vshushlin
- Change Reviewer - @sabrams
- Time tracking - unknown
- Downtime Component - none
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
-
set secrets in the vault for staging and production, see gitlab-com/gl-infra/k8s-workloads/gitlab-com!3117 (diffs) for format -
merge Enable clickhouse in staging (gitlab-com/gl-infra/k8s-workloads/gitlab-com!3117 - merged) -
verify that gitlab-clickhouse-main-password-v3
is created properly in staging cluster -
login to rails node on staging, run rails console and run ClickHouse::Client.select('SELECT 1', :main)
, it should return[{"1"=>1}]
-
merge Enable clickhouse in production (gitlab-com/gl-infra/k8s-workloads/gitlab-com!3118 - merged) -
verify that gitlab-clickhouse-main-password-v3
is created properly in production cluster -
login to rails node on production, run rails console and run ClickHouse::Client.select('SELECT 1', :main)
, it should return[{"1"=>1}]
-
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
-
Revert gitlab-com/gl-infra/k8s-workloads/gitlab-com!3117 (merged) -
Revert production MR if it was created -
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
There should be no changes to any metrics, this change just adds the connection credentials.
All features using this connection are behind the feature flag
- 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 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.