NAME¶

oc rsh - Start a shell session in a container

SYNOPSIS¶

oc rsh [OPTIONS]

DESCRIPTION¶

Open a remote shell session to a container.

This command will attempt to start a shell session in a pod for the specified resource. It works with pods, deployment configs, deployments, jobs, daemon sets, replication controllers and replica sets. Any of the aforementioned resources (apart from pods) will be resolved to a ready pod. It will default to the first container if none is specified, and will attempt to use '/bin/sh' as the default shell. You may pass any flags supported by this command before the resource name, and an optional command after the resource name, which will be executed instead of a login shell. A TTY will be automatically allocated if standard input is interactive - use -t and -T to override. A TERM variable is sent to the environment where the shell (or command) will be executed. By default its value is the same as the TERM variable from the local environment; if not set, 'xterm' is used.

Note, some containers may not include a shell - use 'oc exec' if you need to run commands directly.

OPTIONS¶

-c, --container=""
Container name; defaults to first container

-f, --filename=[]
to use to rsh into the resource

-T, --no-tty=false
Disable pseudo-terminal allocation

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

--shell="/bin/sh"
Path to the shell command

-t, --tty=false
Force a pseudo-terminal to be allocated

OPTIONS INHERITED FROM PARENT COMMANDS¶

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

--as-group=[]
Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

--as-uid=""
UID to impersonate for the operation.

--cache-dir="/home/abuild/.kube/cache"
Default cache directory

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

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

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

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

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

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

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

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

--profile-output="profile.pprof"
Name of the file to write the profile to

--request-timeout="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=""
The address and port of the Kubernetes API server

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

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

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

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

EXAMPLE¶

  # Open a shell session on the first container in pod 'foo'


  oc rsh foo


  


  # Open a shell session on the first container in pod 'foo' and namespace 'bar'


  # (Note that oc client specific arguments must come before the resource name and its arguments)


  oc rsh -n bar foo


  


  # Run the command 'cat /etc/resolv.conf' inside pod 'foo'


  oc rsh foo cat /etc/resolv.conf


  


  # See the configuration of your internal registry


  oc rsh dc/docker-registry cat config.yml


  


  # Open a shell session on the container named 'index' inside a pod of your job


  oc rsh -c index job/scheduled

SEE ALSO¶

oc(1),

HISTORY¶

June 2016, Ported from the Kubernetes man-doc generator