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.
With single sign-on or an authenticating proxy, and for a fleet that includes this cluster, a member or an agent, the chart also makes a ClusterRole that lets Lumovi’s service account impersonate users and groups, and a ClusterRoleBinding that gives it that role. Kubernetes lets you create them only if your account may create cluster roles and their bindings, and may impersonate users and groups itself, or has the escalate and bind verbs on cluster roles. A cluster administrator has all of these. See Impersonation.

Try it in five minutes

1

Install the chart

This creates a deployment with one Lumovi pod, a lumovi Service on port 80, a service account, and a 2 GiB volume for the audit log, from the cluster’s default storage class. A cluster without a default storage class needs --set audit.persistence.storageClass=<class>, or --set audit.persistence.enabled=false. With the default sign-in (tokens), that service account needs nothing in the cluster: the chart gives it only get and patch on Lumovi’s own Secret and ConfigMap, where it keeps sessions and people’s rules for their assistants.The history on that volume is one Lumovi’s at a time, so the chart runs one pod, and an upgrade stops the old one before it starts the new one. See Where it’s kept.
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. Lumovi 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 Lumovi 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 Lumovi 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. Lumovi 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. Artifact Hub has them too, for each version, with the chart’s signature and the image it runs.
The chart’s version is the app’s, so --version 1.23.2 installs Lumovi 1.23.2. Without it, Helm installs the latest.

A fleet, a member or an agent

The same chart installs each part of a fleet, one Lumovi for many clusters. mode says which this release is: A member or an agent runs no Lumovi in its cluster, and nobody opens it there. A fleet needs single sign-on or a proxy, so the chart refuses fleet values with auth.mode: token.

Check that it’s running

Lumovi writes a line to its log when it starts, saying which cluster it shows, where, and how people sign in:
For a fleet, that line says how many clusters it shows, after a line for each one (Fleet: prod-eu added), like Lumovi 1.23.2 shows a fleet of 3 clusters (hub, prod-eu, staging) at http://localhost:8080/; people sign in with single sign-on. After that, the log records who signs in and out, and what failed. Each audit event is a line of JSON in it too, starting with {"type":"lumovi.audit". A setting that doesn’t make sense stops Lumovi 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’s image and chart are built, attested and signed by Lumovi’s release workflow on GitHub, from main. Check the attestations with the GitHub CLI:
And the signatures with cosign:
The same with ghcr.io/lumovi/charts/lumovi:1.23.2 checks the chart. Each passes only for what Lumovi’s release workflow built and signed. What the image is made of, its bills of materials, and how to check them: see Check a release. To pin the image by digest, and have an admission controller require its signature, see Harden it for production.

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.