Skip to content

Update from code changes: document porter clusters create #436

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 create #436

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
33 changes: 33 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,39 @@ porter clusters list
porter config set-cluster [CLUSTER_ID]
```

### Create a Cluster

Provision a new cluster in the current project. Porter picks the cloud provider from the cloud account you select and chooses a Kubernetes version and node groups for you.

```bash
porter clusters create [flags]
```

| Flag | Description |
|------|-------------|
| `--name` | Name for the new cluster. Prompted if omitted, with a generated suggestion. |
| `--region` | Cloud region to provision into. Prompted if omitted. |
| `--cloud-account-id` | Cloud account to provision into. Determines the cloud provider (AWS, GCP, or Azure). Prompted if omitted. |
| `--yes` | Skip the cost confirmation prompt. Required in non-interactive terminals. |

Run without flags for an interactive walkthrough, or pass every flag for non-interactive use:

```bash
# Interactive: prompts for name, cloud account, and region
porter clusters create

# Non-interactive
porter clusters create \
--name my-cluster \
--region us-east-1 \
--cloud-account-id <account-id> \
--yes
```

<Info>
Provisioning is asynchronous and can take up to an hour. The command prints the cluster's dashboard URL as soon as the request is accepted so you can track progress. Cluster creation incurs a base monthly cost that varies by provider; the confirmation prompt shows the estimate before you commit.
</Info>

### View Current Configuration

```bash
Expand Down