Run Rake Task to Backfill contract_overages_allowed__c in CustomersDot Staging

Staging Change

Change Summary

This will run the backfill introduced in https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/11606 in the CustomersDot Staging environment.

This will backfill the contract_overages_allowed__c column on the zuora_subscriptions table with the values for the column found in Zuora.

Related epic: https://gitlab.com/groups/gitlab-org/-/epics/16168+

Related issue: https://gitlab.com/gitlab-org/customers-gitlab-com/-/issues/12124+

Also relevant: https://gitlab.com/gitlab-org/customers-gitlab-com/-/issues/9929+

Just for reference: https://handbook.gitlab.com/handbook/engineering/infrastructure/change-management/#scheduling-the-change

Change Details

  1. Services Impacted - CustomersDot Staging
  2. Change Technician - @jagood / Jason Goodman
  3. Change Reviewer -@gsgl / Gonzalo Servat
  4. Scheduled Date and Time (UTC in format YYYY-MM-DD HH:MM) - 2024-02-12 Sometime between 17:00 and 22:00
  5. Time tracking About 20 minutes to 1 hour. See estimate below.
  6. Downtime Component - No downtime required.

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.

NA

Detailed steps for the change

Change Steps - steps to take to execute the change

Estimated Time to Complete (mins) - 20 minutes to 1 hour

  • Set label changein-progress /label ~change::in-progress
  • Login to the CustomersDot Staging Database console. Execute the query below in the Monitoring section.
  • Log into CustomersDot Staging with rake task permissions. (Instructions here)
  • Start a tmux session: tmux new -s jagood-rake-backfill-contract-overages-allowed
  • Run the task as a dry run: sudo -u customersdot cdot-rake data_maintenance:backfill_zuora_local_subscription_contract_overages_allowed
  • Check the log output. Verify it looks correct.
  • Run the task to write the data: sudo -u customersdot cdot-rake data_maintenance:backfill_zuora_local_subscription_contract_overages_allowed[false]
  • Check the log output. Verify it looks correct.
  • In the CustomersDot Staging Database console, execute the query in the Monitoring section again.
  • Set label changecomplete /label ~change::complete

The log for the job should be a file located at /home/customersdot/CustomersDot/current/log/backfill_zuora_local_subscription_contract_overages_allowed.log.

Record the results of each step above in this issue. Use confidential notes since information about the database will be present.

Rollback

Rollback steps - steps to be taken in the event of a need to rollback this change

It is not possible to roll back this rake task.

This field is not used yet. If we had a problem with the backfill we would just need to fix the data.

Estimated Time to Complete (mins) - Estimated Time to Complete in Minutes

  • Rollback Step 1
  • Rollback Step 2
  • Set label changeaborted /label ~change::aborted

Monitoring

Key metrics to observe

There are no metrics to observe.

However, we can check the results of this query before and after the rake task runs:

SELECT contract_overages_allowed__c, COUNT(*) FROM zuora_subscriptions GROUP BY contract_overages_allowed__c;

This should give us some extra reassurance of the results on top of the log.

We will also monitor the logs as described above.

  • Metric: Metric Name
    • Location: Dashboard URL
    • What changes to this metric should prompt a rollback: Describe Changes

Change Reviewer checklist

C4 C3 C2 C1:

  • 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.

C2 C1:

  • 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.
    • 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.

NA:

  • 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. Mention @gitlab-org/saas-platforms/inframanagers in this issue to request approval and provide visibility to all infrastructure managers.
  • 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.)
Edited by Jason Goodman