openshift-cli-rsh man page

openshift cli rsh — Start a shell session in a pod

Synopsis

openshift cli 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, jobs, daemon sets, and replication controllers. 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 'openshift cli exec' if you need to run commands directly.

Options

-c, --container=""

Container name; defaults to first container

-T, --no-tty=false

Disable pseudo-terminal allocation

--shell="/bin/sh"

Path to the shell command

--timeout=10

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

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

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

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

  # Open a shell session on the first container in pod 'foo'
  openshift cli rsh foo
  
  # Run the command 'cat /etc/resolv.conf' inside pod 'foo'
  openshift cli rsh foo cat /etc/resolv.conf
  
  # See the configuration of your internal registry
  openshift cli rsh dc/docker-registry cat config.yml
  
  # Open a shell session on the container named 'index' inside a pod of your job
  # openshift cli rsh -c index job/sheduled

See Also

openshift-cli(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-cli(1).

Openshift CLI User Manuals June 2016