2024-11-07: Migrate AIGateway GCP vertex project used for text model to `ai-framework-prod`

Production Change

Migrate AIGateway GCP vertex project used for text model to ai-framework-prod

Change Details

1. Services Impacted - AIGateway
2. Change Technician - @danielryan
3. Change Reviewer - @igorwwwwwwwwwwwwwwwwwwww
4. Time tracking - 5 minutes
5. 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) - 5 minutes

• Set label changein-progress /label ~change::in-progress
• run curl command to validate results before change work (ref)
• Change project-level CI variables in ai-assist project ONLY for ingest/prod environment context (ref):
  • INGEST_SERVICE_ACCOUNT : ai-framework-prod-ci@gitlab-ai-framework-prod.iam.gserviceaccount.com
  • INGEST_WORKLOAD_IDENTITY_PROVIDER : projects/336816156367/locations/global/workloadIdentityPools/gitlab-pool-oidc-39903947/providers/gitlab-jwt-39903947
  • INGEST_GCP_PROJECT_NAME: gitlab-ai-framework-prod
• Trigger the ingest pipeline (link) with GITLAB_INGEST_TRIGGER set to prod and GITLAB_DOCS_REPO_REF set to a gitlab-org/gitlab tag. We'll want one pipeline for each of these versions:
  • 17-0-stable-ee
  • 17-1-stable-ee
  • 17-2-stable-ee
  • 17-3-stable-ee
  • 17-4-stable-ee
  • master (currently 17.5 as of rollout)
• merge MR that changes the GCP project to gitlab-ai-framework-prod and wait for deploy to finish (Merge request)
• validate that these data stores were added under GCP Agent Builder for the new project (ref)
• Test gitlab.com using curl command (ref)
• Test Duo Chat on gitlab.com via UI
• 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) - 5 minutes

• Change variables back to their original values ONLY for ingest/prod environment context:
  • INGEST_SERVICE_ACCOUNT : ai-gateway-sa@unreview-poc-390200e5.iam.gserviceaccount.com
  • INGEST_WORKLOAD_IDENTITY_PROVIDER: projects/402231234223/locations/global/workloadIdentityPools/gitlab-ai-gateway/providers/gitlab-ai-gateway-provider
  • INGEST_GCP_PROJECT_NAME: unreview-poc-390200e5
• Merge revert MR to change back project
• Set label changeaborted /label ~change::aborted

Monitoring

Key metrics to observe

• Metric: error rate
  • Location: https://dashboards.gitlab.net/d/ai-assisted-main/ai-assisted3a-overview?from=now-6h%2Fm&orgId=1&var-stage=main&to=now%2Fm&var-PROMETHEUS_DS=mimir-gitlab-gprd&var-environment=gprd
  • What changes to this metric should prompt a rollback: any spike in error rate after the change is deployed

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