2015-02-06 03:02:44 +00:00
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
2015-07-29 09:19:18 +00:00
kubectl stop \- Deprecated: Gracefully shut down a resource by name or filename.
2015-02-06 03:02:44 +00:00
.SH SYNOPSIS
.PP
\fB kubectl stop\fP [OPTIONS]
.SH DESCRIPTION
.PP
2015-07-29 09:19:18 +00:00
Deprecated: Gracefully shut down a resource by name or filename.
.PP
2015-07-06 11:31:27 +00:00
The stop command is deprecated, all its functionalities are covered by delete command.
2015-07-29 09:19:18 +00:00
See 'kubectl delete \- \- help' for more details.
2015-02-06 03:02:44 +00:00
.PP
Attempts to shut down and delete a resource that supports graceful termination.
2015-05-21 21:10:25 +00:00
If the resource is scalable it will be scaled to 0 before deletion.
2015-02-06 03:02:44 +00:00
2015-02-20 21:29:23 +00:00
.SH OPTIONS
2015-03-10 12:21:49 +00:00
.PP
\fB \- \- all\fP =false
2015-05-21 17:01:34 +00:00
[\- all] to select all the specified resources.
2015-03-10 12:21:49 +00:00
2015-02-20 21:29:23 +00:00
.PP
\fB \- f\fP , \fB \- \- filename\fP =[]
2015-05-21 17:01:34 +00:00
Filename, directory, or URL to file of resource(s) to be stopped.
2015-02-20 21:29:23 +00:00
2015-04-28 12:21:57 +00:00
.PP
\fB \- \- grace\- period\fP =\- 1
Period of time in seconds given to the resource to terminate gracefully. Ignored if negative.
2015-05-21 17:01:34 +00:00
.PP
\fB \- \- ignore\- not\- found\fP =false
Treat "resource not found" as a successful stop.
2016-03-10 01:27:19 +00:00
.PP
\fB \- \- include\- extended\- apis\fP =true
If true, include definitions of new APIs via calls to the API server. [default true]
2015-07-01 22:47:43 +00:00
.PP
\fB \- o\fP , \fB \- \- output\fP =""
Output mode. Use "\- o name" for shorter output (resource/name).
2016-03-28 19:44:21 +00:00
.PP
\fB \- R\fP , \fB \- \- recursive\fP =false
If true, process directory recursively.
2015-03-10 12:21:49 +00:00
.PP
\fB \- l\fP , \fB \- \- selector\fP =""
2015-05-21 17:01:34 +00:00
Selector (label query) to filter on.
2015-03-10 12:21:49 +00:00
2015-05-29 23:16:30 +00:00
.PP
\fB \- \- timeout\fP =0
The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
2015-02-20 21:29:23 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB \- \- alsologtostderr\fP =false
log to standard error as well as files
.PP
\fB \- \- api\- version\fP =""
2016-03-03 01:35:55 +00:00
DEPRECATED: The API version to use when talking to the server
2015-02-20 21:29:23 +00:00
2016-03-28 18:33:58 +00:00
.PP
\fB \- \- as\fP =""
Username to impersonate for the operation.
2015-02-20 21:29:23 +00:00
.PP
\fB \- \- certificate\- authority\fP =""
Path to a cert. file for the certificate authority.
.PP
\fB \- \- client\- certificate\fP =""
2015-11-24 01:33:35 +00:00
Path to a client certificate file for TLS.
2015-02-20 21:29:23 +00:00
.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 \- \- 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
2015-05-16 16:44:42 +00:00
\fB \- \- log\- backtrace\- at\fP =:0
2015-02-20 21:29:23 +00:00
when logging hits line file:N, emit a stack trace
.PP
2015-05-16 16:44:42 +00:00
\fB \- \- log\- dir\fP =""
2015-02-20 21:29:23 +00:00
If non\- empty, write log files in this directory
.PP
2015-05-16 16:44:42 +00:00
\fB \- \- log\- flush\- frequency\fP =5s
2015-02-20 21:29:23 +00:00
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 \- \- password\fP =""
Password for basic authentication to the API server.
.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 \- \- username\fP =""
Username for basic authentication to the API server.
.PP
\fB \- \- v\fP =0
log level for V logs
2015-02-06 03:02:44 +00:00
.PP
2015-02-20 21:29:23 +00:00
\fB \- \- vmodule\fP =
comma\- separated list of pattern=N settings for file\- filtered logging
2015-02-06 03:02:44 +00:00
2015-02-20 21:29:23 +00:00
.SH EXAMPLE
2015-02-06 03:02:44 +00:00
.PP
.RS
.nf
2015-08-12 16:50:09 +00:00
# Shut down foo.
2016-02-29 14:41:09 +00:00
kubectl stop replicationcontroller foo
2015-02-19 19:51:38 +00:00
2015-08-12 16:50:09 +00:00
# Stop pods and services with label name=myLabel.
2016-02-29 14:41:09 +00:00
kubectl stop pods,services \- l name=myLabel
2015-03-10 12:21:49 +00:00
2015-08-12 16:50:09 +00:00
# Shut down the service defined in service.json
2016-02-29 14:41:09 +00:00
kubectl stop \- f service.json
2015-02-19 19:51:38 +00:00
2015-08-12 16:50:09 +00:00
# Shut down all resources in the path/to/resources directory
2016-02-29 14:41:09 +00:00
kubectl stop \- f path/to/resources
2015-02-06 03:02:44 +00:00
.fi
.RE
.SH SEE ALSO
.PP
\fB kubectl(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!