Skip to content

Clickhouse to Snowflake - Provisioning of S3 bucket for Production

Production Change

Change Summary

As part of Production Readiness for the GitLab Usage Billing System, we need to provision an AWS S3 bucket which will be used to receive daily Clickhouse exports. These packages will be then imported in Snowflake for analytical purposes.

More details in https://gitlab.com/groups/gitlab-org/-/epics/19234+

This process involves the following:

  1. Creation of a S3 bucket. S3 credentials will then shared with the Fulfillment team.
  2. Configure Snowflake storage integration to access that S3 bucket

More details below.

Change Details

  1. Services Impacted - AWS S3
  2. Change Technician - TBD DRI for the execution of this change
  3. Change Reviewer - TBD DRI for the review of this change
  4. Scheduled Date and Time (UTC in format YYYY-MM-DD HH:MM) - TBD Start date and time planned to execute change steps YYYY-MM-DD HH:MM
  5. Time tracking - N/A
  6. Downtime Component - N/A

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

  • The Change Criticality has been set appropriately and requirements have been reviewed.
  • The change plan is technically accurate.
  • The rollback plan is technically accurate and detailed enough to be executed by anyone with access.
  • 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.
  • Once all boxes above are checked, mark the change request as scheduled: /label ~"change::scheduled"
  • For C1 and C2 change issues, the change event is added to the GitLab Production calendar by the change-scheduler bot. It is schedule to run every 2 hours.
  • For C1 change issues, a Senior Infrastructure Manager has provided approval with the manager_approved label on the issue.
  • For C2 change issues, an 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.
  • For C1, C2, or blocks deployments change issues, confirm with Release managers that the change does not overlap or hinder any release process (In #production channel, mention @release-managers and this issue and await their acknowledgment.)

Detailed steps for the change

Pre-execution steps

Note

The following steps should be done right at the scheduled time of the change request. The preparation steps are listed below.

  • Make sure all tasks in Change Technician checklist are done
  • For C1 and C2 change issues, the SRE on-call has been informed prior to change being rolled out. (Search the PagerDuty schedule for "SRE 8-hour" to find who will be on-call at the scheduled day and time. SREs on-call must be informed of plannable C1 changes at least 2 weeks in advance.)
    • The SRE on-call provided approval with the eoc_approved label on the issue.
  • For C1, C2, or blocks deployments change issues, Release managers have been informed 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.

Change steps - steps to take to execute the change

TBD - Estimated Time to Complete in Minutes

  • Set label changein-progress /label ~change::in-progress

  • Creation of the S3 bucket and a folder in it. This may involve the creation of a new IAM role and policies.

    • S3 bucket name: TBD (suggested: prdsub-clickhouse-to-snowflake)
    • Folder name: TBD (suggested: data)
    • The goal is for the CustomersDot Rails to use these credentials when triggering the data export from Clickhouse:
    • FYI: in Staging, CDot Rails app is using the credentials of an IAM role attached to the AmazonS3FullAccess policy.

  • Share following S3 credentials with Fulfillment team:

    • S3 folder location, eg: https://<bucket-name>.s3.<aws-region>.amazonaws.com/<folder-name>
    • IAM key
    • IAM secret

  • Configure Snowflake storage integration to access the new S3 bucket

  • 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

  • Delete previously created S3 bucket
  • Remove related credentials from the CustomersDot Rails Production vault (ping engineer from Fulfillment team)
  • Set label changeaborted /label ~change::aborted

/label change changeunscheduled

/label typeignore

Edited by Etienne Baqué