Self-hosted
DERequest a demo →
Skip to documentation content
ClusterPilot Docs
Product tour Self-hosted
Start with:EvaluateInstallCreate a clusterOperateRecoverAutomate
Documentation/Home
Enterprise documentation · 61 code-grounded guides

From first install to proven recovery.

A complete path for evaluators, installers, operators, administrators, security teams and integrators—grounded in the reviewed ClusterPilot release code.

What do you want to achieve?

01

Evaluate

Understand product fit, architecture, value and the main workflows.

Build the evaluation →02

Install

Prepare PostgreSQL, artifacts, secrets, trust, time, and use preflight before mutation.

Choose an install path →03

Create a cluster

Connect the supported provider, review the plan, follow the OperationRun and accept the result.

Create the first cluster →04

Operate

Scale, upgrade, replace, diagnose and recover through the durable lifecycle contract.

Run lifecycle work →05

Automate

Use scoped machine authentication, idempotency, the API catalog and stable error codes.

Build an integration →06

Recover

Start from the symptom, collect bounded evidence and follow the documented safe recovery path.

Resolve a problem →

No command hunting

Commands are part of the task, not a separate catalog. Open the page for the outcome you need and follow the commands exactly where the workflow requires them.

01

Choose the task

Start with installation, first cluster, lifecycle, backup, recovery, automation, or validation.

02

Run the shown step

Each command explains when to use it, prerequisites, safety level, placeholders, and execution order.

03

Verify before continuing

The expected result and stop conditions make the next safe action explicit.

74 reviewed command workflowsplaced in context across 20 task pages · no separate command center

The shortest complete path

  1. 01
    Prepare

    Requirements, sizing, network, PostgreSQL, artifacts, secrets, registry and backup.

    Requirements →
  2. 02
    Install

    Run preflight, deploy with Helm or Compose, and verify health/readiness/clock.

    Installation →
  3. 03
    Bootstrap

    Create the named platform administrator and connect one compatible agent.

    First login →
  4. 04
    Create

    Validate Hetzner, review the wizard plan and follow the returned OperationRun.

    First cluster →
  5. 05
    Accept

    Exercise lifecycle, add-on, dashboard, Sonobuoy and complete restore evidence.

    Customer-zero →

Choose an installation path

Existing Kubernetes platform

Helm deployment

For a Kubernetes-operated control plane with external PostgreSQL, durable shared artifacts, Secret references, Ingress, PDB, and multi-replica safety.

  • Single or multiple replicas
  • Existing platform controls
  • Explicit external dependencies
Install with Helm →
Controlled Linux host

Compose deployment

For the release-owned single-node profile with checksum/signature preflight, immutable images, local verification, and a straightforward first evaluation.

  • Single-node profile
  • Release entrypoint
  • Fastest controlled evaluation
Install with Compose →

Documentation library

