gen_kube_docs.go

Documentation: k8s.io/kubernetes/cmd/genkubedocs

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