Skip to content

Commit afdc600

Browse files
committed
docs: add Concepts page to nav
1 parent 2d6f7a4 commit afdc600

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

docs/concepts.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Concepts
2+
3+
- **Project allow-list**`project-ids` is the universe of what may be nuked. The CLI may *narrow* it (`--project-id`); it cannot widen. Without it, the tool refuses to start.
4+
- **Blocklist**`blocklist` is a hard veto. If any blocked ID also appears in `project-ids`, startup fails. Belt-and-suspenders against fat-fingering.
5+
- **Dry-run default**`run` lists what would be deleted. Real deletion requires `--no-dry-run` *and* (unless `--force`) typing the project ID back at a prompt.
6+
- **Filters mark resources as ineligible** — counter-intuitive: a filter is a *keep-list*, not a kill-list. Anything matched by a filter survives; everything else gets deleted. Filter by `Name`, `tag:*`, etc.
7+
- **Presets** — reusable named filter sets, attached to accounts via `presets: [...]`. Same shape as filters; just deduped at one site.
8+
- **Resource type include/exclude**`resource-types.includes` narrows the registered set; `excludes` always wins. Empty `includes` means all registered types.
9+
- **Scopes** — every resource is `ProjectScope` today (region-aware, scoped to one STACKIT project). Engine also supports an `OrganizationScope` we have not yet used.
10+
- **Dependency order** — each `Resource` declares `DependsOn`. libnuke topologically sorts and only deletes a resource once everything it depends on has finished. E.g. `Network` depends on `NetworkInterface` so NICs detach first.
11+
- **Settings & feature-flags** — per-resource toggles (e.g. `EmptyBeforeDelete: true` for buckets) live under `settings:`. Engine behaviors (`wait-on-dependencies`, `filter-groups`) live under `feature-flags:`.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ nav:
5353
- Install: install.md
5454
- Authentication: auth.md
5555
- Quick Start: quick-start.md
56+
- Concepts: concepts.md
5657
- Configuration:
5758
- Overview: config.md
5859
- Filtering: config-filtering.md

0 commit comments

Comments
 (0)