From 38b060c4fd3dbdffb6fe307259cb73559d546586 Mon Sep 17 00:00:00 2001 From: wlan0 Date: Thu, 22 Jun 2017 16:11:10 -0700 Subject: [PATCH] enable docs and man page autogeneration for cloud-controller-manager --- cmd/genkubedocs/BUILD | 1 + cmd/genkubedocs/gen_kube_docs.go | 5 +++++ cmd/genman/BUILD | 1 + cmd/genman/gen_kube_man.go | 8 ++++++++ docs/.generated_docs | 2 ++ docs/admin/cloud-controller-manager.md | 3 +++ docs/man/man1/cloud-controller-manager.1 | 3 +++ hack/lib/util.sh | 2 ++ 8 files changed, 25 insertions(+) create mode 100644 docs/admin/cloud-controller-manager.md create mode 100644 docs/man/man1/cloud-controller-manager.1 diff --git a/cmd/genkubedocs/BUILD b/cmd/genkubedocs/BUILD index a947a1283d9..61f0c4f5133 100644 --- a/cmd/genkubedocs/BUILD +++ b/cmd/genkubedocs/BUILD @@ -19,6 +19,7 @@ go_library( srcs = ["gen_kube_docs.go"], tags = ["automanaged"], deps = [ + "//cmd/cloud-controller-manager/app:go_default_library", "//cmd/genutils:go_default_library", "//cmd/kube-apiserver/app:go_default_library", "//cmd/kube-controller-manager/app:go_default_library", diff --git a/cmd/genkubedocs/gen_kube_docs.go b/cmd/genkubedocs/gen_kube_docs.go index 0cdd763c661..faebb60e83b 100644 --- a/cmd/genkubedocs/gen_kube_docs.go +++ b/cmd/genkubedocs/gen_kube_docs.go @@ -21,6 +21,7 @@ import ( "os" "github.com/spf13/cobra/doc" + ccmapp "k8s.io/kubernetes/cmd/cloud-controller-manager/app" "k8s.io/kubernetes/cmd/genutils" apiservapp "k8s.io/kubernetes/cmd/kube-apiserver/app" cmapp "k8s.io/kubernetes/cmd/kube-controller-manager/app" @@ -56,6 +57,10 @@ func main() { // generate docs for kube-controller-manager controllermanager := cmapp.NewControllerManagerCommand() doc.GenMarkdownTree(controllermanager, outDir) + case "cloud-controller-manager": + // generate docs for cloud-controller-manager + cloudcontrollermanager := ccmapp.NewCloudControllerManagerCommand() + doc.GenMarkdownTree(cloudcontrollermanager, outDir) case "kube-proxy": // generate docs for kube-proxy proxy := proxyapp.NewProxyCommand() diff --git a/cmd/genman/BUILD b/cmd/genman/BUILD index 06dd45cd035..b6e57067d74 100644 --- a/cmd/genman/BUILD +++ b/cmd/genman/BUILD @@ -19,6 +19,7 @@ go_library( srcs = ["gen_kube_man.go"], tags = ["automanaged"], deps = [ + "//cmd/cloud-controller-manager/app:go_default_library", "//cmd/genutils:go_default_library", "//cmd/kube-apiserver/app:go_default_library", "//cmd/kube-controller-manager/app:go_default_library", diff --git a/cmd/genman/gen_kube_man.go b/cmd/genman/gen_kube_man.go index 85361844ffb..f8974951252 100644 --- a/cmd/genman/gen_kube_man.go +++ b/cmd/genman/gen_kube_man.go @@ -26,6 +26,7 @@ import ( mangen "github.com/cpuguy83/go-md2man/md2man" "github.com/spf13/cobra" "github.com/spf13/pflag" + ccmapp "k8s.io/kubernetes/cmd/cloud-controller-manager/app" "k8s.io/kubernetes/cmd/genutils" apiservapp "k8s.io/kubernetes/cmd/kube-apiserver/app" cmapp "k8s.io/kubernetes/cmd/kube-controller-manager/app" @@ -73,6 +74,13 @@ func main() { for _, c := range controllermanager.Commands() { genMarkdown(c, "kube-controller-manager", outDir) } + case "cloud-controller-manager": + //generate manpage for cloud-controller-manager + controllermanager := ccmapp.NewCloudControllerManagerCommand() + genMarkdown(controllermanager, "", outDir) + for _, c := range controllermanager.Commands() { + genMarkdown(c, "cloud-controller-manager", outDir) + } case "kube-proxy": // generate manpage for kube-proxy proxy := proxyapp.NewProxyCommand() diff --git a/docs/.generated_docs b/docs/.generated_docs index fd5cb22a437..75538e38274 100644 --- a/docs/.generated_docs +++ b/docs/.generated_docs @@ -1,4 +1,5 @@ docs/.generated_docs +docs/admin/cloud-controller-manager.md docs/admin/federation-apiserver.md docs/admin/federation-controller-manager.md docs/admin/kube-apiserver.md @@ -6,6 +7,7 @@ docs/admin/kube-controller-manager.md docs/admin/kube-proxy.md docs/admin/kube-scheduler.md docs/admin/kubelet.md +docs/man/man1/cloud-controller-manager.1 docs/man/man1/kube-apiserver.1 docs/man/man1/kube-controller-manager.1 docs/man/man1/kube-proxy.1 diff --git a/docs/admin/cloud-controller-manager.md b/docs/admin/cloud-controller-manager.md new file mode 100644 index 00000000000..b6fd7a0f989 --- /dev/null +++ b/docs/admin/cloud-controller-manager.md @@ -0,0 +1,3 @@ +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/cloud-controller-manager.1 b/docs/man/man1/cloud-controller-manager.1 new file mode 100644 index 00000000000..b6fd7a0f989 --- /dev/null +++ b/docs/man/man1/cloud-controller-manager.1 @@ -0,0 +1,3 @@ +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/hack/lib/util.sh b/hack/lib/util.sh index c32f47c77fc..2c23f14494b 100755 --- a/hack/lib/util.sh +++ b/hack/lib/util.sh @@ -205,6 +205,7 @@ kube::util::gen-docs() { mkdir -p "${dest}/docs/admin/" "${genkubedocs}" "${dest}/docs/admin/" "kube-apiserver" "${genkubedocs}" "${dest}/docs/admin/" "kube-controller-manager" + "${genkubedocs}" "${dest}/docs/admin/" "cloud-controller-manager" "${genkubedocs}" "${dest}/docs/admin/" "kube-proxy" "${genkubedocs}" "${dest}/docs/admin/" "kube-scheduler" "${genkubedocs}" "${dest}/docs/admin/" "kubelet" @@ -218,6 +219,7 @@ kube::util::gen-docs() { mkdir -p "${dest}/docs/man/man1/" "${genman}" "${dest}/docs/man/man1/" "kube-apiserver" "${genman}" "${dest}/docs/man/man1/" "kube-controller-manager" + "${genman}" "${dest}/docs/man/man1/" "cloud-controller-manager" "${genman}" "${dest}/docs/man/man1/" "kube-proxy" "${genman}" "${dest}/docs/man/man1/" "kube-scheduler" "${genman}" "${dest}/docs/man/man1/" "kubelet"