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

automatically generate man pages for kubectl

Browse Source 
generate man pages for kubectl using the cobra.Command information.
This will directly create files in (by default) docs/man/man1/ called
kubectl*.1.  Each child verb/cobra command will gets its own man page.
This commit is contained in:
Eric Paris 2015-02-05 22:02:44 -05:00
parent 8e64be1c66
commit 9e9fb9457f
26 changed files with 1615 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

177
cmd/genman/gen_kubectl_man.go Normal file
View File

@ -0,0 +1,177 @@
/*
Copyright 2014 Google Inc. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"bytes"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"github.com/GoogleCloudPlatform/kubernetes/pkg/kubectl/cmd"
"github.com/cpuguy83/go-md2man/mangen"
"github.com/russross/blackfriday"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
func main() {
// use os.Args instead of "flags" because "flags" will mess up the man pages!
docsDir := "docs/man/man1/"
if len(os.Args) == 2 {
docsDir = os.Args[1]
} else if len(os.Args) > 2 {
fmt.Fprintf(os.Stderr, "usage: %s [output directory]\n", os.Args[0])
os.Exit(1)
}
docsDir, err := filepath.Abs(docsDir)
if err != nil {
fmt.Fprintf(os.Stderr, err.Error())
os.Exit(1)
}
stat, err := os.Stat(docsDir)
if err != nil {
fmt.Fprintf(os.Stderr, "output directory %s does not exist\n", docsDir)
os.Exit(1)
}
if !stat.IsDir() {
fmt.Fprintf(os.Stderr, "output directory %s is not a directory\n", docsDir)
os.Exit(1)
}
docsDir = docsDir + "/"
// Set environment variables used by kubectl so the output is consistent,
// regardless of where we run.
os.Setenv("HOME", "/home/username")
kubectl := cmd.NewFactory(nil).NewKubectlCommand(ioutil.Discard)
genMarkdown(kubectl, "", docsDir)
for _, c := range kubectl.Commands() {
genMarkdown(c, "kubectl", docsDir)
}
}
func preamble(out *bytes.Buffer, name, short, long string) {
out.WriteString(`% KUBERNETES(1) kubernetes User Manuals
% Eric Paris
% Jan 2015
# NAME
`)
fmt.Fprintf(out, "%s \\- %s\n\n", name, short)
fmt.Fprintf(out, "# SYNOPSIS\n")
fmt.Fprintf(out, "**%s** [OPTIONS]\n\n", name)
fmt.Fprintf(out, "# DESCRIPTION\n")
fmt.Fprintf(out, "%s\n\n", long)
}
func printFlags(out *bytes.Buffer, flags *pflag.FlagSet) {
flags.VisitAll(func(flag *pflag.Flag) {
format := "**--%s**=%s\n\t%s\n\n"
if flag.Value.Type() == "string" {
// put quotes on the value
format = "**--%s**=%q\n\t%s\n\n"
}
if len(flag.Shorthand) > 0 {
format = "**-%s**, " + format
} else {
format = "%s" + format
}
fmt.Fprintf(out, format, flag.Shorthand, flag.Name, flag.DefValue, flag.Usage)
})
}
func printOptions(out *bytes.Buffer, command *cobra.Command) {
var flags *pflag.FlagSet
if command.HasFlags() {
flags = command.Flags()
} else if !command.HasParent() && command.HasPersistentFlags() {
flags = command.PersistentFlags()
}
if flags == nil {
return
}
fmt.Fprintf(out, "# OPTIONS\n")
printFlags(out, flags)
fmt.Fprintf(out, "\n")
}
func genMarkdown(command *cobra.Command, parent, docsDir string) {
dparent := strings.Replace(parent, " ", "-", -1)
name := command.Name()
dname := name
if len(parent) > 0 {
dname = dparent + "-" + name
name = parent + " " + name
}
out := new(bytes.Buffer)
short := command.Short
long := command.Long
if len(long) == 0 {
long = short
}
preamble(out, name, short, long)
printOptions(out, command)
if len(command.Commands()) > 0 || len(parent) > 0 {
fmt.Fprintf(out, "# SEE ALSO\n")
if len(parent) > 0 {
fmt.Fprintf(out, "**%s(1)**, ", dparent)
}
for _, c := range command.Commands() {
fmt.Fprintf(out, "**%s-%s(1)**, ", dname, c.Name())
genMarkdown(c, name, docsDir)
}
fmt.Fprintf(out, "\n")
}
out.WriteString(`
# HISTORY
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!
`)
renderer := mangen.ManRenderer(0)
extensions := 0
extensions |= blackfriday.EXTENSION_NO_INTRA_EMPHASIS
extensions |= blackfriday.EXTENSION_TABLES
extensions |= blackfriday.EXTENSION_FENCED_CODE
extensions |= blackfriday.EXTENSION_AUTOLINK
extensions |= blackfriday.EXTENSION_SPACE_HEADERS
extensions |= blackfriday.EXTENSION_FOOTNOTES
extensions |= blackfriday.EXTENSION_TITLEBLOCK
final := blackfriday.Markdown(out.Bytes(), renderer, extensions)
filename := docsDir + dname + ".1"
outFile, err := os.Create(filename)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
defer outFile.Close()
_, err = outFile.Write(final)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
}

238
docs/kubectl.md
View File

@ -11,14 +11,12 @@ Usage:
```
kubectl version [flags]
Flags:
-c, --client=false: Client version only (no server required).
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
-c, --client=false: Client version only (no server required).
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
@ -49,14 +47,9 @@ Usage:
```
kubectl proxy [flags]
Flags:
--api-prefix="/api/": Prefix to serve the proxied API under.
-p, --port=8001: The port on which to run the proxy.
-w, --www="": Also serve static files from the given directory under the specified prefix.
-P, --www-prefix="/static/": Prefix to serve static files under, if static file directory is specified.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-prefix="/api/": Prefix to serve the proxied API under.
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
@ -73,6 +66,7 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
-p, --port=8001: The port on which to run the proxy.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
@ -80,6 +74,8 @@ Global Flags:
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
-w, --www="": Also serve static files from the given directory under the specified prefix.
-P, --www-prefix="/static/": Prefix to serve static files under, if static file directory is specified.
```
@ -113,16 +109,7 @@ Usage:
```
kubectl get [(-o|--output=)json|yaml|template|...] <resource> [<id>] [flags]
Flags:
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
-l, --selector="": Selector (label query) to filter on
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
-w, --watch=false: After listing/getting the requested object, watch for changes.
--watch-only=false: Watch for changes to the requested object(s), without listing/getting first.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -140,13 +127,20 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
-l, --selector="": Selector (label query) to filter on
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
-w, --watch=false: After listing/getting the requested object, watch for changes.
--watch-only=false: Watch for changes to the requested object(s), without listing/getting first.
```
@ -160,8 +154,7 @@ Usage:
```
kubectl describe <resource> <id> [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -170,7 +163,6 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-h, --help=false: help for describe
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@ -206,10 +198,7 @@ Usage:
```
kubectl create -f filename [flags]
Flags:
-f, --filename=[]: Filename, directory, or URL to file to use to create the resource
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -218,6 +207,7 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-f, --filename=[]: Filename, directory, or URL to file to use to create the resource
-h, --help=false: help for create
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -257,11 +247,7 @@ Usage:
```
kubectl update -f filename [flags]
Flags:
-f, --filename=[]: Filename, directory, or URL to file to use to update the resource.
--patch="": A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -270,6 +256,7 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-f, --filename=[]: Filename, directory, or URL to file to use to update the resource.
-h, --help=false: help for update
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -279,6 +266,7 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--patch="": A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
@ -319,11 +307,7 @@ Usage:
```
kubectl delete ([-f filename] | (<resource> [(<id> | -l <label>)] [flags]
Flags:
-f, --filename=[]: Filename, directory, or URL to a file containing the resource to delete
-l, --selector="": Selector (label query) to filter on
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -332,6 +316,7 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-f, --filename=[]: Filename, directory, or URL to a file containing the resource to delete
-h, --help=false: help for delete
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -341,6 +326,7 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
-l, --selector="": Selector (label query) to filter on
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
@ -368,8 +354,7 @@ Available Commands:
unset property-name Unsets an individual value in a .kubeconfig file
use-context context-name Sets the current-context in a .kubeconfig file
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -380,7 +365,6 @@ Global Flags:
--context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username
-h, --help=false: help for config
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory
@ -416,7 +400,7 @@ Additional help topics:
kubectl expose Take a replicated application and expose it as Kubernetes Service
kubectl label Update the labels on a resource
Use "kubectl help [command]" for more information about a command.
Use "kubectl help [command]" for more information about that command.
```
#### config view
@ -432,14 +416,7 @@ Usage:
```
kubectl config view [flags]
Flags:
--merge=true: merge together the full hierarchy of .kubeconfig files
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -459,9 +436,14 @@ Global Flags:
--log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--merge=true: merge together the full hierarchy of .kubeconfig files
--namespace="": If present, the namespace scope for this CLI request.
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--v=0: log level for V logs
@ -482,12 +464,11 @@ Usage:
```
kubectl config set-cluster name [--server=server] [--certificate-authority=path/to/certficate/authority] [--api-version=apiversion] [--insecure-skip-tls-verify=true] [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
--api-version=: api-version for the cluster entry in .kubeconfig
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--certificate-authority=: certificate-authority for the cluster entry in .kubeconfig
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
@ -495,7 +476,7 @@ Global Flags:
--envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username
-h, --help=false: help for set-cluster
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--insecure-skip-tls-verify=false: insecure-skip-tls-verify for the cluster entry in .kubeconfig
--kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@ -504,7 +485,7 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
-s, --server="": The address and port of the Kubernetes API server
--server=: server for the cluster entry in .kubeconfig
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
@ -526,14 +507,13 @@ Usage:
```
kubectl config set-credentials name [--auth-path=path/to/auth/file] [--client-certificate=path/to/certficate/file] [--client-key=path/to/key/file] [--token=bearer_token_string] [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--auth-path=: auth-path for the user entry in .kubeconfig
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--client-certificate=: client-certificate for the user entry in .kubeconfig
--client-key=: client-key for the user entry in .kubeconfig
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG
@ -550,7 +530,7 @@ Global Flags:
--namespace="": If present, the namespace scope for this CLI request.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--token=: token for the user entry in .kubeconfig
--user="": The name of the kubeconfig user to use
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
@ -570,15 +550,14 @@ Usage:
```
kubectl config set-context name [--cluster=cluster-nickname] [--user=user-nickname] [--namespace=namespace] [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--cluster=: cluster for the context entry in .kubeconfig
--context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username
@ -591,11 +570,11 @@ Global Flags:
--log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--namespace=: namespace for the context entry in .kubeconfig
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--user=: user for the context entry in .kubeconfig
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
@ -614,8 +593,7 @@ Usage:
```
kubectl config set property-name property-value [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -626,7 +604,7 @@ Global Flags:
--context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username
-h, --help=false: help for set
-h, --help=false: help for config
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory
@ -656,8 +634,7 @@ Usage:
```
kubectl config unset property-name [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -668,7 +645,7 @@ Global Flags:
--context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username
-h, --help=false: help for unset
-h, --help=false: help for config
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory
@ -695,8 +672,7 @@ Usage:
```
kubectl config use-context context-name [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -707,7 +683,7 @@ Global Flags:
--context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username
-h, --help=false: help for use-context
-h, --help=false: help for config
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory
@ -737,8 +713,7 @@ Usage:
```
kubectl namespace [<namespace>] [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -747,7 +722,6 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-h, --help=false: help for namespace
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@ -781,10 +755,7 @@ Usage:
```
kubectl log [-f] <pod> [<container>] [flags]
Flags:
-f, --follow=false: Specify if the logs should be streamed.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -793,6 +764,7 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-f, --follow=false: Specify if the logs should be streamed.
-h, --help=false: help for log
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -831,13 +803,7 @@ Usage:
```
kubectl rollingupdate <old-controller-name> -f <new-controller.json> [flags]
Flags:
-f, --filename="": Filename or URL to file to use to create the new controller.
--poll-interval="3s": Time delay between polling controller status after update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
--timeout="5m0s": Max time to wait for a controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
--update-period="1m0s": Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -846,6 +812,7 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-f, --filename="": Filename or URL to file to use to create the new controller.
-h, --help=false: help for rollingupdate
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -855,9 +822,12 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--poll-interval="3s": Time delay between polling controller status after update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--timeout="5m0s": Max time to wait for a controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
--token="": Bearer token for authentication to the API server.
--update-period="1m0s": Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
--user="": The name of the kubeconfig user to use
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
@ -885,12 +855,7 @@ Usage:
```
kubectl resize [--resource-version=<version>] [--current-replicas=<count>] --replicas=<count> <resource> <id> [flags]
Flags:
--current-replicas=-1: Precondition for current size. Requires that the current size of the replication controller match this value in order to resize.
--replicas=-1: The new desired number of replicas. Required.
--resource-version="": Precondition for resource version. Requires that the current resource version match this value in order to resize.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -899,6 +864,7 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--current-replicas=-1: Precondition for current size. Requires that the current size of the replication controller match this value in order to resize.
-h, --help=false: help for resize
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -908,6 +874,8 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--replicas=-1: The new desired number of replicas. Required.
--resource-version="": Precondition for resource version. Requires that the current resource version match this value in order to resize.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
@ -940,20 +908,7 @@ Usage:
```
kubectl run-container <name> --image=<image> [--port=<port>] [--replicas=replicas] [--dry-run=<bool>] [--overrides=<inline-json>] [flags]
Flags:
--dry-run=false: If true, only print the object that would be sent, without sending it.
--generator="run-container/v1": The name of the API generator to use. Default is 'run-container-controller/v1'.
--image="": The image for the container to run.
-l, --labels="": Labels to apply to the pod(s) created by this call to run-container.
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
--overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
--port=-1: The port that this container exposes.
-r, --replicas=1: Number of replicas to create for this container. Default is 1.
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -962,17 +917,28 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--dry-run=false: If true, only print the object that would be sent, without sending it.
--generator="run-container/v1": The name of the API generator to use. Default is 'run-container-controller/v1'.
-h, --help=false: help for run-container
--image="": The image for the container to run.
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
-l, --labels="": Labels to apply to the pod(s) created by this call to run-container.
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
--log_dir=: If non-empty, write log files in this directory
--log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
--overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
--port=-1: The port that this container exposes.
-r, --replicas=1: Number of replicas to create for this container. Default is 1.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--v=0: log level for V logs
@ -997,8 +963,7 @@ Usage:
```
kubectl stop <resource> <id> [flags]
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -1007,7 +972,6 @@ Global Flags:
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-h, --help=false: help for stop
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@ -1045,23 +1009,7 @@ Usage:
```
kubectl expose <name> --port=<port> [--protocol=TCP|UDP] [--container-port=<number-or-name>] [--service-name=<name>] [--public-ip=<ip>] [--create-external-load-balancer] [flags]
Flags:
--container-port="": Name or number for the port on the container that the service should direct traffic to. Optional.
--create-external-load-balancer=false: If true, create an external load balancer for this service. Implementation is cloud provider dependent. Default is 'false'.
--dry-run=false: If true, only print the object that would be sent, without creating it.
--generator="service/v1": The name of the API generator to use. Default is 'service/v1'.
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
--overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
--port=-1: The port that the service should serve on. Required.
--protocol="TCP": The network protocol for the service to be created. Default is 'tcp'.
--public-ip="": Name of a public IP address to set for the service. The service will be assigned this IP in addition to its generated service IP.
--selector="": A label selector to use for this service. If empty (the default) infer the selector from the replication controller.
--service-name="": The name for the newly created service.
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -1069,7 +1017,11 @@ Global Flags:
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--container-port="": Name or number for the port on the container that the service should direct traffic to. Optional.
--context="": The name of the kubeconfig context to use
--create-external-load-balancer=false: If true, create an external load balancer for this service. Implementation is cloud provider dependent. Default is 'false'.
--dry-run=false: If true, only print the object that would be sent, without creating it.
--generator="service/v1": The name of the API generator to use. Default is 'service/v1'.
-h, --help=false: help for expose
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -1079,8 +1031,18 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
--overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
--port=-1: The port that the service should serve on. Required.
--protocol="TCP": The network protocol for the service to be created. Default is 'tcp'.
--public-ip="": Name of a public IP address to set for the service. The service will be assigned this IP in addition to its generated service IP.
--selector="": A label selector to use for this service. If empty (the default) infer the selector from the replication controller.
-s, --server="": The address and port of the Kubernetes API server
--service-name="": The name for the newly created service.
--stderrthreshold=2: logs at or above this threshold go to stderr
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--v=0: log level for V logs
@ -1112,15 +1074,7 @@ Usage:
```
kubectl label [--overwrite] <resource> <name> <key-1>=<val-1> ... <key-n>=<val-n> [--resource-version=<version>] [flags]
Flags:
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
--overwrite=false: If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels.
--resource-version="": If non-empty, the labels update will only succeed if this is the current resource-version for the object.
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
Global Flags:
Available Flags:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -1138,8 +1092,14 @@ Global Flags:
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--no-headers=false: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile.
--output-version="": Output the formatted object with the given version (default api-version).
--overwrite=false: If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels.
--resource-version="": If non-empty, the labels update will only succeed if this is the current resource-version for the object.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile.
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--v=0: log level for V logs

48
docs/man/man1/kubectl-config-set-cluster.1 Normal file
View File

@ -0,0 +1,48 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config set\-cluster \- Sets a cluster entry in .kubeconfig
.SH SYNOPSIS
.PP
\fBkubectl config set\-cluster\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets a cluster entry in .kubeconfig
Specifying a name that already exists will merge new fields on top of existing values for those fields.
e.g.
kubectl config set\-cluster e2e \-\-certificate\-authority=\~/.kube/e2e/.kubernetes.ca.cert
only sets the certificate\-authority field on the e2e cluster entry without touching other values.
.SH OPTIONS
.PP
\fB\-\-api\-version\fP=""
api\-version for the cluster entry in .kubeconfig
.PP
\fB\-\-certificate\-authority\fP=""
certificate\-authority for the cluster entry in .kubeconfig
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
insecure\-skip\-tls\-verify for the cluster entry in .kubeconfig
.PP
\fB\-\-server\fP=""
server for the cluster entry in .kubeconfig
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

44
docs/man/man1/kubectl-config-set-context.1 Normal file
View File

@ -0,0 +1,44 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config set\-context \- Sets a context entry in .kubeconfig
.SH SYNOPSIS
.PP
\fBkubectl config set\-context\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets a context entry in .kubeconfig
Specifying a name that already exists will merge new fields on top of existing values for those fields.
e.g.
kubectl config set\-context gce \-\-user=cluster\-admin
only sets the user field on the gce context entry without touching other values.
.SH OPTIONS
.PP
\fB\-\-cluster\fP=""
cluster for the context entry in .kubeconfig
.PP
\fB\-\-namespace\fP=""
namespace for the context entry in .kubeconfig
.PP
\fB\-\-user\fP=""
user for the context entry in .kubeconfig
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

48
docs/man/man1/kubectl-config-set-credentials.1 Normal file
View File

@ -0,0 +1,48 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config set\-credentials \- Sets a user entry in .kubeconfig
.SH SYNOPSIS
.PP
\fBkubectl config set\-credentials\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets a user entry in .kubeconfig
Specifying a name that already exists will merge new fields on top of existing values for those fields.
e.g.
kubectl config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/cluster\-admin/.kubecfg.key
only sets the client\-key field on the cluster\-admin user entry without touching other values.
.SH OPTIONS
.PP
\fB\-\-auth\-path\fP=""
auth\-path for the user entry in .kubeconfig
.PP
\fB\-\-client\-certificate\fP=""
client\-certificate for the user entry in .kubeconfig
.PP
\fB\-\-client\-key\fP=""
client\-key for the user entry in .kubeconfig
.PP
\fB\-\-token\fP=""
token for the user entry in .kubeconfig
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

36
docs/man/man1/kubectl-config-set.1 Normal file
View File

@ -0,0 +1,36 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config set \- Sets an individual value in a .kubeconfig file
.SH SYNOPSIS
.PP
\fBkubectl config set\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets an individual value in a .kubeconfig file
.PP
.RS
.nf
property\-name is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots.
property\-value is the new value you wish to set.
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

35
docs/man/man1/kubectl-config-unset.1 Normal file
View File

@ -0,0 +1,35 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config unset \- Unsets an individual value in a .kubeconfig file
.SH SYNOPSIS
.PP
\fBkubectl config unset\fP [OPTIONS]
.SH DESCRIPTION
.PP
Unsets an individual value in a .kubeconfig file
.PP
.RS
.nf
property\-name is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots.
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

26
docs/man/man1/kubectl-config-use-context.1 Normal file
View File

@ -0,0 +1,26 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config use\-context \- Sets the current\-context in a .kubeconfig file
.SH SYNOPSIS
.PP
\fBkubectl config use\-context\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets the current\-context in a .kubeconfig file
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

55
docs/man/man1/kubectl-config-view.1 Normal file
View File

@ -0,0 +1,55 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config view \- displays merged .kubeconfig settings or a specified .kubeconfig file.
.SH SYNOPSIS
.PP
\fBkubectl config view\fP [OPTIONS]
.SH DESCRIPTION
.PP
displays merged .kubeconfig settings or a specified .kubeconfig file.
Examples:
// Show merged .kubeconfig settings.
$ kubectl config view
.PP
// Show only local ./.kubeconfig settings
$ kubectl config view \-\-local
.SH OPTIONS
.PP
\fB\-\-merge\fP=true
merge together the full hierarchy of .kubeconfig files
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile.
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

26
docs/man/man1/kubectl-config.1 Normal file
View File

@ -0,0 +1,26 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config \- config modifies .kubeconfig files
.SH SYNOPSIS
.PP
\fBkubectl config\fP [OPTIONS]
.SH DESCRIPTION
.PP
config modifies .kubeconfig files using subcommands like "kubectl config set current\-context my\-context"
.SH SEE ALSO
.PP
\fBkubectl(1)\fP, \fBkubectl\-config\-view(1)\fP, \fBkubectl\-config\-set\-cluster(1)\fP, \fBkubectl\-config\-set\-credentials(1)\fP, \fBkubectl\-config\-set\-context(1)\fP, \fBkubectl\-config\-set(1)\fP, \fBkubectl\-config\-unset(1)\fP, \fBkubectl\-config\-use\-context(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

51
docs/man/man1/kubectl-create.1 Normal file
View File

@ -0,0 +1,51 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl create \- Create a resource by filename or stdin
.SH SYNOPSIS
.PP
\fBkubectl create\fP [OPTIONS]
.SH DESCRIPTION
.PP
Create a resource by filename or stdin.
.PP
JSON and YAML formats are accepted.
.PP
Examples:
.PP
.RS
.nf
$ kubectl create \-f pod.json
// Create a pod using the data in pod.json.
$ cat pod.json | kubectl create \-f \-
// Create a pod based on the JSON passed into stdin.
.fi
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file to use to create the resource
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

70
docs/man/man1/kubectl-delete.1 Normal file
View File

@ -0,0 +1,70 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl delete \- Delete a resource by filename, stdin, or resource and ID.
.SH SYNOPSIS
.PP
\fBkubectl delete\fP [OPTIONS]
.SH DESCRIPTION
.PP
Delete a resource by filename, stdin, resource and ID, or by resources and label selector.
.PP
JSON and YAML formats are accepted.
.PP
If both a filename and command line arguments are passed, the command line
arguments are used and the filename is ignored.
.PP
Note that the delete command does NOT do resource version checks, so if someone
submits an update to a resource right when you submit a delete, their update
will be lost along with the rest of the resource.
.PP
Examples:
.PP
.RS
.nf
$ kubectl delete \-f pod.json
// Delete a pod using the type and ID specified in pod.json.
$ cat pod.json | kubectl delete \-f \-
// Delete a pod based on the type and ID in the JSON passed into stdin.
$ kubectl delete pods,services \-l name=myLabel
// Delete pods and services with label name=myLabel.
$ kubectl delete pod 1234\-56\-7890\-234234\-456456
// Delete a pod with ID 1234\-56\-7890\-234234\-456456.
.fi
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to a file containing the resource to delete
.PP
\fB\-l\fP, \fB\-\-selector\fP=""
Selector (label query) to filter on
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

30
docs/man/man1/kubectl-describe.1 Normal file
View File

@ -0,0 +1,30 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl describe \- Show details of a specific resource
.SH SYNOPSIS
.PP
\fBkubectl describe\fP [OPTIONS]
.SH DESCRIPTION
.PP
Show details of a specific resource.
.PP
This command joins many API calls together to form a detailed description of a
given resource.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

104
docs/man/man1/kubectl-expose.1 Normal file
View File

@ -0,0 +1,104 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl expose \- Take a replicated application and expose it as Kubernetes Service
.SH SYNOPSIS
.PP
\fBkubectl expose\fP [OPTIONS]
.SH DESCRIPTION
.PP
Take a replicated application and expose it as Kubernetes Service.
.PP
Looks up a ReplicationController by name, and uses the selector for that replication controller
as the selector for a new Service on the specified port.
.PP
Examples:
.PP
.RS
.nf
$ kubectl expose nginx \-\-port=80 \-\-container\-port=8000
// Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
$ kubectl expose streamer \-\-port=4100 \-\-protocol=udp \-\-service\-name=video\-stream
// Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video\-stream'.
.fi
.RE
.SH OPTIONS
.PP
\fB\-\-container\-port\fP=""
Name or number for the port on the container that the service should direct traffic to. Optional.
.PP
\fB\-\-create\-external\-load\-balancer\fP=false
If true, create an external load balancer for this service. Implementation is cloud provider dependent. Default is 'false'.
.PP
\fB\-\-dry\-run\fP=false
If true, only print the object that would be sent, without creating it.
.PP
\fB\-\-generator\fP="service/v1"
The name of the API generator to use. Default is 'service/v1'.
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-\-overrides\fP=""
An inline JSON override for the generated object. If this is non\-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
.PP
\fB\-\-port\fP=\-1
The port that the service should serve on. Required.
.PP
\fB\-\-protocol\fP="TCP"
The network protocol for the service to be created. Default is 'tcp'.
.PP
\fB\-\-public\-ip\fP=""
Name of a public IP address to set for the service. The service will be assigned this IP in addition to its generated service IP.
.PP
\fB\-\-selector\fP=""
A label selector to use for this service. If empty (the default) infer the selector from the replication controller.
.PP
\fB\-\-service\-name\fP=""
The name for the newly created service.
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

89
docs/man/man1/kubectl-get.1 Normal file
View File

@ -0,0 +1,89 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl get \- Display one or many resources
.SH SYNOPSIS
.PP
\fBkubectl get\fP [OPTIONS]
.SH DESCRIPTION
.PP
Display one or many resources.
.PP
Possible resources include pods (po), replication controllers (rc), services
(se), minions (mi), or events (ev).
.PP
By specifying the output as 'template' and providing a Go template as the value
of the \-\-template flag, you can filter the attributes of the fetched resource(s).
.PP
Examples:
.PP
.RS
.nf
$ kubectl get pods
// List all pods in ps output format.
$ kubectl get replicationController 1234\-56\-7890\-234234\-456456
// List a single replication controller with specified ID in ps output format.
$ kubectl get \-o json pod 1234\-56\-7890\-234234\-456456
// List a single pod in JSON output format.
$ kubectl get \-o template pod 1234\-56\-7890\-234234\-456456 \-\-template=\{\{.currentState.status\}\}
// Return only the status value of the specified pod.
$ kubectl get rc,services
// List all replication controllers and services together in ps output format.
.fi
.RE
.SH OPTIONS
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-l\fP, \fB\-\-selector\fP=""
Selector (label query) to filter on
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile.
.PP
\fB\-w\fP, \fB\-\-watch\fP=false
After listing/getting the requested object, watch for changes.
.PP
\fB\-\-watch\-only\fP=false
Watch for changes to the requested object(s), without listing/getting first.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

73
docs/man/man1/kubectl-label.1 Normal file
View File

@ -0,0 +1,73 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl label \- Update the labels on a resource
.SH SYNOPSIS
.PP
\fBkubectl label\fP [OPTIONS]
.SH DESCRIPTION
.PP
Update the labels on a resource.
.PP
If \-\-overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used.
.PP
Examples:
$ kubectl label pods foo unhealthy=true
<update a pod with the label 'unhealthy' and the value 'true'>
.PP
$ kubectl label \-\-overwrite pods foo status=unhealthy
<update a pod with the label 'status' and the value 'unhealthy' overwritting an existing value>
.PP
$ kubectl label pods foo status=unhealthy \-\-resource\-version=1
<update a pod with the label 'status' and the value 'unhealthy' if the resource is unchanged from version 1>
.PP
$ kubectl label pods foo bar\-
<update a pod by removing a label named 'bar' if it exists. Does not require the --overwrite flag.>
.SH OPTIONS
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-\-overwrite\fP=false
If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels.
.PP
\fB\-\-resource\-version\fP=""
If non\-empty, the labels update will only succeed if this is the current resource\-version for the object.
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

48
docs/man/man1/kubectl-log.1 Normal file
View File

@ -0,0 +1,48 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl log \- Print the logs for a container in a pod.
.SH SYNOPSIS
.PP
\fBkubectl log\fP [OPTIONS]
.SH DESCRIPTION
.PP
Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
.PP
Examples:
.PP
.RS
.nf
$ kubectl log 123456\-7890 ruby\-container
// Returns snapshot of ruby\-container logs from pod 123456\-7890.
$ kubectl log \-f 123456\-7890 ruby\-container
// Starts streaming of ruby\-container logs from pod 123456\-7890.
.fi
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-follow\fP=false
Specify if the logs should be streamed.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

29
docs/man/man1/kubectl-namespace.1 Normal file
View File

@ -0,0 +1,29 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl namespace \- SUPERCEDED: Set and view the current Kubernetes namespace
.SH SYNOPSIS
.PP
\fBkubectl namespace\fP [OPTIONS]
.SH DESCRIPTION
.PP
SUPERCEDED: Set and view the current Kubernetes namespace scope for command line requests.
.PP
namespace has been superceded by the context.namespace field of .kubeconfig files. See 'kubectl config set\-context \-\-help' for more details.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

44
docs/man/man1/kubectl-proxy.1 Normal file
View File

@ -0,0 +1,44 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl proxy \- Run a proxy to the Kubernetes API server
.SH SYNOPSIS
.PP
\fBkubectl proxy\fP [OPTIONS]
.SH DESCRIPTION
.PP
Run a proxy to the Kubernetes API server.
.SH OPTIONS
.PP
\fB\-\-api\-prefix\fP="/api/"
Prefix to serve the proxied API under.
.PP
\fB\-p\fP, \fB\-\-port\fP=8001
The port on which to run the proxy.
.PP
\fB\-w\fP, \fB\-\-www\fP=""
Also serve static files from the given directory under the specified prefix.
.PP
\fB\-P\fP, \fB\-\-www\-prefix\fP="/static/"
Prefix to serve static files under, if static file directory is specified.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

62
docs/man/man1/kubectl-resize.1 Normal file
View File

@ -0,0 +1,62 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl resize \- Set a new size for a Replication Controller.
.SH SYNOPSIS
.PP
\fBkubectl resize\fP [OPTIONS]
.SH DESCRIPTION
.PP
Set a new size for a Replication Controller.
.PP
Resize also allows users to specify one or more preconditions for the resize action.
If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the
resize is attempted, and it is guaranteed that the precondition holds true when the
resize is sent to the server.
.PP
Examples:
.PP
.RS
.nf
$ kubectl resize \-\-replicas=3 replicationcontrollers foo
// Resize replication controller named 'foo' to 3.
$ kubectl resize \-\-current\-replicas=2 \-\-replicas=3 replicationcontrollers foo
// If the replication controller named foo's current size is 2, resize foo to 3.
.fi
.RE
.SH OPTIONS
.PP
\fB\-\-current\-replicas\fP=\-1
Precondition for current size. Requires that the current size of the replication controller match this value in order to resize.
.PP
\fB\-\-replicas\fP=\-1
The new desired number of replicas. Required.
.PP
\fB\-\-resource\-version\fP=""
Precondition for resource version. Requires that the current resource version match this value in order to resize.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

65
docs/man/man1/kubectl-rollingupdate.1 Normal file
View File

@ -0,0 +1,65 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl rollingupdate \- Perform a rolling update of the given ReplicationController.
.SH SYNOPSIS
.PP
\fBkubectl rollingupdate\fP [OPTIONS]
.SH DESCRIPTION
.PP
Perform a rolling update of the given ReplicationController.
.PP
Replaces the specified controller with new controller, updating one pod at a time to use the
new PodTemplate. The new\-controller.json must specify the same namespace as the
existing controller and overwrite at least one (common) label in its replicaSelector.
.PP
Examples:
.PP
.RS
.nf
$ kubectl rollingupdate frontend\-v1 \-f frontend\-v2.json
// Update pods of frontend\-v1 using new controller data in frontend\-v2.json.
$ cat frontend\-v2.json | kubectl rollingupdate frontend\-v1 \-f \-
// Update pods of frontend\-v1 using JSON data passed into stdin.
.fi
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=""
Filename or URL to file to use to create the new controller.
.PP
\fB\-\-poll\-interval\fP="3s"
Time delay between polling controller status after update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
.PP
\fB\-\-timeout\fP="5m0s"
Max time to wait for a controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
.PP
\fB\-\-update\-period\fP="1m0s"
Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

95
docs/man/man1/kubectl-run-container.1 Normal file
View File

@ -0,0 +1,95 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl run\-container \- Run a particular image on the cluster.
.SH SYNOPSIS
.PP
\fBkubectl run\-container\fP [OPTIONS]
.SH DESCRIPTION
.PP
Create and run a particular image, possibly replicated.
Creates a replication controller to manage the created container(s).
.PP
Examples:
.PP
.RS
.nf
$ kubectl run\-container nginx \-\-image=dockerfile/nginx
// Starts a single instance of nginx.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-replicas=5
// Starts a replicated instance of nginx.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-dry\-run
// Dry run. Print the corresponding API objects without creating them.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-overrides='\{ "apiVersion": "v1beta1", "desiredState": \{ ... \} \}'
// Start a single instance of nginx, but overload the desired state with a partial set of values parsed from JSON
.fi
.RE
.SH OPTIONS
.PP
\fB\-\-dry\-run\fP=false
If true, only print the object that would be sent, without sending it.
.PP
\fB\-\-generator\fP="run\-container/v1"
The name of the API generator to use. Default is 'run\-container\-controller/v1'.
.PP
\fB\-\-image\fP=""
The image for the container to run.
.PP
\fB\-l\fP, \fB\-\-labels\fP=""
Labels to apply to the pod(s) created by this call to run\-container.
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-\-overrides\fP=""
An inline JSON override for the generated object. If this is non\-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
.PP
\fB\-\-port\fP=\-1
The port that this container exposes.
.PP
\fB\-r\fP, \fB\-\-replicas\fP=1
Number of replicas to create for this container. Default is 1.
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

43
docs/man/man1/kubectl-stop.1 Normal file
View File

@ -0,0 +1,43 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl stop \- Gracefully shut down a resource.
.SH SYNOPSIS
.PP
\fBkubectl stop\fP [OPTIONS]
.SH DESCRIPTION
.PP
Gracefully shut down a resource.
.PP
Attempts to shut down and delete a resource that supports graceful termination.
If the resource is resizable it will be resized to 0 before deletion.
.PP
Examples:
.PP
.RS
.nf
$ kubectl stop replicationcontroller foo
// Shut down foo.
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

58
docs/man/man1/kubectl-update.1 Normal file
View File

@ -0,0 +1,58 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl update \- Update a resource by filename or stdin.
.SH SYNOPSIS
.PP
\fBkubectl update\fP [OPTIONS]
.SH DESCRIPTION
.PP
Update a resource by filename or stdin.
.PP
JSON and YAML formats are accepted.
.PP
Examples:
.PP
.RS
.nf
$ kubectl update \-f pod.json
// Update a pod using the data in pod.json.
$ cat pod.json | kubectl update \-f \-
// Update a pod based on the JSON passed into stdin.
$ kubectl update pods my\-pod \-\-patch='\{ "apiVersion": "v1beta1", "desiredState": \{ "manifest": [\{ "cpu": 100 \}]\}\}'
// Update a pod by downloading it, applying the patch, then updating. Requires apiVersion be specified.
.fi
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file to use to update the resource.
.PP
\fB\-\-patch\fP=""
A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

32
docs/man/man1/kubectl-version.1 Normal file
View File

@ -0,0 +1,32 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl version \- Print the client and server version information.
.SH SYNOPSIS
.PP
\fBkubectl version\fP [OPTIONS]
.SH DESCRIPTION
.PP
Print the client and server version information.
.SH OPTIONS
.PP
\fB\-c\fP, \fB\-\-client\fP=false
Client version only (no server required).
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

128
docs/man/man1/kubectl.1 Normal file
View File

@ -0,0 +1,128 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl \- kubectl controls the Kubernetes cluster manager
.SH SYNOPSIS
.PP
\fBkubectl\fP [OPTIONS]
.SH DESCRIPTION
.PP
kubectl controls the Kubernetes cluster manager.
.PP
Find more information at
\[la]https://github.com/GoogleCloudPlatform/kubernetes\[ra].
.SH OPTIONS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl\-version(1)\fP, \fBkubectl\-proxy(1)\fP, \fBkubectl\-get(1)\fP, \fBkubectl\-describe(1)\fP, \fBkubectl\-create(1)\fP, \fBkubectl\-update(1)\fP, \fBkubectl\-delete(1)\fP, \fBkubectl\-config(1)\fP, \fBkubectl\-namespace(1)\fP, \fBkubectl\-log(1)\fP, \fBkubectl\-rollingupdate(1)\fP, \fBkubectl\-resize(1)\fP, \fBkubectl\-run\-container(1)\fP, \fBkubectl\-stop(1)\fP, \fBkubectl\-expose(1)\fP, \fBkubectl\-label(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!