Kubarr
01 / Install

Getting started

Bootstrap Kubarr with the CLI in the application repository. It installs the platform components and sets up initial access. The separate charts repository holds component and application charts; there is no umbrella kubarr Helm chart.

Before you begin

  • A Kubernetes cluster reachable with kubectl. The project's Helm 4.3 target supports Kubernetes 1.34–1.37; check your cluster version and current context.
  • Helm 4 (target 4.3.0), Rust toolchain supporting Rust 1.88+ and Cargo to build the CLI. The CLI uses OCI chart references for platform components.
  • Storage planned for the platform and apps. The CLI offers managed NFS or an external NFS export. Review the charts storage notes before deploying persistent apps; some databases require local/block storage.
  • Permission to create cluster and namespace resources. Check that your kubeconfig points at the intended cluster before running bootstrap.

Build the installer

git clone https://github.com/smokeythebandit/Kubarr.git
cd Kubarr/code/cli
cargo build --locked
./target/debug/kubarr --help
./target/debug/kubarr bootstrap --help

These commands run from the cloned application repository. The CLI may need access to published OCI charts and container images during installation.

Check and bootstrap

kubectl config current-context
kubectl get nodes
helm version
./target/debug/kubarr bootstrap

Run bootstrap in an interactive terminal to open the install wizard. Choose an existing or single-node cluster, storage options and initial admin details. Review the plan before confirming. For non-interactive installs, inspect kubarr bootstrap --help for flags; avoid putting passwords in shared shell history. The installer defaults to the kubarr-system namespace.

Access: Follow the access instructions printed by the installer for your selected cluster and network setup. Do not assume a public endpoint is configured automatically.

After installation

Check workloads and services in the selected namespace:

kubectl get pods,svc -n kubarr-system

Open the dashboard using the installer's access instructions, sign in with the admin account created during bootstrap, and browse the application catalog. Check each app chart's requirements before deploying it, especially persistent storage, network access and credentials.

Need a closer look?

Read how Kubarr works, inspect the CLI source or browse the charts documentation. For problems, use app issues.