199338a551
Automatic merge from submit-queue Generating API reference docs for federation apiserver Fixes #30541 Adding a script `update-federation-api-reference-docs.sh` similar to the existing `update-api-reference-docs.sh` for kube-apiserver. Have moved the common parts to `hack/lib/swagger.sh`. The new script will produce API reference docs for federation-apiserver. Next step will be to surface these docs at kubernetes.io. cc @kubernetes/sig-cluster-federation @kubernetes/sig-api-machinery @caesarxuchao
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
-
Split the
buildphase (make recipe) into multiple phases:init: pull installer imagesbuild-binariesbuild-dockerbuild: build-binary + build-dockerpush: to push the built imagesgenconfigdeploy-clustersdeploy-federationdeploy: deploy-clusters + deploy-federationdestroy-federationdestroy-clustersdestroy: destroy-federation + destroy-clustersredeploy-federation: just redeploys the federation components.
-
Continue with
destroyphase even in the face of errors.The bash script sets
set -e errexitwhich causes the script to exit at the very first error. This should be the default mode for deploying components but not for destroying/cleanup.