This page shows how to automatically generate reference pages for the Kubernetes Federation API.
You need to have Git installed.
You need to have
Golang version 1.9.1 or later installed,
$GOPATH environment variable must be set.
You need to have Docker installed.
You need to know how to create a pull request to a GitHub repository. Typically, this involves creating a fork of the repository. For more information, see Creating a Documentation Pull Request.
If you don’t already have the Kubernetes federation source code, get it now:
mkdir $GOPATH/src cd $GOPATH/src go get github.com/kubernetes/federation
Determine the base directory of your local
For example, if you followed the preceding step to get the federation source
code, your base directory is
The remaining steps refer to your base directory as
Run the doc generation script:
cd <fed-base> hack/update-federation-api-reference-docs.sh
The script runs the k8s.gcr.io/gen-swagger-docs image to generate this set of reference docs:
The generated files do not get published automatically. They have to be manually copied to the kubernetes/website repository.
These files are published at kubernetes.io/docs/reference:
Was this page helpful?
Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.