Skip to main content
Kubox has four parts. Most commands make sense once you can place them.

​
The four parts

The division that matters: the plane decides, your account holds. Your clusters, their build state, and the keys that protect it live in your AWS account. Revoke the build role and Kubox stops managing them. It never held a copy.

​
The normal path

Four commands take you from nothing to a running cluster.
1

Sign in

Signs in to a console and stores a session on this machine. See kubox login.
2

Create the boundary in your AWS account

Run this as an AWS administrator. It sets the limits Kubox works inside, and creates the identity it connects as. See kubox cloud bootstrap.
3

Connect the account

Creates the role Kubox builds with, plus somewhere to keep build state and the keys to protect it — all in your account. See kubox cloud connect.
4

Create a cluster

The first command submits the request and returns before the cluster is ready. The second reports progress. See kubox cluster create.
5

Reach it with kubectl

Adds the cluster to your kubeconfig. Access uses your Kubox sign-in, so sign in again when it expires. See kubox cluster connect.From here it is an ordinary Kubernetes cluster — your existing manifests, operators, and tools work unchanged. Kubox provisions the cluster; deploying your application is still your job.

​
The direct path

kubox admin drives a cloud or a cluster from your machine with the credentials you already hold, with no management plane involved:
It is the same build, started from a different place. Use admin when the normal path cannot help:
  • a cluster no plane manages
  • the first plane, before one exists
  • a failure you need to get underneath
Hello-World AWS Cluster walks the direct path end to end, because it needs no plane.
Both paths produce the same cluster. The difference is who holds the credentials and who tracks the result.

​
Where to go next

Management plane

What a plane owns, and when you need your own.

Cloud accounts

The trusted boundary, and what Kubox can and cannot do in your account.

CLI reference

Every command, option, and consequence.