Reference Documentation

Design docs, concept definitions, and references for APIs and CLIs.

Edit This Page


This guide explains how we can manage multiple kubernetes clusters using federation. Federation proposal details the use cases motivating cluster federation.


To be able to federate multiple clusters, we first need to setup a federation control plane. Follow the setup guide to setup the federation control plane.

Hybrid cloud capabilities

Federations of Kubernetes Clusters can include clusters running in different cloud providers (e.g. Google Cloud, AWS), and on-premises (e.g. on OpenStack). Simply create all of the clusters that you require, in the appropriate cloud providers and/or locations, and register each cluster’s API endpoint and credentials with your Federation API Server (See the federation admin guide for details).

Thereafter, your API resources can span different clusters and cloud providers.

API resources

Once we have the control plane setup, we can start creating federation API resources. The following guides explain some of the resources in detail:

API reference docs lists all the resources supported by federation apiserver.

Analytics Create an Issue Edit this Page