Skip to main content
You need Helm and kubectl on your computer, and an account that can create namespaces, service accounts and role bindings. The cluster needs Kubernetes 1.25 or later, and 1.28 or later to sign in with tokens, as below.

Try it in five minutes

1

Install the chart

This creates a deployment with one KubeStacks pod, a kubestacks Service on port 80, and a service account. With the default sign-in (tokens), that service account needs no permissions, and the chart gives it none.
2

Open it

Forward a port from your computer to the Service:
Then open http://localhost:8080. The chart’s notes, printed after helm install, say the same for your settings.
3

Get a token to sign in with

Any bearer token the cluster accepts works. To try it, make a service account that can view everything, and a token for it:
The token is valid for an hour. kubectl create token takes --duration for a longer one, up to what your API server allows.
4

Sign in

Paste the token into Token and choose Sign in. KubeStacks asks the cluster whose token it is, and opens the cluster’s overview. You see what the view role allows: most objects, but not Secrets, and nothing you can change.
The KubeStacks sign-in page, with a field to paste a token, a Sign in button, and the kubectl command that creates a service account's token.The KubeStacks sign-in page, with a field to paste a token, a Sign in button, and the kubectl command that creates a service account's token.

Signing in with a token.

For people to make changes, bind them a role that allows them, like edit, or admin in their own namespaces. KubeStacks asks the cluster what each person may do, and turns off what they can’t, saying why. See Permissions.

Keep your settings in a values file

For anything past a first try, keep the chart’s settings in a file, and install or upgrade from it. Every setting is in Helm values.
The chart’s version is the app’s, so --version 1.2.0 installs KubeStacks 1.2.0. Without it, Helm installs the latest.

Check that it’s running

KubeStacks writes a line to its log when it starts, saying which cluster it shows, where, and how people sign in:
After that, the log records who signs in and out, and what failed. A setting that doesn’t make sense stops KubeStacks before it starts, and the log says which one and why, like:
The chart checks the same things where it can, so helm install fails first with the same advice.

Verify the image

Each release of the image is signed with a build provenance attestation. With the GitHub CLI:

Next steps

Give it an address

An ingress with TLS, at its own host or below a path.

Choose how people sign in

Tokens, single sign-on, or an authenticating proxy.