kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add gen-api-docs target to makefile

This commit is contained in:
Justin Santa Barbara 2017-07-19 22:15:24 -04:00
parent b4eaf6b7d3
commit 868c3a2bfb
2 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Makefile
View File

@ -252,6 +252,20 @@ gen-cli-docs: kops # Regenerate CLI docs
KOPS_FEATURE_FLAGS= \
${KOPS} genhelpdocs --out docs/cli
.PHONY: gen-api-docs
gen-api-docs:
# Follow procedure in docs/apireference/README.md
# Install the apiserver-builder commands
go get -u github.com/kubernetes-incubator/apiserver-builder/cmd/...
# Install the reference docs commands (apiserver-builder commands invoke these)
go get -u github.com/kubernetes-incubator/reference-docs/gen-apidocs/...
# Install the code generation commands (apiserver-builder commands invoke these)
go install k8s.io/kubernetes/cmd/libs/go2idl/openapi-gen
# Update the `pkg/openapi/openapi_generated.go`
${GOPATH}/bin/apiserver-boot build generated --generator openapi --copyright hack/boilerplate/boilerplate.go.txt
go install k8s.io/kops/cmd/kops-server
${GOPATH}/bin/apiserver-boot build docs --disable-delegated-auth=false --output-dir docs/apireference --server kops-server
.PHONY: push
# Will always push a linux-based build up to the server
push: crossbuild-nodeup

6
docs/apireference/README.md
View File

@ -8,10 +8,10 @@ Or build the most recent from src using:
```sh
# Install the apiserver-builder commands
go get github.com/kubernetes-incubator/apiserver-builder/cmd/...
go get -u github.com/kubernetes-incubator/apiserver-builder/cmd/...
# Install the referene docs commands (apiserver-builder commands invoke these)
go get github.com/kubernetes-incubator/reference-docs/gen-apidocs/...
# Install the reference docs commands (apiserver-builder commands invoke these)
go get -u github.com/kubernetes-incubator/reference-docs/gen-apidocs/...
# Install the code generation commands (apiserver-builder commands invoke these)
go install k8s.io/kubernetes/cmd/libs/go2idl/openapi-gen