mirror of
https://github.com/optim-enterprises-bv/kubernetes.git
synced 2025-11-04 04:08:16 +00:00
202 lines
4.7 KiB
Groff
202 lines
4.7 KiB
Groff
.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).
|
|
|
|
|
|
.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\-h\fP, \fB\-\-help\fP=false
|
|
help for run\-container
|
|
|
|
.PP
|
|
\fB\-\-hostport\fP=\-1
|
|
The host port mapping for the container port. To demonstrate a single\-machine container.
|
|
|
|
.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. The template format is golang templates [
|
|
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
|
|
|
|
|
|
.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
|
|
// Starts a single instance of nginx.
|
|
$ kubectl run\-container nginx \-\-image=nginx
|
|
|
|
// Starts a replicated instance of nginx.
|
|
$ kubectl run\-container nginx \-\-image=nginx \-\-replicas=5
|
|
|
|
// Dry run. Print the corresponding API objects without creating them.
|
|
$ kubectl run\-container nginx \-\-image=nginx \-\-dry\-run
|
|
|
|
// Start a single instance of nginx, but overload the desired state with a partial set of values parsed from JSON.
|
|
$ kubectl run\-container nginx \-\-image=nginx \-\-overrides='\{ "apiVersion": "v1beta1", "desiredState": \{ ... \} \}'
|
|
|
|
.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!
|