oc-rsh man page
oc rsh — Start a shell session in a pod
oc rsh [Options]
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.
- -c, --container=""
Container name; defaults to first container
- -T, --no-tty=false
Disable pseudo-terminal allocation
Path to the shell command
Request timeout for obtaining a pod from the server; defaults to 10 seconds
- -t, --tty=false
Force a pseudo-terminal to be allocated
Options Inherited from Parent Commands
DEPRECATED: The API version to use when talking to the server
Username to impersonate for the operation
Path to the file container Azure container registry configuration information.
Path to a cert. file for the certificate authority
Path to a client certificate file for TLS
Path to a client key file for TLS
The name of the kubeconfig cluster to use
Path to the config file to use for CLI requests.
The name of the kubeconfig context to use
The Google Cloud Platform Service Account JSON Key to use for authentication.
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
Maximum number of seconds between log flushes
Require server version to match client version
- -n, --namespace=""
If present, the namespace scope for this CLI request
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.
The address and port of the Kubernetes API server
Bearer token for authentication to the API server
The name of the kubeconfig user to use
# Open a shell session on the first container in pod 'foo' oc rsh 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/sheduled
June 2016, Ported from the Kubernetes man-doc generator