stackql / stackql/stackql-deploy-rs
[FEATURE] `predelete` hook: run a statement or script before a resource's `delete`
Nessuno ha ancora preso questa issue.
- Lingua principale
- Rust
- Stelle
- 1
- Fork
- 0
- Merge medio
- 12m
- PR unite (30g)
- 4
Descrizione
Problem
Some resources cannot be deleted until something else is done to them first, and that something is not expressible as a single statement in the resource's .iql file. The canonical case is an S3 bucket: DeleteBucket fails with 409 BucketNotEmpty (surfaced by stackql as no response body for operation = DeleteBucket) while the bucket holds objects, and emptying a bucket needs an object listing loop (and a version listing loop for versioned buckets). A Databricks workspace root bucket is never empty at teardown time because the control plane writes DBFS and log data into it.
Today the only options are:
skip_on_delete: trueon the bucket, which retains it (fine when the data should be kept, wrong when it should not),--on-failure ignore, which finishes the teardown but leaves the bucket behind, or- an out-of-band
aws s3 rm --recursivebefore runningteardown.
Other resources with the same shape: ECR repositories with images, Cognito user pools with a deletion protection flag, RDS instances with deletion protection, Key Vaults with soft delete, GitHub repositories with branch protection rules, or any resource where a dependent that is not managed by the stack has to be cleared first.
Proposal
A predelete hook that teardown runs for a resource after the exists check reports the resource present and before its delete statement. Two forms:
- A
/*+ predelete */anchor in the resource's.iqlfile for cases that are a single statement (for example flipping a deletion protection property with anUPDATE, or aDELETEon a dependent resource that the provider can address in one call). Rendered with the same context asdelete, includingthis.*fields captured by the exists check. - A
predeletescript in the manifest for cases that need a loop or an external tool, using the same contract astype: scriptresources (run withsh -c, exports optional):
- name: aws/s3/root_bucket
file: aws/s3/bucket.iql
predelete:
run: aws s3 rm s3://{{ root_bucket_name }} --recursive
props:
- name: bucket_name
value: "{{ root_bucket_name }}"
If both are present the anchor runs first, then the script.
Behaviour to pin down
- Ordering. exists check, then
predelete, thendelete, thencallback:delete, then the post-delete check (perpostdelete_retries/postdelete_retry_delay). When the delete is re-issued (thedeleteanchor'sretries),predeleteshould run again before each attempt, since the reason for the retry may be that more objects appeared. - Failure. A failing
predeleteis a failed delete: abort under--on-failure error, log and report the resource as not confirmed deleted under--on-failure ignore. Fatal errors abort in both modes. - Dry run. Render and log the anchor / script without executing, like
delete. - Not run when the resource does not exist, when the resource has
skip_on_delete: true, or when the delete is skipped because a query references an export that could not be collected. - Not run by
buildortest. - Idempotency is the author's responsibility, as with
scriptresources; document that apredeletemay run more than once per teardown. - The anchor form should support the usual options (
retries,retry_delay).
Related
- #56 / #57:
skip_on_delete,--on-failure ignoreand the end-of-run summary of unconfirmed deletes, which are the current workarounds. - The
tests/live_stacks/aws_ssm_onfailurelive stack already has an S3DeleteBucketfailure case; apredeletethat empties a bucket could be exercised there, or in a small dedicated S3 stack (an empty standard bucket is free).
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo il flusso di eliminazione del teardown e il contratto della risorsa esistente type: script, quindi esamina tests/live_stacks/aws_ssm_onfailure per il caso di errore S3 DeleteBucket già presente. Definisci e testa i comportamenti di ordinamento, nuovi tentativi, errore, dry-run, skip e idempotenza descritti qui; il lavoro è completato quando un'ancora di predelete e uno script manifest funzionano senza influire su build o test.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- rust, shell, yaml
- Ambito
- cloud, devops, infrastructure
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Attiva
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100