OPENSHIFT KUBE(1)

NAME

openshift kube run - Run a particular image on the cluster.

SYNOPSIS

openshift kube run [OPTIONS]

DESCRIPTION

Create and run a particular image, possibly replicated. Creates a deployment or job to manage the created container(s).

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 'deployment/v1beta1' if --restart=Always, 'job/v1' for OnFailure and 'run-pod/v1' for Never. This will happen only for cluster version at least 1.3, for 1.2 we will fallback to 'deployment/v1beta1' for --restart=Always, 'job/v1' for others, for olders we will fallback to 'run/v1' for --restart=Always, 'run-pod/v1' for others.

--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/#pkg-overview⟩] and jsonpath template [ ⟨http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md⟩].

--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.

--schedule=""
    A schedule in the Cron format the job should be run with.

--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=false
    When printing, show all resources (default 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/#pkg-overview⟩].

-t, --tty=false
    Allocated a TTY for each container in the pod.

OPTIONS INHERITED FROM PARENT COMMANDS

--alsologtostderr=false
    log to standard error as well as files

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

--application-metrics-count-limit=100
    Max number of application metrics to store (per container)

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

--boot-id-file="/proc/sys/kernel/random/boot_id"
    Comma-separated list of files to check for boot-id. Use the first one that exists.

--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.

--container-hints="/etc/cadvisor/container_hints.json"
    location of the container hints file

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

--docker="unix:///var/run/docker.sock"
    docker endpoint

--docker-env-metadata-whitelist=""
    a comma-separated list of environment variable keys that needs to be collected for docker containers

--docker-only=false
    Only report docker containers in addition to root stats

--docker-root="/var/lib/docker"
    DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)

--enable-load-reader=false
    Whether to enable cpu load reader

--event-storage-age-limit="default=0"
    Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types

--event-storage-event-limit="default=0"
    Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types

--global-housekeeping-interval=0
    Interval between global housekeepings

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

--housekeeping-interval=0
    Interval between container housekeepings

--httptest.serve=""
    if non-empty, httptest.NewServer serves on this address and blocks

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

--ir-data-source="influxdb"
    Data source used by InitialResources. Supported options: influxdb, gcm.

--ir-dbname="k8s"
    InfluxDB database name which contains metrics requred by InitialResources

--ir-hawkular=""
    Hawkular configuration URL

--ir-influxdb-host="localhost:8080/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb:api"
    Address of InfluxDB which contains metrics requred by InitialResources

--ir-namespace-only=false
    Whether the estimation should be made only based on data from the same namespace.

--ir-password="root"
    Password used for connecting to InfluxDB

--ir-percentile=90
    Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.

--ir-user="root"
    User used for connecting to InfluxDB

--kubeconfig=""
    Specify a kubeconfig file to define the configuration

--log-backtrace-at=:0
    when logging hits line file:N, emit a stack trace

--log-cadvisor-usage=false
    Whether to log the usage of the cAdvisor container

--log-dir=""
    If non-empty, write log files in this directory

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

--logtostderr=true
    log to standard error instead of files

--machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
    Comma-separated list of files to check for machine-id. Use the first one that exists.

--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

--stderrthreshold=2
    logs at or above this threshold go to stderr

--storage-driver-buffer-duration=0
    Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction

--storage-driver-db="cadvisor"
    database name

--storage-driver-host="localhost:8086"
    database host:port

--storage-driver-password="root"
    database password

--storage-driver-secure=false
    use secure connection with database

--storage-driver-table="stats"
    table name

--storage-driver-user="root"
    database username

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

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

-v, --v=0
    log level for V logs

--vmodule=
    comma-separated list of pattern=N settings for file-filtered logging

EXAMPLE

    # Start a single instance of nginx.
    kubectl run nginx --image=nginx
    # Start a single instance of hazelcast and let the container expose port 5701 .
    kubectl run hazelcast --image=hazelcast --port=5701
    # Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.
    kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
    # Start a replicated instance of nginx.
    kubectl run nginx --image=nginx --replicas=5
    # Dry run. Print the corresponding API objects without creating them.
    kubectl run nginx --image=nginx --dry-run
    # Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.
    kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
    # Start a pod of busybox and keep it in the foreground, don't restart it if it exits.
    kubectl run -i -t busybox --image=busybox --restart=Never
    # Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.
    kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
    # Start the nginx container using a different command and custom arguments.
    kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
    # Start the perl container to compute π to 2000 places and print it out.
    kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
    # Start the scheduled job to compute π to 2000 places and print it out every 5 minutes.
    kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'

SEE ALSO

openshift-kube(1),

HISTORY

June 2016, Ported from the Kubernetes man-doc generator