kubefed

README

Kubernetes Federation v2

This repo contains an in-progress prototype of some of the foundational aspects of V2 of Kubernetes Federation. The prototype builds on the sync controller (a.k.a. push reconciler) from Federation v1 to iterate on the API concepts laid down in the brainstorming doc and further refined in the architecture doc. Access to both documents is available to members of the kubernetes-sig-multicluster google group.

Concepts

The following abstractions support the propagation of a logical federated type:

• Template: defines the representation of the resource common across clusters
• Placement: defines which clusters the resource is intended to appear in
• Override: optionally defines per-cluster field-level variation to apply to the template

These 3 abstractions provide a concise representation of a resource intended to appear in multiple clusters. Since the details encoded by the abstractions are the minimum required for propagation, they are well-suited to serve as the glue between any given propagation mechanism and higher-order behaviors like policy-based placement and dynamic scheduling.

Guides

User Guide

Take a look at our user guide if you are interested in using Federation v2.

Development Guide

Take a look at our development guide if you are interested in contributing.

Code of Conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.