federation/

README

Cluster Federation

Kubernetes Cluster Federation enables users to federate multiple Kubernetes clusters. Please see the user guide and the admin guide for more details about setting up and using the Cluster Federation.

Building Kubernetes Cluster Federation

Please see the Kubernetes Development Guide for initial setup. Once you have the development environment setup as explained in that guide, you also need to install jq

Building cluster federation artifacts should be as simple as running:

make build

You can specify the docker registry to tag the image using the KUBE_REGISTRY environment variable. Please make sure that you use the same value in all the subsequent commands.

To push the built docker images to the registry, run:

make push

To initialize the deployment run:

(This pull the installer images)

make init

To deploy the clusters and install the federation components, edit the ${KUBE_ROOT}/_output/federation/config.json file to describe your clusters and run:

make deploy

To turn down the federation components and tear down the clusters run:

make destroy

Ideas for improvement

1. Split the build phase (make recipe) into multiple phases:

   1. init: pull installer images
   2. build-binaries
   3. build-docker
   4. build: build-binary + build-docker
   5. push: to push the built images
   6. genconfig
   7. deploy-clusters
   8. deploy-federation
   9. deploy: deploy-clusters + deploy-federation
   10. destroy-federation
   11. destroy-clusters
   12. destroy: destroy-federation + destroy-clusters
   13. redeploy-federation: just redeploys the federation components.

2. Continue with destroy phase even in the face of errors.

   The bash script sets set -e errexit which causes the script to exit at the very first error. This should be the default mode for deploying components but not for destroying/cleanup.