gen_kube_docs.go 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. /*
  2. Copyright 2014 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package main
  14. import (
  15. "fmt"
  16. "os"
  17. "github.com/spf13/cobra/doc"
  18. "github.com/spf13/pflag"
  19. ccmapp "k8s.io/kubernetes/cmd/cloud-controller-manager/app"
  20. "k8s.io/kubernetes/cmd/genutils"
  21. apiservapp "k8s.io/kubernetes/cmd/kube-apiserver/app"
  22. cmapp "k8s.io/kubernetes/cmd/kube-controller-manager/app"
  23. proxyapp "k8s.io/kubernetes/cmd/kube-proxy/app"
  24. schapp "k8s.io/kubernetes/cmd/kube-scheduler/app"
  25. kubeadmapp "k8s.io/kubernetes/cmd/kubeadm/app/cmd"
  26. kubeletapp "k8s.io/kubernetes/cmd/kubelet/app"
  27. )
  28. func main() {
  29. // use os.Args instead of "flags" because "flags" will mess up the man pages!
  30. path := ""
  31. module := ""
  32. if len(os.Args) == 3 {
  33. path = os.Args[1]
  34. module = os.Args[2]
  35. } else {
  36. fmt.Fprintf(os.Stderr, "usage: %s [output directory] [module] \n", os.Args[0])
  37. os.Exit(1)
  38. }
  39. outDir, err := genutils.OutDir(path)
  40. if err != nil {
  41. fmt.Fprintf(os.Stderr, "failed to get output directory: %v\n", err)
  42. os.Exit(1)
  43. }
  44. switch module {
  45. case "kube-apiserver":
  46. // generate docs for kube-apiserver
  47. apiserver := apiservapp.NewAPIServerCommand()
  48. doc.GenMarkdownTree(apiserver, outDir)
  49. case "kube-controller-manager":
  50. // generate docs for kube-controller-manager
  51. controllermanager := cmapp.NewControllerManagerCommand()
  52. doc.GenMarkdownTree(controllermanager, outDir)
  53. case "cloud-controller-manager":
  54. // generate docs for cloud-controller-manager
  55. cloudcontrollermanager := ccmapp.NewCloudControllerManagerCommand()
  56. doc.GenMarkdownTree(cloudcontrollermanager, outDir)
  57. case "kube-proxy":
  58. // generate docs for kube-proxy
  59. proxy := proxyapp.NewProxyCommand()
  60. doc.GenMarkdownTree(proxy, outDir)
  61. case "kube-scheduler":
  62. // generate docs for kube-scheduler
  63. scheduler := schapp.NewSchedulerCommand()
  64. doc.GenMarkdownTree(scheduler, outDir)
  65. case "kubelet":
  66. // generate docs for kubelet
  67. kubelet := kubeletapp.NewKubeletCommand()
  68. doc.GenMarkdownTree(kubelet, outDir)
  69. case "kubeadm":
  70. // resets global flags created by kubelet or other commands e.g.
  71. // --azure-container-registry-config from pkg/credentialprovider/azure
  72. // --version pkg/version/verflag
  73. pflag.CommandLine = pflag.NewFlagSet(os.Args[0], pflag.ExitOnError)
  74. // generate docs for kubeadm
  75. kubeadm := kubeadmapp.NewKubeadmCommand(os.Stdin, os.Stdout, os.Stderr)
  76. doc.GenMarkdownTree(kubeadm, outDir)
  77. // cleanup generated code for usage as include in the website
  78. MarkdownPostProcessing(kubeadm, outDir, cleanupForInclude)
  79. default:
  80. fmt.Fprintf(os.Stderr, "Module %s is not supported", module)
  81. os.Exit(1)
  82. }
  83. }