Skip to content

About

Lifecycle of a self-managed Cluster API management cluster: bootstrap via kind, pivot, upgrade, recover

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

selfhostctl

CI Release Go version OpenSSF Scorecard License golangci-lint Conventional Commits

One Go binary for the lifecycle of a self-managed Cluster API management cluster: bootstrap through a kind Bootstrap cluster, pivot, provider upgrade, recovery and status, driven by one declarative config file.

Status: early development. bootstrap brings a Management cluster up through its Bootstrap cluster until it manages itself, and gives Flux its credential. recover brings it back when its machines are gone. upgrade brings its providers to the config's versions and feature gates. The design is the PRD. See the command line and the config.

Scope

  • In scope: the lifecycle of one self-managed management cluster: bootstrap, pivot, provider upgrade, recovery, status.
  • Out of scope: child (workload) clusters. The management cluster's GitOps applies them; they never need selfhostctl.
  • Out of scope: secret stores. The tool reads secrets from its environment and never talks to a vault.

During an outage

When the Management cluster is down, the Child clusters' workloads keep running. A child whose control plane the Management cluster hosts has no API meanwhile. Nothing reconciles the children until the Management cluster is back: recover brings it back from its surviving datastore, then unpauses each child once its API answers (recover).

Support matrix

Each release is built against exactly one Cluster API minor version.

selfhostctl Cluster API
unreleased (main) v1.14 (core v1.14.4; the Bootstrap cluster on k0s v1.36.5)

No release has been published yet.

Releases

Releases are built by GitHub Actions on GitHub-hosted runners: one binary per OS and architecture (Linux and macOS, amd64 and arm64), with checksums.txt and a signed build provenance attestation. Verify a binary with:

gh attestation verify selfhostctl_<version>_<os>_<arch> --repo klconsultancy/selfhostctl

Contributing

See CONTRIBUTING.md. Report security issues as described in SECURITY.md.

License

Apache-2.0

About

Lifecycle of a self-managed Cluster API management cluster: bootstrap via kind, pivot, upgrade, recover

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages