Documentation/Install
Install · v0.0.1

System requirements

Prepare compute, operating systems, data services, storage, trust, time and target hosts before running the installer.

AudienceInstallers · infrastructure ownersReading time14 minutesCommands in contextNo terminal requiredReviewed sourcefcc5871 · 30 July 2026
RC

Exact release scope. This page documents the reviewed v0.0.1 source at fcc5871. Check release status before enabling a gated capability.

Control-plane requirements

DependencyMinimum contractWhy
Linux / Kubernetes platformA supported Compose host or existing Kubernetes platformRuns the API, workers and optional in-cluster agent
PostgreSQLExternal, durable and backed upSystem of record for identity, settings, runs, audit and projections
Artifact storageDurable filesystem or S3-compatibleLogs, command evidence, reports, bundles and integrity metadata
Secrets protection keyBase64-encoded 32-byte key with managed key IDProtects persisted secret material; stored separately from backups
RegistryPublic or private, immutable digest supportAPI, agent, tool, Kubernetes and add-on artifacts
DNS, TLS and timeApproved names, trust chain and synchronized clockAuthentication, agent negotiation, signatures and leases

Cluster node baseline

AreaSupported v0.0.1 baseline
Operating systemsUbuntu 22.04 / 24.04; Debian 11 / 12; RHEL, Rocky or AlmaLinux 8 / 9; CentOS Stream 9
KernelLinux 5.4 or newer
kubeadm hostCompatible glibc Linux, unique hostname/MAC/product_uuid, open required ports
Control-plane nodeAt least 2 CPU and 2 GiB RAM upstream minimum; use workload-appropriate enterprise sizing
Accessroot or approved sudo policy, deterministic SSH host trust, no interactive-only prompts
NetworkFull approved node connectivity, explicit pod/service CIDRs and selected Calico transport

Installer and operator workstation

  • Bash and the release-declared command dependencies are present
  • Helm is available only when using the Helm path; use the release-supported client version
  • Access to the signed release bundle and approved registry/mirror exists
  • No secret is placed in shell history, Git, values files, command-line arguments or support bundles
  • The operator can reach health endpoints and the chosen backup target

Authoritative upstream prerequisites

Kubernetes kubeadm installation prerequisitesHelm installation and binary verification

These sources explain upstream prerequisites. They do not widen ClusterPilot's release-scoped support matrix.