Merge pull request #4355 from vmarmol/cmd

Update github.com/spf13/cobra to HEAD.
This commit is contained in:
Alex Robinson 2015-02-11 15:56:29 -08:00
commit 1fa696ceb2
5 changed files with 209 additions and 118 deletions

2
Godeps/Godeps.json generated
View File

@ -217,7 +217,7 @@
}, },
{ {
"ImportPath": "github.com/spf13/cobra", "ImportPath": "github.com/spf13/cobra",
"Rev": "e1e66f7b4e667751cf530ddb6e72b79d6eeb0235" "Rev": "07a9dc0024fcc97a0dcb3117bdf8933367037f4e"
}, },
{ {
"ImportPath": "github.com/spf13/pflag", "ImportPath": "github.com/spf13/pflag",

View File

@ -216,11 +216,11 @@ For a more complete example of a larger application, please checkout [Hugo](http
## The Help Command ## The Help Command
Cobra automatically adds a help command to your application. Cobra automatically adds a help command to your application when you have subcommands.
This will be called when a user runs 'app help'. Additionally help will also This will be called when a user runs 'app help'. Additionally help will also
support all other commands as input. Say for instance you have a command called support all other commands as input. Say for instance you have a command called
'create' without any additional configuration cobra will work when 'app help 'create' without any additional configuration cobra will work when 'app help
create' is called. create' is called. Every command will automatically have the '--help' flag added.
### Example ### Example

View File

@ -461,7 +461,7 @@ func TestRootHelp(t *testing.T) {
x := fullSetupTest("--help") x := fullSetupTest("--help")
checkResultContains(t, x, "Available Commands:") checkResultContains(t, x, "Available Commands:")
checkResultContains(t, x, "for more information about that command") checkResultContains(t, x, "for more information about a command")
if strings.Contains(x.Output, "unknown flag: --help") { if strings.Contains(x.Output, "unknown flag: --help") {
t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output) t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
@ -470,7 +470,7 @@ func TestRootHelp(t *testing.T) {
x = fullSetupTest("echo --help") x = fullSetupTest("echo --help")
checkResultContains(t, x, "Available Commands:") checkResultContains(t, x, "Available Commands:")
checkResultContains(t, x, "for more information about that command") checkResultContains(t, x, "for more information about a command")
if strings.Contains(x.Output, "unknown flag: --help") { if strings.Contains(x.Output, "unknown flag: --help") {
t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output) t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
@ -482,7 +482,7 @@ func TestRootNoCommandHelp(t *testing.T) {
x := rootOnlySetupTest("--help") x := rootOnlySetupTest("--help")
checkResultOmits(t, x, "Available Commands:") checkResultOmits(t, x, "Available Commands:")
checkResultOmits(t, x, "for more information about that command") checkResultOmits(t, x, "for more information about a command")
if strings.Contains(x.Output, "unknown flag: --help") { if strings.Contains(x.Output, "unknown flag: --help") {
t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output) t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
@ -491,7 +491,7 @@ func TestRootNoCommandHelp(t *testing.T) {
x = rootOnlySetupTest("echo --help") x = rootOnlySetupTest("echo --help")
checkResultOmits(t, x, "Available Commands:") checkResultOmits(t, x, "Available Commands:")
checkResultOmits(t, x, "for more information about that command") checkResultOmits(t, x, "for more information about a command")
if strings.Contains(x.Output, "unknown flag: --help") { if strings.Contains(x.Output, "unknown flag: --help") {
t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output) t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)

View File

@ -40,9 +40,9 @@ type Command struct {
Short string Short string
// The long message shown in the 'help <this-command>' output. // The long message shown in the 'help <this-command>' output.
Long string Long string
// Set of flags specific to this command. // Full set of flags
flags *flag.FlagSet flags *flag.FlagSet
// Set of flags children commands will inherit // Set of flags childrens of this command will inherit
pflags *flag.FlagSet pflags *flag.FlagSet
// Run runs the command. // Run runs the command.
// The args are the arguments after the command name. // The args are the arguments after the command name.
@ -200,12 +200,14 @@ Aliases:
Available Commands: {{range .Commands}}{{if .Runnable}} Available Commands: {{range .Commands}}{{if .Runnable}}
{{rpad .Use .UsagePadding }} {{.Short}}{{end}}{{end}} {{rpad .Use .UsagePadding }} {{.Short}}{{end}}{{end}}
{{end}} {{end}}
{{ if .HasFlags}} Available Flags: {{ if .HasLocalFlags}}Flags:
{{.Flags.FlagUsages}}{{end}}{{if .HasParent}}{{if and (gt .Commands 0) (gt .Parent.Commands 1) }} {{.LocalFlags.FlagUsages}}{{end}}
{{ if .HasAnyPersistentFlags}}Global Flags:
{{.AllPersistentFlags.FlagUsages}}{{end}}{{if .HasParent}}{{if and (gt .Commands 0) (gt .Parent.Commands 1) }}
Additional help topics: {{if gt .Commands 0 }}{{range .Commands}}{{if not .Runnable}} {{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{if gt .Parent.Commands 1 }}{{range .Parent.Commands}}{{if .Runnable}}{{if not (eq .Name $cmd.Name) }}{{end}} Additional help topics: {{if gt .Commands 0 }}{{range .Commands}}{{if not .Runnable}} {{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{if gt .Parent.Commands 1 }}{{range .Parent.Commands}}{{if .Runnable}}{{if not (eq .Name $cmd.Name) }}{{end}}
{{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{end}} {{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{end}}
{{end}}{{ if .HasSubCommands }} {{end}}{{ if .HasSubCommands }}
Use "{{.Root.Name}} help [command]" for more information about that command. Use "{{.Root.Name}} help [command]" for more information about a command.
{{end}}` {{end}}`
} }
} }
@ -682,7 +684,7 @@ func (c *Command) HasParent() bool {
return c.parent != nil return c.parent != nil
} }
// Get the Commands FlagSet // Get the complete FlagSet that applies to this command (local and persistent declared here and by all parents)
func (c *Command) Flags() *flag.FlagSet { func (c *Command) Flags() *flag.FlagSet {
if c.flags == nil { if c.flags == nil {
c.flags = flag.NewFlagSet(c.Name(), flag.ContinueOnError) c.flags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
@ -695,7 +697,23 @@ func (c *Command) Flags() *flag.FlagSet {
return c.flags return c.flags
} }
// Get the Commands Persistent FlagSet // Get the local FlagSet specifically set in the current command
func (c *Command) LocalFlags() *flag.FlagSet {
c.mergePersistentFlags()
local := flag.NewFlagSet(c.Name(), flag.ContinueOnError)
allPersistent := c.AllPersistentFlags()
c.Flags().VisitAll(func(f *flag.Flag) {
if allPersistent.Lookup(f.Name) == nil {
local.AddFlag(f)
}
})
return local
}
// Get the Persistent FlagSet specifically set in the current command
func (c *Command) PersistentFlags() *flag.FlagSet { func (c *Command) PersistentFlags() *flag.FlagSet {
if c.pflags == nil { if c.pflags == nil {
c.pflags = flag.NewFlagSet(c.Name(), flag.ContinueOnError) c.pflags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
@ -707,6 +725,29 @@ func (c *Command) PersistentFlags() *flag.FlagSet {
return c.pflags return c.pflags
} }
// Get the Persistent FlagSet traversing the Command hierarchy
func (c *Command) AllPersistentFlags() *flag.FlagSet {
allPersistent := flag.NewFlagSet(c.Name(), flag.ContinueOnError)
var visit func(x *Command)
visit = func(x *Command) {
if x.HasPersistentFlags() {
x.PersistentFlags().VisitAll(func(f *flag.Flag) {
if allPersistent.Lookup(f.Name) == nil {
allPersistent.AddFlag(f)
}
})
}
if x.HasParent() {
visit(x.parent)
}
}
visit(c)
return allPersistent
}
// For use in testing // For use in testing
func (c *Command) ResetFlags() { func (c *Command) ResetFlags() {
c.flagErrorBuf = new(bytes.Buffer) c.flagErrorBuf = new(bytes.Buffer)
@ -717,7 +758,7 @@ func (c *Command) ResetFlags() {
c.pflags.SetOutput(c.flagErrorBuf) c.pflags.SetOutput(c.flagErrorBuf)
} }
// Does the command contain flags (local not persistent) // Does the command contain any flags (local plus persistent from the entire structure)
func (c *Command) HasFlags() bool { func (c *Command) HasFlags() bool {
return c.Flags().HasFlags() return c.Flags().HasFlags()
} }
@ -727,6 +768,16 @@ func (c *Command) HasPersistentFlags() bool {
return c.PersistentFlags().HasFlags() return c.PersistentFlags().HasFlags()
} }
// Does the command hierarchy contain persistent flags
func (c *Command) HasAnyPersistentFlags() bool {
return c.AllPersistentFlags().HasFlags()
}
// Does the command has flags specifically declared locally
func (c *Command) HasLocalFlags() bool {
return c.LocalFlags().HasFlags()
}
// Climbs up the command tree looking for matching flag // Climbs up the command tree looking for matching flag
func (c *Command) Flag(name string) (flag *flag.Flag) { func (c *Command) Flag(name string) (flag *flag.Flag) {
flag = c.Flags().Lookup(name) flag = c.Flags().Lookup(name)
@ -766,6 +817,10 @@ func (c *Command) ParseFlags(args []string) (err error) {
return nil return nil
} }
func (c *Command) Parent() *Command {
return c.parent
}
func (c *Command) mergePersistentFlags() { func (c *Command) mergePersistentFlags() {
var rmerge func(x *Command) var rmerge func(x *Command)
@ -784,7 +839,3 @@ func (c *Command) mergePersistentFlags() {
rmerge(c) rmerge(c)
} }
func (c *Command) Parent() *Command {
return c.parent
}

View File

@ -11,12 +11,14 @@ Usage:
``` ```
kubectl version [flags] kubectl version [flags]
Available Flags: Flags:
-c, --client=false: Client version only (no server required).
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -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="": 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-certificate="": Path to a client key file for TLS.
--client-key="": 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="": The name of the kubeconfig cluster to use
@ -47,9 +49,14 @@ Usage:
``` ```
kubectl proxy [flags] kubectl proxy [flags]
Available Flags: Flags:
--alsologtostderr=false: log to standard error as well as files
--api-prefix="/api/": Prefix to serve the proxied API under. --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:
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -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="": Path to a cert. file for the certificate authority.
@ -66,7 +73,6 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --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 of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server. --token="": Bearer token for authentication to the API server.
@ -74,8 +80,6 @@ Usage:
--v=0: log level for V logs --v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it --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 --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.
``` ```
@ -109,7 +113,16 @@ Usage:
``` ```
kubectl get [(-o|--output=)json|yaml|template|...] <resource> [<id>] [flags] kubectl get [(-o|--output=)json|yaml|template|...] <resource> [<id>] [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -127,20 +140,13 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --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 of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --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. --token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use --user="": The name of the kubeconfig user to use
--v=0: log level for V logs --v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it --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 --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.
``` ```
@ -154,7 +160,8 @@ Usage:
``` ```
kubectl describe <resource> <id> [flags] kubectl describe <resource> <id> [flags]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -163,6 +170,7 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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. --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. --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 --log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@ -198,7 +206,10 @@ Usage:
``` ```
kubectl create -f filename [flags] kubectl create -f filename [flags]
Available Flags: Flags:
-f, --filename=[]: Filename, directory, or URL to file to use to create the resource
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -207,7 +218,6 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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 -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. --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. --kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -247,7 +257,11 @@ Usage:
``` ```
kubectl update -f filename [flags] kubectl update -f filename [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -256,7 +270,6 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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 -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. --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. --kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -266,7 +279,6 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --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 of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server. --token="": Bearer token for authentication to the API server.
@ -307,7 +319,11 @@ Usage:
``` ```
kubectl delete ([-f filename] | (<resource> [(<id> | -l <label>)] [flags] kubectl delete ([-f filename] | (<resource> [(<id> | -l <label>)] [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -316,7 +332,6 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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 -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. --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. --kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -326,7 +341,6 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --namespace="": If present, the namespace scope for this CLI request.
-l, --selector="": Selector (label query) to filter on
-s, --server="": The address of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server. --token="": Bearer token for authentication to the API server.
@ -354,7 +368,8 @@ Available Commands:
unset property-name Unsets an individual value in a .kubeconfig file unset property-name Unsets an individual value in a .kubeconfig file
use-context context-name Sets the current-context in a .kubeconfig file use-context context-name Sets the current-context in a .kubeconfig file
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -365,6 +380,7 @@ Available Commands:
--context="": The name of the kubeconfig context to use --context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG --envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username --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. --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 --kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory --local=false: use the .kubeconfig in the current directory
@ -400,7 +416,7 @@ Additional help topics:
kubectl expose Take a replicated application and expose it as Kubernetes Service kubectl expose Take a replicated application and expose it as Kubernetes Service
kubectl label Update the labels on a resource kubectl label Update the labels on a resource
Use "kubectl help [command]" for more information about that command. Use "kubectl help [command]" for more information about a command.
``` ```
#### config view #### config view
@ -416,7 +432,14 @@ Usage:
``` ```
kubectl config view [flags] kubectl config view [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -436,14 +459,9 @@ Usage:
--log_flush_frequency=5s: Maximum number of seconds between log flushes --log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --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. --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 of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --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. --token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use --user="": The name of the kubeconfig user to use
--v=0: log level for V logs --v=0: log level for V logs
@ -464,11 +482,12 @@ Usage:
``` ```
kubectl config set-cluster name [--server=server] [--certificate-authority=path/to/certficate/authority] [--api-version=apiversion] [--insecure-skip-tls-verify=true] [flags] kubectl config set-cluster name [--server=server] [--certificate-authority=path/to/certficate/authority] [--api-version=apiversion] [--insecure-skip-tls-verify=true] [flags]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version=: api-version for the cluster entry in .kubeconfig --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority=: certificate-authority for the cluster 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-certificate="": Path to a client key file for TLS.
--client-key="": 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="": The name of the kubeconfig cluster to use
@ -476,7 +495,7 @@ Usage:
--envvar=false: use the .kubeconfig from $KUBECONFIG --envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username --global=false: use the .kubeconfig from /home/username
-h, --help=false: help for set-cluster -h, --help=false: help for set-cluster
--insecure-skip-tls-verify=false: insecure-skip-tls-verify for the cluster entry in .kubeconfig --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 --kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory --local=false: use the .kubeconfig in the current directory
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace --log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@ -485,7 +504,7 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --namespace="": If present, the namespace scope for this CLI request.
--server=: server for the cluster entry in .kubeconfig -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server. --token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use --user="": The name of the kubeconfig user to use
@ -507,13 +526,14 @@ 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] 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]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --api-version="": The API version to use when talking to the server
--auth-path=: auth-path for the user 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="": Path to a cert. file for the certificate authority.
--client-certificate=: client-certificate for the user entry in .kubeconfig --client-certificate="": Path to a client key file for TLS.
--client-key=: client-key for the user entry in .kubeconfig --client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use --cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use --context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG --envvar=false: use the .kubeconfig from $KUBECONFIG
@ -530,7 +550,7 @@ Usage:
--namespace="": If present, the namespace scope for this CLI request. --namespace="": If present, the namespace scope for this CLI request.
-s, --server="": The address of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --stderrthreshold=2: logs at or above this threshold go to stderr
--token=: token for the user entry in .kubeconfig --token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use --user="": The name of the kubeconfig user to use
--v=0: log level for V logs --v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it --validate=false: If true, use a schema to validate the input before sending it
@ -550,14 +570,15 @@ Usage:
``` ```
kubectl config set-context name [--cluster=cluster-nickname] [--user=user-nickname] [--namespace=namespace] [flags] kubectl config set-context name [--cluster=cluster-nickname] [--user=user-nickname] [--namespace=namespace] [flags]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -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="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS. --client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS. --client-key="": Path to a client key file for TLS.
--cluster=: cluster for the context entry in .kubeconfig --cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use --context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG --envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username --global=false: use the .kubeconfig from /home/username
@ -570,11 +591,11 @@ Usage:
--log_flush_frequency=5s: Maximum number of seconds between log flushes --log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace=: namespace for the context entry in .kubeconfig --namespace="": If present, the namespace scope for this CLI request.
-s, --server="": The address of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server. --token="": Bearer token for authentication to the API server.
--user=: user for the context entry in .kubeconfig --user="": The name of the kubeconfig user to use
--v=0: log level for V logs --v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it --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 --vmodule=: comma-separated list of pattern=N settings for file-filtered logging
@ -593,7 +614,8 @@ Usage:
``` ```
kubectl config set property-name property-value [flags] kubectl config set property-name property-value [flags]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -604,7 +626,7 @@ Usage:
--context="": The name of the kubeconfig context to use --context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG --envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username --global=false: use the .kubeconfig from /home/username
-h, --help=false: help for config -h, --help=false: help for set
--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: 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 --kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory --local=false: use the .kubeconfig in the current directory
@ -634,7 +656,8 @@ Usage:
``` ```
kubectl config unset property-name [flags] kubectl config unset property-name [flags]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -645,7 +668,7 @@ Usage:
--context="": The name of the kubeconfig context to use --context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG --envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username --global=false: use the .kubeconfig from /home/username
-h, --help=false: help for config -h, --help=false: help for unset
--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: 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 --kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory --local=false: use the .kubeconfig in the current directory
@ -672,7 +695,8 @@ Usage:
``` ```
kubectl config use-context context-name [flags] kubectl config use-context context-name [flags]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -683,7 +707,7 @@ Usage:
--context="": The name of the kubeconfig context to use --context="": The name of the kubeconfig context to use
--envvar=false: use the .kubeconfig from $KUBECONFIG --envvar=false: use the .kubeconfig from $KUBECONFIG
--global=false: use the .kubeconfig from /home/username --global=false: use the .kubeconfig from /home/username
-h, --help=false: help for config -h, --help=false: help for use-context
--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: 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 --kubeconfig="": use a particular .kubeconfig file
--local=false: use the .kubeconfig in the current directory --local=false: use the .kubeconfig in the current directory
@ -713,7 +737,8 @@ Usage:
``` ```
kubectl namespace [<namespace>] [flags] kubectl namespace [<namespace>] [flags]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -722,6 +747,7 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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. --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. --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 --log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@ -755,7 +781,10 @@ Usage:
``` ```
kubectl log [-f] <pod> [<container>] [flags] kubectl log [-f] <pod> [<container>] [flags]
Available Flags: Flags:
-f, --follow=false: Specify if the logs should be streamed.
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -764,7 +793,6 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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 -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. --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. --kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -803,7 +831,13 @@ Usage:
``` ```
kubectl rollingupdate <old-controller-name> -f <new-controller.json> [flags] kubectl rollingupdate <old-controller-name> -f <new-controller.json> [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -812,7 +846,6 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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 -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. --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. --kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -822,12 +855,9 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --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 of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --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. --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 --user="": The name of the kubeconfig user to use
--v=0: log level for V logs --v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it --validate=false: If true, use a schema to validate the input before sending it
@ -855,7 +885,12 @@ Usage:
``` ```
kubectl resize [--resource-version=<version>] [--current-replicas=<count>] --replicas=<count> <resource> <id> [flags] kubectl resize [--resource-version=<version>] [--current-replicas=<count>] --replicas=<count> <resource> <id> [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -864,7 +899,6 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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 -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. --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. --kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -874,8 +908,6 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --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 of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server. --token="": Bearer token for authentication to the API server.
@ -908,7 +940,20 @@ Usage:
``` ```
kubectl run-container <name> --image=<image> [--port=<port>] [--replicas=replicas] [--dry-run=<bool>] [--overrides=<inline-json>] [flags] kubectl run-container <name> --image=<image> [--port=<port>] [--replicas=replicas] [--dry-run=<bool>] [--overrides=<inline-json>] [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -917,28 +962,17 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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 -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. --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. --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_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_dir=: If non-empty, write log files in this directory
--log_flush_frequency=5s: Maximum number of seconds between log flushes --log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --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 of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --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. --token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use --user="": The name of the kubeconfig user to use
--v=0: log level for V logs --v=0: log level for V logs
@ -963,7 +997,8 @@ Usage:
``` ```
kubectl stop <resource> <id> [flags] kubectl stop <resource> <id> [flags]
Available Flags:
Global Flags:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -972,6 +1007,7 @@ Usage:
--client-key="": 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="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context 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. --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. --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 --log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@ -1009,7 +1045,23 @@ 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] kubectl expose <name> --port=<port> [--protocol=TCP|UDP] [--container-port=<number-or-name>] [--service-name=<name>] [--public-ip=<ip>] [--create-external-load-balancer] [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -1017,11 +1069,7 @@ Usage:
--client-certificate="": Path to a client key file for TLS. --client-certificate="": Path to a client key file for TLS.
--client-key="": 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="": 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 --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 -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. --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. --kubeconfig="": Path to the kubeconfig file to use for CLI requests.
@ -1031,18 +1079,8 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --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 of the Kubernetes API server -s, --server="": The address 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 --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. --token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use --user="": The name of the kubeconfig user to use
--v=0: log level for V logs --v=0: log level for V logs
@ -1074,7 +1112,15 @@ Usage:
``` ```
kubectl label [--overwrite] <resource> <name> <key-1>=<val-1> ... <key-n>=<val-n> [--resource-version=<version>] [flags] kubectl label [--overwrite] <resource> <name> <key-1>=<val-1> ... <key-n>=<val-n> [--resource-version=<version>] [flags]
Available 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:
--alsologtostderr=false: log to standard error as well as files --alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server --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. -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
@ -1092,14 +1138,8 @@ Usage:
--logtostderr=true: log to standard error instead of files --logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version --match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request. --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 of the Kubernetes API server -s, --server="": The address of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr --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. --token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use --user="": The name of the kubeconfig user to use
--v=0: log level for V logs --v=0: log level for V logs