Skip to main content
Before you run a command from someone else on your server, you want to know what it does. In short: it turns your server into a worker in a small Kubernetes cluster that Akua manages for you, so Akua can install the app you chose and keep it running. Your server stays yours, and you pay your server provider directly.

What the join command installs

The command checks that it runs as root on a Linux server, then installs:
  • The Kubernetes worker (k0s). It downloads the k0s installer from get.k0s.sh, installs the version your Cluster needs and starts it as the k0sworker system service. Its files live in /etc/k0s and /var/lib/k0s.
  • An image credential provider. It lets the worker download the app’s container images from Akua’s registry. Its files live in /var/lib/akua/credential-provider and /etc/akua/credential-provider.yaml.
The command refuses to run on a server that already runs k0s or already joined another Cluster. It never prints its one-time credential.

What runs after your server joins

Once your server is ready, Kubernetes runs these on it:
  • The app you installed, in containers, with its data on your server’s disk.
  • Akua’s baseline for your Cluster: a tunnel connector and a private ingress gateway that make the app reachable at its akua.run address, local-path storage for the app’s data, and a metrics server.
  • Kubernetes system components, such as cluster networking.

Who controls what

Your server provider and anyone with root access to the server also keep full control of it. The app itself is software written by the person who sent you the link, so it can do on your server what its code and its settings allow.

What your server connects to

Akua needs no inbound access to your server, and the app needs no public web ports: visitors reach it through the tunnel connector, which opens an outbound connection to Akua. Your server’s connections all start from the server. They include:
  • Akua’s edge, through the tunnel connector, which uses QUIC over UDP by default. The app’s web address works only while this connection is open.
  • Akua’s API and your Cluster’s control plane, on akua.run and akua.dev addresses.
  • get.k0s.sh and the k0s download it points to, when the command installs k0s.
  • Container registries that host the images Kubernetes and the app need, such as Akua’s registry, registry.k8s.io, quay.io and docker.io.

Remove everything

  1. Delete the app. Akua removes its workloads from your server.
  2. In the dashboard, open your Cluster and remove your server, or delete the Cluster. Akua stops using the server; the server itself keeps running.
  3. The k0s worker stays installed on the server. To clean the server completely, reinstall its operating system or delete it at your provider.

Server requirements

What your server needs before you run the command.

Install an app you received

From the link to the running app.