Generating Reference Documentation for Kubernetes Federation API
This page shows how to automatically generate reference pages for the Kubernetes Federation API.
Before you begin
-
You need to have Git installed.
-
You need to have Golang version 1.8 or later installed, and your
$GOPATHenvironment 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.
Running the update-federation-api-docs.sh script
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
kubernetes/federation repository.
For example, if you followed the preceding step to get the federation source
code, you base directory is $GOPATH/src/github.com/kubernetes/federation.
The remaining steps refer to your base directory as <fed-base>.
Run the doc generation script:
cd <fed-base>
hack/update-federation-api-reference-docs.sh
The script runs the gcr.io/google_containers/gen-swagger-docs image to generate this set of reference docs:
- /docs/api-reference/extensions/v1beta1/operations.html
- /docs/api-reference/extensions/v1beta1/definitions.html
- /docs/api-reference/v1/operations.html
- /docs/api-reference/v1/definitions.html
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:
- Federation API v1 Operations
- Federation API v1 Definitions
- Federation API extensions/v1beta1 Operations
- Federation API extensions/v1beta1 Definitions
What’s next
- Generating Reference Documentation for the Kubernetes API
- Generating Reference Documentation for kubectl Commands
- Generating Reference Pages for Kubernetes Components and Tools