Skip to content

embik/multicluster-runtime

 
 

Go Report Card godoc

Warning

multicluster-runtime is an experiment to add multi-cluster support on-top of controller-runtime. It is not generally consumable yet. Use at your own risk. Contributions though are highly welcome.

Related controller-runtime design: kubernetes-sigs/controller-runtime#2746

multicluster-runtime

Multi cluster controllers with controller-runtime

  • no fork, no go mod replace: clean extension to upstream controller-runtime.
  • universal: kind, cluster-api, Gardener (tbd), kcp (WIP), BYO. Cluster providers make the controller-runtime multi-cluster aware.
  • seamless: add multi-cluster support without compromising on single-cluster. Run in either mode without code changes to the reconcilers.

Uniform Reconcilers

Run the same reconciler against many clusters:

  • The reconciler reads from cluster A and writes to cluster A.
  • The reconciler reads from cluster B and writes to cluster B.
  • The reconciler reads from cluster C and writes to cluster C.

This is the most simple case. Many existing reconcilers can easily adapted to work like this without major code changes. The resulting controllers will work in the multi-cluster setting, but also in the classical single-cluster setup, all in the same code base.

multi-cluster topologies uniform

Multi-Cluster-aware Reconcilers

Run reconcilers that listen to some cluster(s) and operate other clusters. multi-cluster topologies multi

Principles

  1. multicluster-runtime is a friendly extension of controller-runtime.
  2. multicluster-runtime loves ❤️ contributions.
  3. multicluster-runtime is following controller-runtime releases.
  4. multicluster-runtime is developed as if it was part of controller-runtime (quality standards, naming, style).
  5. multicluster-runtime could be a testbed for native controller-runtime functionality, eventually becoming superfluous.
  6. multicluster-runtime is provider agnostic, but may contain providers with its own go.mod files and dedicated OWNERS files.

About

Experiment for Multi cluster controllers with controller-runtime

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 91.2%
  • Shell 5.7%
  • Makefile 3.1%