This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

kubectl run

    Synopsis

    Create and run a particular image in a pod.

    kubectl run NAME --image=image [--env="key=value"] [--port=port] [--dry-run=server|client] [--overrides=inline-json] [--command] -- [COMMAND] [args...]

    Examples

      # Start a nginx pod
  kubectl run nginx --image=nginx
  
  # Start a hazelcast pod and let the container expose port 5701
  kubectl run hazelcast --image=hazelcast/hazelcast --port=5701
  
  # Start a hazelcast pod and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container
  kubectl run hazelcast --image=hazelcast/hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
  
  # Start a hazelcast pod and set labels "app=hazelcast" and "env=prod" in the container
  kubectl run hazelcast --image=hazelcast/hazelcast --labels="app=hazelcast,env=prod"
  
  # Dry run; print the corresponding API objects without creating them
  kubectl run nginx --image=nginx --dry-run=client
  
  # Start a nginx pod, but overload the spec with a partial set of values parsed from JSON
  kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
  
  # Start a busybox pod 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 pod using the default command, but use custom arguments (arg1 .. argN) for that command
  kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
  
  # Start the nginx pod using a different command and custom arguments
  kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>

    Options

    --allow-missing-template-keys     Default: true

    If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

    --annotations strings

    Annotations to apply to the pod.

    --attach

    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. With '--restart=Never' the exit code of the container process is returned.

    --cascade string[="background"]     Default: "background"

    Must be "background", "orphan", or "foreground". Selects the deletion cascading strategy for the dependents (e.g. Pods created by a ReplicationController). Defaults to background.

    --command

    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 string[="unchanged"]     Default: "none"

    Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.

    --env strings

    Environment variables to set in the container.

    --expose --port

    If true, create a ClusterIP service associated with the pod. Requires --port.

    --field-manager string     Default: "kubectl-run"

    Name of the manager used to track field ownership.

    -f, --filename strings

    to use to replace the resource.

    --force

    If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.

    --grace-period int     Default: -1

    Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion).

    -h, --help

    help for run

    --image string

    The image for the container to run.

    --image-pull-policy string

    The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server.

    -k, --kustomize string

    Process a kustomization directory. This flag can't be used together with -f or -R.

    -l, --labels string

    Comma separated labels to apply to the pod. Will override previous values.

    --leave-stdin-open

    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.

    -o, --output string

    Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).

    --override-type string     Default: "merge"

    The method used to override the generated object: json, merge, or strategic.

    --overrides string

    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.

    --pod-running-timeout duration     Default: 1m0s

    The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running

    --port string

    The port that this container exposes.

    --privileged

    If true, run the container in privileged mode.

    -q, --quiet

    If true, suppress prompt messages.

    -R, --recursive

    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.

    --restart string     Default: "Always"

    The restart policy for this Pod. Legal values [Always, OnFailure, Never].

    --rm

    If true, delete the pod after it exits. Only valid when attaching to the container, e.g. with '--attach' or with '-i/--stdin'.

    --save-config

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.

    --show-managed-fields

    If true, keep the managedFields when printing objects in JSON or YAML format.

    -i, --stdin

    Keep stdin open on the container in the pod, even if nothing is attached.

    --template string

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

    --timeout duration

    The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object

    -t, --tty

    Allocate a TTY for the container in the pod.

    --wait

    If true, wait for resources to be gone before returning. This waits for finalizers.

    Options inherited from parent commands

    --as string

    Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

    --as-group strings

    Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

    --as-uid string

    UID to impersonate for the operation.

    --cache-dir string     Default: "$HOME/.kube/cache"

    Default cache directory

    --certificate-authority string

    Path to a cert file for the certificate authority

    --client-certificate string

    Path to a client certificate file for TLS

    --client-key string

    Path to a client key file for TLS

    --cluster string

    The name of the kubeconfig cluster to use

    --context string

    The name of the kubeconfig context to use

    --default-not-ready-toleration-seconds int     Default: 300

    Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration.

    --default-unreachable-toleration-seconds int     Default: 300

    Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.

    --disable-compression

    If true, opt-out of response compression for all requests to the server

    --insecure-skip-tls-verify

    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

    --kubeconfig string

    Path to the kubeconfig file to use for CLI requests.

    --match-server-version

    Require server version to match client version

    -n, --namespace string

    If present, the namespace scope for this CLI request

    --password string

    Password for basic authentication to the API server

    --profile string     Default: "none"

    Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

    --profile-output string     Default: "profile.pprof"

    Name of the file to write the profile to

    --request-timeout string     Default: "0"

    The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

    -s, --server string

    The address and port of the Kubernetes API server

    --storage-driver-buffer-duration duration     Default: 1m0s

    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 string     Default: "cadvisor"

    database name

    --storage-driver-host string     Default: "localhost:8086"

    database host:port

    --storage-driver-password string     Default: "root"

    database password

    --storage-driver-secure

    use secure connection with database

    --storage-driver-table string     Default: "stats"

    table name

    --storage-driver-user string     Default: "root"

    database username

    --tls-server-name string

    Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

    --token string

    Bearer token for authentication to the API server

    --user string

    The name of the kubeconfig user to use

    --username string

    Username for basic authentication to the API server

    --version version[=true]

    --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version

    --warnings-as-errors

    Treat warnings received from the server as errors and exit with a non-zero exit code

    See Also

    • kubectl - kubectl controls the Kubernetes cluster manager