openshift-cli-run man page

openshift cli run — Run a particular image on the cluster.

Synopsis

openshift cli run [Options]

Description

Create and run a particular image, possibly replicated

Creates a deployment config to manage the created container(s). You can choose to run in the foreground for an interactive container execution. You may pass 'run/v1' to --generator to create a replication controller instead of a deployment config.

Options

--attach=false
If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true.
--command=false
If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default.
--dry-run=false
If true, only print the object that would be sent, without sending it.
--env=[]
Environment variables to set in the container
--expose=false
If true, a public, external service is created for the container(s) which are run
--generator=""
The name of the API generator to use. Default is 'deploymentconfig/v1' if --restart=Always, otherwise the default is 'run-pod/v1'.
--hostport=-1
The host port mapping for the container port. To demonstrate a single-machine container.
--image=""
The image for the container to run.
--include-extended-apis=true
If true, include definitions of new APIs via calls to the API server. [default true]
-l, --labels=""
Labels to apply to the pod(s).
--leave-stdin-open=false
If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes.
--limits=""
The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi'. Note that server side components may assign limits depending on the server configuration, such as limit ranges.
--no-headers=false
When using the default output, don't print headers.
-o, --output=""
Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [ ⟨http://golang.org/pkg/text/template/#pk…⟩] and jsonpath template [ ⟨http://releases.k8s.io/release-1.3/docs…⟩].
--output-version=""
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
--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. If --expose is true, this is also the port used by the service that is created.
--record=false
Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
-r, --replicas=1
Number of replicas to create for this container. Default is 1.
--requests=""
The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.
--restart="Always"
The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to 'OnFailure', a job is created for this pod, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1. Default 'Always'
--rm=false
If true, delete resources created in this command for attached containers.
--save-config=false
If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
--service-generator="service/v2"
The name of the generator to use for creating a service. Only used if --expose is true
--service-overrides=""
An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true.
-a, --show-all=true
When printing, show all resources (false means hide terminated pods.)
--show-labels=false
When printing, show all labels as the last column (default hide labels column)
--sort-by=""
If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
-i, --stdin=false
Keep stdin open on the container(s) in the pod, even if nothing is attached.
--template=""
Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [ ⟨http://golang.org/pkg/text/template/#pk…⟩].
-t, --tty=false
Allocated a TTY for each container in the pod.

Options Inherited from Parent Commands

--api-version=""
DEPRECATED: The API version to use when talking to the server

--as=""
Username to impersonate for the operation.

--certificate-authority=""
Path to a cert. file for the certificate authority.

--client-certificate=""
Path to a client certificate file for TLS.

--client-key=""
Path to a client key file for TLS.

--cluster=""
The name of the kubeconfig cluster to use

--config=""
Path to the config file to use for CLI requests.

--context=""
The name of the kubeconfig context to use

--google-json-key=""
The Google Cloud Platform Service Account JSON Key to use for authentication.

--insecure-skip-tls-verify=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.

--log-flush-frequency=0
Maximum number of seconds between log flushes

--match-server-version=false
Require server version to match client version

-n, --namespace=""
If present, the namespace scope for this CLI request.

--server=""
The address and port of the Kubernetes API server

--token=""
Bearer token for authentication to the API server.

--user=""
The name of the kubeconfig user to use

Example

# Starts a single instance of nginx.
openshift cli run nginx --image=nginx

# Starts a replicated instance of nginx.
openshift cli run nginx --image=nginx --replicas=5

# Dry run. Print the corresponding API objects without creating them.
openshift cli run nginx --image=nginx --dry-run

# Start a single instance of nginx, but overload the spec of the replication
# controller with a partial set of values parsed from JSON.
openshift cli run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'

# Start a single instance of nginx and keep it in the foreground, don't restart it if it exits.
openshift cli run -i --tty nginx --image=nginx --restart=Never

See Also

openshift-cli(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-cli(1).

Openshift CLI User Manuals Openshift June 2016