k3s/federation
Kubernetes Submit Queue e4909db6a3 Merge pull request #32144 from nikhiljindal/freshDebugNs
Automatic merge from submit-queue

Updating federation api ref docs

Updating API ref docs to include changes from https://github.com/kubernetes/kubernetes/pull/31925.

PR generated by running `hack/update-federation-api-reference-docs.sh`

cc @kubernetes/sig-cluster-federation
2016-09-08 15:54:20 -07:00
..
apis Updated federation swagger spec 2016-09-02 15:30:33 -07:00
client run client-gen 2016-08-26 10:55:22 -07:00
cluster Limit sourcing the build scripts only for build/push phase of federation control plane components. 2016-08-25 14:29:55 -07:00
cmd refactor genericapiserver new to combine initialization 2016-09-08 08:57:10 -04:00
deploy Addressed review comments. 2016-08-25 14:34:19 -07:00
develop Separate federation build.sh into development and deployment scripts. 2016-08-25 12:37:50 -07:00
docs/api-reference Updating api ref docs 2016-09-06 11:39:14 -07:00
manifests [Federation] Do not build separate binaries for federation control plane components, hyperkube should be sufficient. 2016-08-25 14:29:32 -07:00
pkg Merge pull request #32282 from mwielgus/register-on-fake-fix 2016-09-08 06:59:48 -07:00
registry/cluster Merge pull request #31390 from hongchaodeng/fix 2016-08-25 16:44:10 -07:00
Makefile Implement a build and deploy script to turn up/down federation. 2016-08-10 23:24:38 -07:00
OWNERS Add colhom to federation OWNERS 2016-06-27 13:16:43 -07:00
README.md Update README. 2016-08-29 10:49:20 -07:00

README.md

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.

Analytics