mirror of https://github.com/k3s-io/k3s
188 lines
4.0 KiB
Groff
188 lines
4.0 KiB
Groff
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
|
|
|
|
|
|
.SH NAME
|
|
.PP
|
|
kubectl stop \- Deprecated: Gracefully shut down a resource by name or filename.
|
|
|
|
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\fBkubectl stop\fP [OPTIONS]
|
|
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
Deprecated: Gracefully shut down a resource by name or filename.
|
|
|
|
.PP
|
|
The stop command is deprecated, all its functionalities are covered by delete command.
|
|
See 'kubectl delete \-\-help' for more details.
|
|
|
|
.PP
|
|
Attempts to shut down and delete a resource that supports graceful termination.
|
|
If the resource is scalable it will be scaled to 0 before deletion.
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB\-\-all\fP=false
|
|
[\-all] to select all the specified resources.
|
|
|
|
.PP
|
|
\fB\-f\fP, \fB\-\-filename\fP=[]
|
|
Filename, directory, or URL to file of resource(s) to be stopped.
|
|
|
|
.PP
|
|
\fB\-\-grace\-period\fP=\-1
|
|
Period of time in seconds given to the resource to terminate gracefully. Ignored if negative.
|
|
|
|
.PP
|
|
\fB\-h\fP, \fB\-\-help\fP=false
|
|
help for stop
|
|
|
|
.PP
|
|
\fB\-\-ignore\-not\-found\fP=false
|
|
Treat "resource not found" as a successful stop.
|
|
|
|
.PP
|
|
\fB\-o\fP, \fB\-\-output\fP=""
|
|
Output mode. Use "\-o name" for shorter output (resource/name).
|
|
|
|
.PP
|
|
\fB\-l\fP, \fB\-\-selector\fP=""
|
|
Selector (label query) to filter on.
|
|
|
|
.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
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.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\-\-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\-\-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\-\-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
|
|
|
|
.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 EXAMPLE
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
// Shut down foo.
|
|
$ kubectl stop replicationcontroller foo
|
|
|
|
// Stop pods and services with label name=myLabel.
|
|
$ kubectl stop pods,services \-l name=myLabel
|
|
|
|
// Shut down the service defined in service.json
|
|
$ kubectl stop \-f service.json
|
|
|
|
// Shut down all resources in the path/to/resources directory
|
|
$ kubectl stop \-f path/to/resources
|
|
|
|
.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!
|