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
6047787f
Commit
6047787f
authored
Sep 22, 2016
by
Manjunath A Kumatagi
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add support for generating all the manpages to genman
parent
5af04d1d
Hide whitespace changes
Inline
Side-by-side
Showing
8 changed files
with
88 additions
and
12 deletions
+88
-12
.generated_docs
.generated_docs
+5
-0
gen_kube_man.go
cmd/genman/gen_kube_man.go
+61
-11
kube-apiserver.1
docs/man/man1/kube-apiserver.1
+3
-0
kube-controller-manager.1
docs/man/man1/kube-controller-manager.1
+3
-0
kube-proxy.1
docs/man/man1/kube-proxy.1
+3
-0
kube-scheduler.1
docs/man/man1/kube-scheduler.1
+3
-0
kubelet.1
docs/man/man1/kubelet.1
+3
-0
util.sh
hack/lib/util.sh
+7
-1
No files found.
.generated_docs
View file @
6047787f
...
@@ -6,6 +6,10 @@ docs/admin/kube-controller-manager.md
...
@@ -6,6 +6,10 @@ 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/kube-apiserver.1
docs/man/man1/kube-controller-manager.1
docs/man/man1/kube-proxy.1
docs/man/man1/kube-scheduler.1
docs/man/man1/kubectl-annotate.1
docs/man/man1/kubectl-annotate.1
docs/man/man1/kubectl-api-versions.1
docs/man/man1/kubectl-api-versions.1
docs/man/man1/kubectl-apply.1
docs/man/man1/kubectl-apply.1
...
@@ -78,6 +82,7 @@ docs/man/man1/kubectl-top.1
...
@@ -78,6 +82,7 @@ docs/man/man1/kubectl-top.1
docs/man/man1/kubectl-uncordon.1
docs/man/man1/kubectl-uncordon.1
docs/man/man1/kubectl-version.1
docs/man/man1/kubectl-version.1
docs/man/man1/kubectl.1
docs/man/man1/kubectl.1
docs/man/man1/kubelet.1
docs/user-guide/kubectl/kubectl.md
docs/user-guide/kubectl/kubectl.md
docs/user-guide/kubectl/kubectl_annotate.md
docs/user-guide/kubectl/kubectl_annotate.md
docs/user-guide/kubectl/kubectl_api-versions.md
docs/user-guide/kubectl/kubectl_api-versions.md
...
...
cmd/genman/gen_kube
ctl
_man.go
→
cmd/genman/gen_kube_man.go
View file @
6047787f
...
@@ -27,17 +27,24 @@ import (
...
@@ -27,17 +27,24 @@ import (
"github.com/spf13/cobra"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"github.com/spf13/pflag"
"k8s.io/kubernetes/cmd/genutils"
"k8s.io/kubernetes/cmd/genutils"
"k8s.io/kubernetes/pkg/kubectl/cmd"
apiservapp
"k8s.io/kubernetes/cmd/kube-apiserver/app"
cmdutil
"k8s.io/kubernetes/pkg/kubectl/cmd/util"
cmapp
"k8s.io/kubernetes/cmd/kube-controller-manager/app"
proxyapp
"k8s.io/kubernetes/cmd/kube-proxy/app"
kubeletapp
"k8s.io/kubernetes/cmd/kubelet/app"
kubectlcmd
"k8s.io/kubernetes/pkg/kubectl/cmd"
kubectlcmdutil
"k8s.io/kubernetes/pkg/kubectl/cmd/util"
schapp
"k8s.io/kubernetes/plugin/cmd/kube-scheduler/app"
)
)
func
main
()
{
func
main
()
{
// use os.Args instead of "flags" because "flags" will mess up the man pages!
// use os.Args instead of "flags" because "flags" will mess up the man pages!
path
:=
"docs/man/man1"
path
:=
"docs/man/man1"
if
len
(
os
.
Args
)
==
2
{
module
:=
""
if
len
(
os
.
Args
)
==
3
{
path
=
os
.
Args
[
1
]
path
=
os
.
Args
[
1
]
}
else
if
len
(
os
.
Args
)
>
2
{
module
=
os
.
Args
[
2
]
fmt
.
Fprintf
(
os
.
Stderr
,
"usage: %s [output directory]
\n
"
,
os
.
Args
[
0
])
}
else
{
fmt
.
Fprintf
(
os
.
Stderr
,
"usage: %s [output directory] [module]
\n
"
,
os
.
Args
[
0
])
os
.
Exit
(
1
)
os
.
Exit
(
1
)
}
}
...
@@ -47,14 +54,57 @@ func main() {
...
@@ -47,14 +54,57 @@ func main() {
os
.
Exit
(
1
)
os
.
Exit
(
1
)
}
}
// Set environment variables used by
kubectl
so the output is consistent,
// Set environment variables used by
command
so the output is consistent,
// regardless of where we run.
// regardless of where we run.
os
.
Setenv
(
"HOME"
,
"/home/username"
)
os
.
Setenv
(
"HOME"
,
"/home/username"
)
// TODO os.Stdin should really be something like ioutil.Discard, but a Reader
kubectl
:=
cmd
.
NewKubectlCommand
(
cmdutil
.
NewFactory
(
nil
),
os
.
Stdin
,
ioutil
.
Discard
,
ioutil
.
Discard
)
switch
module
{
genMarkdown
(
kubectl
,
""
,
outDir
)
case
"kube-apiserver"
:
for
_
,
c
:=
range
kubectl
.
Commands
()
{
// generate manpage for kube-apiserver
genMarkdown
(
c
,
"kubectl"
,
outDir
)
apiserver
:=
apiservapp
.
NewAPIServerCommand
()
genMarkdown
(
apiserver
,
""
,
outDir
)
for
_
,
c
:=
range
apiserver
.
Commands
()
{
genMarkdown
(
c
,
"kube-apiserver"
,
outDir
)
}
case
"kube-controller-manager"
:
// generate manpage for kube-controller-manager
controllermanager
:=
cmapp
.
NewControllerManagerCommand
()
genMarkdown
(
controllermanager
,
""
,
outDir
)
for
_
,
c
:=
range
controllermanager
.
Commands
()
{
genMarkdown
(
c
,
"kube-controller-manager"
,
outDir
)
}
case
"kube-proxy"
:
// generate manpage for kube-proxy
proxy
:=
proxyapp
.
NewProxyCommand
()
genMarkdown
(
proxy
,
""
,
outDir
)
for
_
,
c
:=
range
proxy
.
Commands
()
{
genMarkdown
(
c
,
"kube-proxy"
,
outDir
)
}
case
"kube-scheduler"
:
// generate manpage for kube-scheduler
scheduler
:=
schapp
.
NewSchedulerCommand
()
genMarkdown
(
scheduler
,
""
,
outDir
)
for
_
,
c
:=
range
scheduler
.
Commands
()
{
genMarkdown
(
c
,
"kube-scheduler"
,
outDir
)
}
case
"kubelet"
:
// generate manpage for kubelet
kubelet
:=
kubeletapp
.
NewKubeletCommand
()
genMarkdown
(
kubelet
,
""
,
outDir
)
for
_
,
c
:=
range
kubelet
.
Commands
()
{
genMarkdown
(
c
,
"kubelet"
,
outDir
)
}
case
"kubectl"
:
// generate manpage for kubectl
// TODO os.Stdin should really be something like ioutil.Discard, but a Reader
kubectl
:=
kubectlcmd
.
NewKubectlCommand
(
kubectlcmdutil
.
NewFactory
(
nil
),
os
.
Stdin
,
ioutil
.
Discard
,
ioutil
.
Discard
)
genMarkdown
(
kubectl
,
""
,
outDir
)
for
_
,
c
:=
range
kubectl
.
Commands
()
{
genMarkdown
(
c
,
"kubectl"
,
outDir
)
}
default
:
fmt
.
Fprintf
(
os
.
Stderr
,
"Module %s is not supported"
,
module
)
os
.
Exit
(
1
)
}
}
}
}
...
...
docs/man/man1/kube-apiserver.1
0 → 100644
View file @
6047787f
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/kube-controller-manager.1
0 → 100644
View file @
6047787f
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/kube-proxy.1
0 → 100644
View file @
6047787f
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/kube-scheduler.1
0 → 100644
View file @
6047787f
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/kubelet.1
0 → 100644
View file @
6047787f
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 @
6047787f
...
@@ -205,7 +205,13 @@ kube::util::gen-docs() {
...
@@ -205,7 +205,13 @@ kube::util::gen-docs() {
"
${
genfeddocs
}
"
"
${
dest
}
/docs/admin/"
"federation-controller-manager"
"
${
genfeddocs
}
"
"
${
dest
}
/docs/admin/"
"federation-controller-manager"
mkdir
-p
"
${
dest
}
/docs/man/man1/"
mkdir
-p
"
${
dest
}
/docs/man/man1/"
"
${
genman
}
"
"
${
dest
}
/docs/man/man1/"
"
${
genman
}
"
"
${
dest
}
/docs/man/man1/"
"kube-apiserver"
"
${
genman
}
"
"
${
dest
}
/docs/man/man1/"
"kube-controller-manager"
"
${
genman
}
"
"
${
dest
}
/docs/man/man1/"
"kube-proxy"
"
${
genman
}
"
"
${
dest
}
/docs/man/man1/"
"kube-scheduler"
"
${
genman
}
"
"
${
dest
}
/docs/man/man1/"
"kubelet"
"
${
genman
}
"
"
${
dest
}
/docs/man/man1/"
"kubectl"
mkdir
-p
"
${
dest
}
/docs/yaml/kubectl/"
mkdir
-p
"
${
dest
}
/docs/yaml/kubectl/"
"
${
genyaml
}
"
"
${
dest
}
/docs/yaml/kubectl/"
"
${
genyaml
}
"
"
${
dest
}
/docs/yaml/kubectl/"
...
...
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