Delete records for Deprecated Gilab Planner

Production Change

Change Summary

We need to delete certain data from the database.

When we first introduced Duo Planner agent, it was a custom agent. To be able to use it in the project, user needed to add it explicitly to their project in the AI agents catalog. That process creates Ai::Catalog::ItemConsumer record in the database. This record persists even when custom agent is deleted.

Since we moved Planner to Foundational agents, which are visible to users without the process of explicitly being added to the project - users who added the custom agent in the past are stuck with two duo planners. We would rather delete the ItemConsumer from the database for them so they have only one agent visible in their chat.

When ItemConsumer is deleted from the database, history of the past chats is persisted, it is just in the read-only state.

Oh_hilliD

Database query to execute: select id FROM "ai_catalog_item_consumers" WHERE "ai_catalog_item_consumers"."ai_catalog_item_id" = 348

DELETE FROM "ai_catalog_item_consumers" WHERE "ai_catalog_item_consumers"."ai_catalog_item_id" = 348

select id FROM "ai_catalog_item_consumers" WHERE "ai_catalog_item_consumers"."ai_catalog_item_id" = 348 => should be 0 at this point.

Currently there are 243 rows to be deleted (state for December 3rd).

Issue: gitlab-org/gitlab#582801 This step was discussed here as a part of migration from custom agent to foundational agent: gitlab-org/gitlab#577588

Change Details

  1. Services Impacted - GitLab monolith

  2. Change Technician - @mksionek, support: @nicolasdular

  3. Change Reviewer - @donnaalexandra

  4. Scheduled Date and Time (UTC in format YYYY-MM-DD HH:MM) - 2025-12-12 12:00

  5. Time tracking -

    • 15 minutes.

  6. Downtime Component - No

Important

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.

Preparation

Note

The following checklists must be done in advance, before setting the label changescheduled

Change Reviewer checklist

C4

  • 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.
  • For C1 and C2 changes, mention @gitlab-org/saas-platforms/inframanagers in this issue to 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. (Check the incident.io GitLab.com Production EOC schedule 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

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

  • Set label changein-progress /label ~change::in-progress
  • tsh db login --proxy=production.teleport.gitlab.net --db-user=console-rw --db-name=gitlabhq_production db-main-primary-gprd
  • tsh db connect db-main-primary-gprd
  • Sanity check: select * FROM "ai_catalog_item_consumers" WHERE "ai_catalog_item_consumers"."ai_catalog_item_id" = 348;
  • [x ] Copy to the local file: \copy ( select * FROM "ai_catalog_item_consumers" WHERE "ai_catalog_item_consumers"."ai_catalog_item_id" = 348) TO 'deprecated-gitlab-planner-2025-12-12.csv' CSV HEADER;
  • DELETION: DELETE FROM "ai_catalog_item_consumers" WHERE "ai_catalog_item_consumers"."ai_catalog_item_id" = 348;
  • Check: select id FROM "ai_catalog_item_consumers" WHERE "ai_catalog_item_consumers"."ai_catalog_item_id" = 348; => should be 0 at this point.
  • UI place to check: https://gitlab.com/gitlab-org/plan-stage/product-planning/plan-agents/-/issues/253
  • remove file from local storage `rm deprecated-gitlab-planner-2025-12-12.csv`
  • 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 (5) - Estimated Time to Complete in Minutes

  • In psql console: \copy ai_catalog_item_consumers FROM '../deprecated-gitlab-planner-2025-12-12.csv' CSV HEADER;
  • Set label changeaborted /label ~change::aborted

Monitoring

Key metrics to observe

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