2016-09-14 01:33:09 +00:00
|
|
|
---
|
2016-12-15 20:16:54 +00:00
|
|
|
title: Federation User Guide
|
2016-09-14 01:33:09 +00:00
|
|
|
---
|
|
|
|
|
|
2016-12-28 09:48:46 +00:00
|
|
|
This guide explains how we can manage multiple Kubernetes clusters using
|
2016-09-14 01:33:09 +00:00
|
|
|
federation.
|
|
|
|
|
[Federation proposal](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/federation.md)
|
|
|
|
|
details the use cases motivating cluster federation.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* TOC
|
|
|
|
|
{:toc}
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
|
|
|
|
To be able to federate multiple clusters, we first need to setup a federation
|
|
|
|
|
control plane.
|
|
|
|
|
Follow the [setup guide](/docs/admin/federation/) 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](/docs/admin/federation/) 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.
|
2016-09-23 00:39:44 +00:00
|
|
|
The following guides explain some of the resources in detail:
|
2016-09-14 01:33:09 +00:00
|
|
|
|
|
|
|
|
* [Events](/docs/user-guide/federation/events/)
|
2016-09-26 18:17:19 +00:00
|
|
|
* [Ingress](/docs/user-guide/federation/federated-ingress/)
|
2016-09-14 01:33:09 +00:00
|
|
|
* [Namespaces](/docs/user-guide/federation/namespaces/)
|
2016-09-23 00:39:44 +00:00
|
|
|
* [ReplicaSets](/docs/user-guide/federation/replicasets/)
|
|
|
|
|
* [Secrets](/docs/user-guide/federation/secrets/)
|
|
|
|
|
* [Services](/docs/user-guide/federation/federated-services/)
|
2016-09-14 01:33:09 +00:00
|
|
|
<!-- TODO: Add more guides here -->
|
|
|
|
|
|
|
|
|
|
[API reference docs](/federation/docs/api-reference/readme/) lists all the
|
|
|
|
|
resources supported by federation apiserver.
|
2016-11-24 08:35:31 +00:00
|
|
|
|
|
|
|
|
## Cascading deletion
|
|
|
|
|
|
|
|
|
|
Kubernetes version 1.5 includes support for cascading deletion of federated
|
|
|
|
|
resources. With cascading deletion, when you delete a resource from the
|
|
|
|
|
federation control plane, the corresponding resources in all underlying clusters
|
|
|
|
|
are also deleted.
|
|
|
|
|
|
|
|
|
|
To enable cascading deletion, set the option
|
|
|
|
|
`DeleteOptions.orphanDependents=false` when you delete a resource from the
|
|
|
|
|
federation control plane.
|
|
|
|
|
|
|
|
|
|
The following Federated resources are affected by cascading deletion:
|
|
|
|
|
|
|
|
|
|
* Ingress
|
|
|
|
|
* Namespace
|
|
|
|
|
* ReplicaSet
|
|
|
|
|
* Secret
|
|
|
|
|
* Deployment
|
|
|
|
|
* DaemonSet
|
|
|
|
|
|
|
|
|
|
Note: By default, deleting a resource from federation control plane does not
|
|
|
|
|
delete the corresponding resources from underlying clusters.
|
