github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-20 18:31:15 +00:00
Code Issues Projects Releases Wiki Activity

enable docs and man page autogeneration for cloud-controller-manager

Browse Source
This commit is contained in:
wlan0 2017-06-22 16:11:10 -07:00
parent 886e04f1ff
commit 38b060c4fd
8 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
cmd/genkubedocs/BUILD
View File

@ -19,6 +19,7 @@ go_library(
srcs = ["gen_kube_docs.go"], srcs = ["gen_kube_docs.go"],
tags = ["automanaged"], tags = ["automanaged"],
deps = [ deps = [
"//cmd/cloud-controller-manager/app:go_default_library",
"//cmd/genutils:go_default_library", "//cmd/genutils:go_default_library",
"//cmd/kube-apiserver/app:go_default_library", "//cmd/kube-apiserver/app:go_default_library",
"//cmd/kube-controller-manager/app:go_default_library", "//cmd/kube-controller-manager/app:go_default_library",

5
cmd/genkubedocs/gen_kube_docs.go
View File

@ -21,6 +21,7 @@ import (
"os" "os"
"github.com/spf13/cobra/doc" "github.com/spf13/cobra/doc"
ccmapp "k8s.io/kubernetes/cmd/cloud-controller-manager/app"
"k8s.io/kubernetes/cmd/genutils" "k8s.io/kubernetes/cmd/genutils"
apiservapp "k8s.io/kubernetes/cmd/kube-apiserver/app" apiservapp "k8s.io/kubernetes/cmd/kube-apiserver/app"
cmapp "k8s.io/kubernetes/cmd/kube-controller-manager/app" cmapp "k8s.io/kubernetes/cmd/kube-controller-manager/app"
@ -56,6 +57,10 @@ func main() {
// generate docs for kube-controller-manager // generate docs for kube-controller-manager
controllermanager := cmapp.NewControllerManagerCommand() controllermanager := cmapp.NewControllerManagerCommand()
doc.GenMarkdownTree(controllermanager, outDir) doc.GenMarkdownTree(controllermanager, outDir)
case "cloud-controller-manager":
// generate docs for cloud-controller-manager
cloudcontrollermanager := ccmapp.NewCloudControllerManagerCommand()
doc.GenMarkdownTree(cloudcontrollermanager, outDir)
case "kube-proxy": case "kube-proxy":
// generate docs for kube-proxy // generate docs for kube-proxy
proxy := proxyapp.NewProxyCommand() proxy := proxyapp.NewProxyCommand()

1
cmd/genman/BUILD
View File

@ -19,6 +19,7 @@ go_library(
srcs = ["gen_kube_man.go"], srcs = ["gen_kube_man.go"],
tags = ["automanaged"], tags = ["automanaged"],
deps = [ deps = [
"//cmd/cloud-controller-manager/app:go_default_library",
"//cmd/genutils:go_default_library", "//cmd/genutils:go_default_library",
"//cmd/kube-apiserver/app:go_default_library", "//cmd/kube-apiserver/app:go_default_library",
"//cmd/kube-controller-manager/app:go_default_library", "//cmd/kube-controller-manager/app:go_default_library",

8
cmd/genman/gen_kube_man.go
View File

@ -26,6 +26,7 @@ import (
mangen "github.com/cpuguy83/go-md2man/md2man" mangen "github.com/cpuguy83/go-md2man/md2man"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/pflag" "github.com/spf13/pflag"
ccmapp "k8s.io/kubernetes/cmd/cloud-controller-manager/app"
"k8s.io/kubernetes/cmd/genutils" "k8s.io/kubernetes/cmd/genutils"
apiservapp "k8s.io/kubernetes/cmd/kube-apiserver/app" apiservapp "k8s.io/kubernetes/cmd/kube-apiserver/app"
cmapp "k8s.io/kubernetes/cmd/kube-controller-manager/app" cmapp "k8s.io/kubernetes/cmd/kube-controller-manager/app"
@ -73,6 +74,13 @@ func main() {
for _, c := range controllermanager.Commands() { for _, c := range controllermanager.Commands() {
genMarkdown(c, "kube-controller-manager", outDir) 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": case "kube-proxy":
// generate manpage for kube-proxy // generate manpage for kube-proxy
proxy := proxyapp.NewProxyCommand() proxy := proxyapp.NewProxyCommand()

2
docs/.generated_docs
View File

@ -1,4 +1,5 @@
docs/.generated_docs docs/.generated_docs
docs/admin/cloud-controller-manager.md
docs/admin/federation-apiserver.md docs/admin/federation-apiserver.md
docs/admin/federation-controller-manager.md docs/admin/federation-controller-manager.md
docs/admin/kube-apiserver.md docs/admin/kube-apiserver.md
@ -6,6 +7,7 @@ docs/admin/kube-controller-manager.md
docs/admin/kube-proxy.md docs/admin/kube-proxy.md
docs/admin/kube-scheduler.md docs/admin/kube-scheduler.md
docs/admin/kubelet.md docs/admin/kubelet.md
docs/man/man1/cloud-controller-manager.1
docs/man/man1/kube-apiserver.1 docs/man/man1/kube-apiserver.1
docs/man/man1/kube-controller-manager.1 docs/man/man1/kube-controller-manager.1
docs/man/man1/kube-proxy.1 docs/man/man1/kube-proxy.1

3
docs/admin/cloud-controller-manager.md Normal file
View File

@ -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.

3
docs/man/man1/cloud-controller-manager.1 Normal file
View File

@ -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.

2
hack/lib/util.sh
View File

@ -205,6 +205,7 @@ kube::util::gen-docs() {
mkdir -p "${dest}/docs/admin/" mkdir -p "${dest}/docs/admin/"
"${genkubedocs}" "${dest}/docs/admin/" "kube-apiserver" "${genkubedocs}" "${dest}/docs/admin/" "kube-apiserver"
"${genkubedocs}" "${dest}/docs/admin/" "kube-controller-manager" "${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-proxy"
"${genkubedocs}" "${dest}/docs/admin/" "kube-scheduler" "${genkubedocs}" "${dest}/docs/admin/" "kube-scheduler"
"${genkubedocs}" "${dest}/docs/admin/" "kubelet" "${genkubedocs}" "${dest}/docs/admin/" "kubelet"
@ -218,6 +219,7 @@ kube::util::gen-docs() {
mkdir -p "${dest}/docs/man/man1/" mkdir -p "${dest}/docs/man/man1/"
"${genman}" "${dest}/docs/man/man1/" "kube-apiserver" "${genman}" "${dest}/docs/man/man1/" "kube-apiserver"
"${genman}" "${dest}/docs/man/man1/" "kube-controller-manager" "${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-proxy"
"${genman}" "${dest}/docs/man/man1/" "kube-scheduler" "${genman}" "${dest}/docs/man/man1/" "kube-scheduler"
"${genman}" "${dest}/docs/man/man1/" "kubelet" "${genman}" "${dest}/docs/man/man1/" "kubelet"