feat: destroy command — requirements and design spec by Shnekit · Pull Request #128 · aws/CICD-for-SageMakerUnifiedStudio

Shnekit · 2026-03-31T20:41:21Z

Overview

This PR adds the requirements and design spec for the new destroy command. No implementation code yet — for team review before implementation begins.

What's included

.kiro/specs/destroy-command/requirements.md — 12 requirements covering the full feature scope
.kiro/specs/destroy-command/design.md — technical design with architecture, data models, correctness properties, and testing strategy

Feature summary

The destroy command is the inverse of deploy. It reads a manifest file and deletes all resources created by deploy, in a safe dependency order:

Stop active Airflow workflow runs (re-checked at destruction time)
Delete workflow-created resources (Glue jobs) via operator registry
Delete Airflow serverless workflows
Delete QuickSight dashboards, datasets, data sources (by prefix scan)
Delete S3 objects at declared targetDirectory prefixes
Delete DataZone project (only if project.create: true)

Key design decisions

Two-phase model: full validation across all stages before any destructive action
Collect-all-errors: validation never aborts early — all issues reported together before aborting
Operator registry: workflow-created resources (Glue jobs) discovered by parsing workflow YAML and matching operator class names against a registry dict — extensible without if/elif chains
Prefix-based QuickSight enumeration: scans by Resource_Prefix rather than reconstructing IDs
No --async mode: dependency ordering requires synchronous execution
Collision detection: QuickSight prefix scan and Airflow workflow name lookup both abort if more resources found than declared — even with --force

Testing plan

Unit tests covering all correctness properties (mocked AWS calls)
Integration test: extend existing test_dashboard_glue_quick_workflow.py with destroy + verify steps after the existing deploy + test steps

Review focus

Please review requirements and design for correctness, completeness, and any edge cases missed before implementation begins.

vasu2856 · 2026-04-07T19:05:38Z

+
+#### Acceptance Criteria
+
+1. THE Destroy_Command SHALL run a full validation cycle across ALL targeted stages before initiating any destructive action or prompting for confirmation. Resource discovery includes live AWS API calls to resolve S3 connection details, enumerate QuickSight resources by prefix, and check for active Airflow workflow runs.


Will the validations include missing permission errors?

See, if we can add them. Otherwise, we can run destroy multiple times

I think I am gonna wait for your dry-run CR to be out and see, if I can use your existing IAM validation logic to destroy resources.

vasu2856 · 2026-04-08T19:04:15Z

+                )
+                continue
+
+            s3_helper.delete_objects(bucket, object_keys, region=effective_region)


Will this delete the bundle as well?

This only deletes the deploy S3 target resources. I think bundle is stored somewhere else, so it is not deleted

This is deleting everything that deploy command creates. I believe bundle is saved somewhere outside of this path, so it will stay

vasu2856 · 2026-04-08T19:07:22Z