Evaluate5 guides · Understand the product, value, architecture and main workflows.
Platform overviewWhat ClusterPilot does and how the operating model fits together.→Product tourFollow provider onboarding, infrastructure, Kubernetes Core, add-ons, operations and evidence.→ArchitectureControl plane, persistence, provider adapters, agent boundary and evidence flow.→Enterprise evaluationA bounded proof with measurable platform, security and operations outcomes.→Support matrixDeployment, operating system, Kubernetes, tools, providers and add-ons.→
Install8 guides · Prepare dependencies, deploy safely, bootstrap access and pass readiness.
Installation overviewChoose a deployment profile and prepare the customer environment.→System requirementsCompute, OS, data, storage, registry, trust, time and target-node prerequisites.→Sizing & capacitySingle-node, split and HA-ready resource envelopes and capacity signals.→Network, ports & trustRequired flows, default ports, TLS, allow-lists and firewall validation.→Install with HelmDeploy on Kubernetes with external PostgreSQL and durable artifacts.→Install with ComposeRun the release-owned single-node profile on Linux.→First login & bootstrapCreate the first administrator and establish the identity boundary.→Install the agentPlace, trust, bootstrap, verify and upgrade the lifecycle agent.→
First success5 guides · Connect the first provider and agent, then create and accept a disposable cluster.
Configure a providerSelect by maturity, enter write-only credentials, validate and discover.→Hetzner CloudConfigure the strongest v0.0.5 provider path and its constraints.→Create the first clusterReview prerequisites and plan, then follow the OperationRun.→UI walkthroughFind the main workflows and verify each screen safely.→Customer-zero acceptanceProve install, lifecycle, add-on, Sonobuoy and restore end to end.→
Operate6 guides · Run infrastructure and cluster lifecycle work through durable, diagnosable operations.
OperationRunsPlans, steps, events, logs, artifacts, cancellation, retry and recovery.→Cloud providersMaturity, credential boundaries, discovery, quotas and resilience.→IONOS providerIONOS network, VDC, LAN and VXLAN lifecycle workflow.→Cluster lifecycleCreate, prepare, scale, upgrade, replace, inspect and delete.→Drift & reconcileDesired state, observed state, drift classification and guarded convergence.→Kubernetes operationsCluster inventory, diagnostics, logs and day-to-day operations.→
Services & validation21 guides · Install curated services, add customer packages, open dashboards and prove conformance.
Built-in add-onsCatalog, locks, preflight, installation, health and dependencies.→Argo CDGitOps application delivery add-on.→cert-managerCertificate issuance and renewal add-on.→FluxGitOps controllers and automation add-on.→GatekeeperOPA admission policy add-on.→GrafanaMetrics and dashboard visualization add-on.→HarborPrivate registry, promotion and scanning add-on.→ingress-nginxNGINX ingress controller add-on.→KyvernoKubernetes-native policy add-on.→LokiCluster log aggregation add-on.→OpenSearchSearch, analytics and dashboards add-on.→PrometheusMetrics and alerting add-on.→Rook CephOperator-managed cluster storage add-on.→TraefikTraefik ingress controller add-on.→VeleroKubernetes backup add-on.→Generic HelmValidated operator-supplied Helm add-on.→Generic manifestValidated operator-supplied manifest bundle.→Generic operatorValidated operator-supplied operator bundle.→Custom add-onsHelm, OCI, Git/Kustomize, manifest and upload workflows.→Dashboard accessDirect and brokered access posture, sessions and diagnostics.→Conformance validationSonobuoy modes, admission, execution, evidence and cleanup.→
Administer11 guides · Secure, configure, observe, recover, upgrade and support the platform.
Users, teams & RBACRoles, memberships, sessions and machine identities.→Configuration modelProfiles, secret references, storage, leader election and feature flags.→Helm values referenceSearch every schema-backed chart setting.→Security modelTrust, authentication, authorization, secrets, audit and safe failure.→Registry & air gapDigest locks, Harbor, private CA and disconnected distribution.→Backup & restoreProtect PostgreSQL, artifacts, release metadata and master key.→Upgrade & rollbackPreflight, compatibility, signed rollout, rollback and restore.→Observability & supportHealth, metrics, logs, evidence, correlation and support bundles.→Operator runbooksSymptom-first routing and stop conditions.→TroubleshootingCommon symptoms, stable codes and safe recovery actions.→Support handoffBuild a complete secret-safe escalation case.→
Reference5 guides · Integrate, diagnose and verify the exact release contract.
API & automationHeadless principles, authentication, idempotency and endpoint families.→API endpoint catalogSearch routes, permissions, purpose and mutation posture.→Error code catalogSearch stable codes, meaning and safe next action.→Source build & validationReproduce maintainer and independent validation gates without treating them as customer installation steps.→Upstream referencesAuthoritative Kubernetes, Helm, Sonobuoy, PostgreSQL, Harbor and provider sources.→

Documentation policy

01

Code before aspiration

Runtime behavior, tests, product status, compatibility manifests, and operator runbooks override broad README language.

02

Clear steps

Every guide explains what to do, what to check and where to find the result.

03

Reliable sources

Official Kubernetes, Helm, PostgreSQL, Harbor and provider documentation supports every guide.