Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
K
k3s
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Jacklull
k3s
Commits
a0db2872
Commit
a0db2872
authored
Jun 30, 2017
by
Tim Hockin
Committed by
GitHub
Jun 30, 2017
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #47934 from wlan0/master
enable docs and man page autogeneration for cloud-controller-manager
parents
4b354d48
38b060c4
Hide whitespace changes
Inline
Side-by-side
Showing
8 changed files
with
25 additions
and
0 deletions
+25
-0
BUILD
cmd/genkubedocs/BUILD
+1
-0
gen_kube_docs.go
cmd/genkubedocs/gen_kube_docs.go
+5
-0
BUILD
cmd/genman/BUILD
+1
-0
gen_kube_man.go
cmd/genman/gen_kube_man.go
+8
-0
.generated_docs
docs/.generated_docs
+2
-0
cloud-controller-manager.md
docs/admin/cloud-controller-manager.md
+3
-0
cloud-controller-manager.1
docs/man/man1/cloud-controller-manager.1
+3
-0
util.sh
hack/lib/util.sh
+2
-0
No files found.
cmd/genkubedocs/BUILD
View file @
a0db2872
...
@@ -19,6 +19,7 @@ go_library(
...
@@ -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",
...
...
cmd/genkubedocs/gen_kube_docs.go
View file @
a0db2872
...
@@ -21,6 +21,7 @@ import (
...
@@ -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() {
...
@@ -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
()
...
...
cmd/genman/BUILD
View file @
a0db2872
...
@@ -19,6 +19,7 @@ go_library(
...
@@ -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",
...
...
cmd/genman/gen_kube_man.go
View file @
a0db2872
...
@@ -26,6 +26,7 @@ import (
...
@@ -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() {
...
@@ -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
()
...
...
docs/.generated_docs
View file @
a0db2872
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
...
@@ -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
...
...
docs/admin/cloud-controller-manager.md
0 → 100644
View file @
a0db2872
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.
docs/man/man1/cloud-controller-manager.1
0 → 100644
View file @
a0db2872
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.
hack/lib/util.sh
View file @
a0db2872
...
@@ -205,6 +205,7 @@ kube::util::gen-docs() {
...
@@ -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() {
...
@@ -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"
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment