Skip to content

Update from code changes: document porter clusters delete #435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update from code changes: document porter clusters delete #435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions cli/basic-usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,28 @@ porter clusters list
porter config set-cluster [CLUSTER_ID]
```

### Delete a Cluster

Delete a cluster from the current project. Porter tears down the infrastructure it provisioned, and the cluster moves to the `deleting` state while teardown runs asynchronously.

```bash
porter clusters delete [CLUSTER]
```

Identify the cluster by its ID, name, or vanity name. Add `-y` or `--yes` to skip the confirmation prompt (required in non-interactive terminals).

```bash
# Delete by name (with interactive confirmation)
porter clusters delete my-cluster

# Delete by ID, skipping the prompt
porter clusters delete 42 --yes
```

<Info>
A cluster can only be deleted once no applications are still running on it. If applications remain, the command exits without deleting and lists the resources you need to remove first. Teardown can take up to an hour.
</Info>

### View Current Configuration

```bash
Expand Down