@@ -0,0 +1,51 @@
+"""
+Operator registry for the destroy command.


Not sure if we need this.

Keeping for now, can remove this later, if customers do not want it

vasu2856 · 2026-04-08T19:08:06Z

        )


+def list_dashboards(


Why do we need to list the dashboards? can't we just directly fetch the ones mentioned in the manifest?

In the manifest we are only listing the dashboard name. Any account can have any number of identical dashboard names and they can also be changed after creation. So, doing a prefix search is a little safer, though still not entirely deterministic

not sure if i follow the reasoning. We should use the same logic to identify the resource as the deploy. If deploy looks up using name, destroy should do the same as well.

Deploy command is actually using dashboard_id look up as well. Dashboard name is used as the name of the exported .qs file (which QuickSight generates itself I think).

- Requirements: 12 requirements covering CLI interface, validation phase, destruction ordering, Airflow workflow deletion, QuickSight prefix-based cleanup, S3 object deletion, conditional DataZone project deletion, operator registry for workflow-created resources (Glue jobs), idempotency, output formatting, and scope boundaries - Design: two-phase architecture (validate-all-then-destroy), operator registry pattern, data models, correctness properties, error handling tables, unit test strategy, integration test extension plan, and design decision rationale for operator registry vs reverse DAG approach

…ration tests

…orkflow

- Add Bootstrap_Connection deletion (datazone.create_connection bootstrap actions) - Add catalog resource deletion (glossaries, terms, form types, asset types, assets, data products) - Refactor S3 deletion to use existing s3_helper instead of inline boto3 calls - Add resource_type field to OPERATOR_REGISTRY entries (remove hardcoding) - Derive registry resource types dynamically in _destroy_stage Step b - Fix Rich markup mismatch in WARNING message (red→yellow) - Update requirements (Req 13-15), design, and tasks for connections and catalog - 86 unit tests passing

- Add destroy command section to docs/cli-commands.md (options, examples, TEXT/JSON output, two-phase behavior, use cases, notes) - Update command count from 8 to 9 in cli-commands.md - Add destroy to command overview table and pipeline commands list - Expand Clean Up Resources walkthrough to cover both destroy and delete - Add Rollback Workflow to Common Workflows section in cli-commands.md - Add destroy cleanup step to README.md Quick Start - Add Rollback Guide link to README.md documentation section - Add destroy cleanup step to all 6 translated READMEs (pt, fr, it, ja, zh, he) - Update examples/full-pipeline-lifecycle.sh Step 8 to use destroy - Update examples/cleanup-demo-resources.sh to use destroy with explanation - Add new docs/rollback-guide.md covering manual rollback strategies, destroy+redeploy clean slate approach, decision tree, catalog/project preservation, GitHub Actions automated rollback workflows, and bundle-based rollback setup

… --targets - Remove delete command entirely (code, tests, docs, CLI registration) - Replace delete with destroy in integration test cleanup steps - Make --targets required for destroy (no implicit all-stages) - Add WARNING banner: destroy deletes all matching resources including user-created ones, not only CI/CD-created resources - Add irreversibility warning in CLI docs - Remove explicit workflow run stopping from destruction phase; MWAA Serverless auto-terminates runs on workflow deletion - Fetch workflow definitions from MWAA API (get_workflow) instead of scanning S3 for YAML files - Add deploy/destroy drift detection: DEPLOY_RESOURCE_TYPES registry in resource_types.py with unit test asserting parity with DESTROY_SUPPORTED_RESOURCE_TYPES - Rename --stages to --targets across all commands (including create) and all documentation for consistency - Fix --targets typo in AWS EventBridge put-targets doc examples - Consolidate cli-commands.md into single 1-10 command list, remove duplicate sections, fix numbering, remove stray content - Split destroy.py (1656 lines) into four modules: destroy.py (282), destroy_models.py (68), destroy_validator.py (568), destroy_executor.py (382) - Update specs (requirements, design, tasks) to reflect all changes

Content from main was lost during cli-commands.md consolidation. Restores: pre-deployment validation step, --dry-run/--skip-validation options, dry run mode documentation, catalog asset access details.

- Remove unused imports from destroy.py (F401) - Apply black formatting to all destroy helper modules - Update drift test to import directly from destroy_models - Restore dry-run example reports in cli-commands.md

…, cleanup - Strip numbered prefixes from all command help strings in cli.py - Remove chat command (agent.chat_agent module does not exist) - Remove last delete command reference from cleanup-demo-resources.sh - Apply black formatting to airflow_serverless.py

- Move resolve_resource_prefix to quicksight.py (shared by deploy+destroy) - Add resolve_resource_ids_from_overrides to quicksight.py for exact ID resolution from manifest overrideParameters (Dashboards/DataSets/DataSources) - Add find_resources_by_prefix to quicksight.py for paginated prefix scan - Update deploy to use shared helpers instead of inline boto3 calls (fixes missing pagination in deploy's post-import resource discovery) - Update destroy validator: try exact IDs from overrides first, fall back to prefix scan for uncovered types - Add unit tests for all three new quicksight helper functions - Remove duplicate resolve_resource_prefix tests from test_destroy.py - Remove dead chat command, cleanup-demo-resources.sh delete reference - Apply black formatting to all changed files

Update cli-commands.md with main's dry-run best-effort language: pre-deployment validation, --dry-run option, dry run mode section, and pre-deployment validation section all now include caveats about best-effort nature and conditions that may cause deployment failure despite clean validation.

vasu2856

LGTM

Shnekit requested a review from vasu2856 April 1, 2026 14:57

Shnekit self-assigned this Apr 1, 2026

Shnekit force-pushed the feat/destroy-command branch from 940267d to 22490bd Compare April 2, 2026 17:35

Shnekit had a problem deploying to test-aws-account April 3, 2026 15:58 — with GitHub Actions Failure

vasu2856 reviewed Apr 7, 2026

View reviewed changes

Comment thread .kiro/specs/destroy-command/requirements.md Outdated

vasu2856 reviewed Apr 8, 2026

View reviewed changes

Shnekit force-pushed the feat/destroy-command branch from 4dc08b1 to 9a314ff Compare April 13, 2026 18:47

Shnekit requested a review from vasu2856 April 13, 2026 19:32

Shnekit added 14 commits April 15, 2026 12:02

Add tasks and testing guide for destroy-command spec

701a671

feat: implement destroy command with operator registry and unit/integ…

fa9c7ba

…ration tests

fix: black formatting in destroy.py and update test-destroy-command w…

aba9bc3

…orkflow

fix: move rich.markup import to module level for black compliance

200bbc4

fix: fix isort import ordering in destroy.py

7bd2166

docs: restore dry-run mode and catalog details in deploy section

9184a4f

Content from main was lost during cli-commands.md consolidation. Restores: pre-deployment validation step, --dry-run/--skip-validation options, dry run mode documentation, catalog asset access details.

fix: lint errors and formatting

efbbe35

- Remove unused imports from destroy.py (F401) - Apply black formatting to all destroy helper modules - Update drift test to import directly from destroy_models - Restore dry-run example reports in cli-commands.md

Shnekit force-pushed the feat/destroy-command branch from 2d698dc to 14da19c Compare April 15, 2026 16:10

vasu2856 approved these changes Apr 15, 2026

View reviewed changes

Shnekit merged commit eef7c05 into main Apr 15, 2026
6 checks passed

Shnekit deleted the feat/destroy-command branch April 15, 2026 17:28


		#### Acceptance Criteria

		1. THE Destroy_Command SHALL run a full validation cycle across ALL targeted stages before initiating any destructive action or prompting for confirmation. Resource discovery includes live AWS API calls to resolve S3 connection details, enumerate QuickSight resources by prefix, and check for active Airflow workflow runs.

		@@ -0,0 +1,51 @@
		"""
		Operator registry for the destroy command.

		)


		def list_dashboards(

Conversation

Shnekit commented Mar 31, 2026

Overview

What's included

Feature summary

Key design decisions

Testing plan

Review focus

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Shnekit Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vasu2856 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Shnekit Apr 9, 2026 •

edited

Loading