1OC(1) June 2016 OC(1)
2
6 oc rsh - Start a shell session in a pod
7
11 oc rsh [OPTIONS]
12
16 Open a remote shell session to a container
17 This command will attempt to start a shell session in a pod for the
20 specified resource. It works with pods, deployment configs, deploy‐
21 ments, jobs, daemon sets, replication controllers and replica sets. Any
22 of the aforementioned resources (apart from pods) will be resolved to a
23 ready pod. It will default to the first container if none is specified,
24 and will attempt to use '/bin/sh' as the default shell. You may pass
25 any flags supported by this command before the resource name, and an
26 optional command after the resource name, which will be executed
27 instead of a login shell. A TTY will be automatically allocated if
28 standard input is interactive - use -t and -T to override. A TERM vari‐
29 able is sent to the environment where the shell (or command) will be
30 executed. By default its value is the same as the TERM variable from
31 the local environment; if not set, 'xterm' is used.
32 Note, some containers may not include a shell - use 'oc exec' if you
35 need to run commands directly.
36
40 -c, --container=""
41 Container name; defaults to first container
42 -T, --no-tty=false
45 Disable pseudo-terminal allocation
46 --shell="/bin/sh"
49 Path to the shell command
50 --timeout=10
53 Request timeout for obtaining a pod from the server; defaults to 10
54 seconds
55 -t, --tty=false
58 Force a pseudo-terminal to be allocated
59
63 --allow_verification_with_non_compliant_keys=false
64 Allow a SignatureVerifier to use keys which are technically
65 non-compliant with RFC6962.
66 --alsologtostderr=false
69 log to standard error as well as files
70 --application_metrics_count_limit=100
73 Max number of application metrics to store (per container)
74 --as=""
77 Username to impersonate for the operation
78 --as-group=[]
81 Group to impersonate for the operation, this flag can be repeated
82 to specify multiple groups.
83 --azure-container-registry-config=""
86 Path to the file containing Azure container registry configuration
87 information.
88 --boot_id_file="/proc/sys/kernel/random/boot_id"
91 Comma-separated list of files to check for boot-id. Use the first
92 one that exists.
93 --cache-dir="/builddir/.kube/http-cache"
96 Default HTTP cache directory
97 --certificate-authority=""
100 Path to a cert file for the certificate authority
101 --client-certificate=""
104 Path to a client certificate file for TLS
105 --client-key=""
108 Path to a client key file for TLS
109 --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
112 CIDRs opened in GCE firewall for LB traffic proxy health checks
113 --cluster=""
116 The name of the kubeconfig cluster to use
117 --container_hints="/etc/cadvisor/container_hints.json"
120 location of the container hints file
121 --containerd="unix:///var/run/containerd.sock"
124 containerd endpoint
125 --context=""
128 The name of the kubeconfig context to use
129 --default-not-ready-toleration-seconds=300
132 Indicates the tolerationSeconds of the toleration for
133 notReady:NoExecute that is added by default to every pod that does not
134 already have such a toleration.
135 --default-unreachable-toleration-seconds=300
138 Indicates the tolerationSeconds of the toleration for unreach‐
139 able:NoExecute that is added by default to every pod that does not
140 already have such a toleration.
141 --docker="unix:///var/run/docker.sock"
144 docker endpoint
145 --docker-tls=false
148 use TLS to connect to docker
149 --docker-tls-ca="ca.pem"
152 path to trusted CA
153 --docker-tls-cert="cert.pem"
156 path to client certificate
157 --docker-tls-key="key.pem"
160 path to private key
161 --docker_env_metadata_whitelist=""
164 a comma-separated list of environment variable keys that needs to
165 be collected for docker containers
166 --docker_only=false
169 Only report docker containers in addition to root stats
170 --docker_root="/var/lib/docker"
173 DEPRECATED: docker root is read from docker info (this is a fall‐
174 back, default: /var/lib/docker)
175 --enable_load_reader=false
178 Whether to enable cpu load reader
179 --event_storage_age_limit="default=24h"
182 Max length of time for which to store events (per type). Value is a
183 comma separated list of key values, where the keys are event types
184 (e.g.: creation, oom) or "default" and the value is a duration. Default
185 is applied to all non-specified event types
186 --event_storage_event_limit="default=100000"
189 Max number of events to store (per type). Value is a comma sepa‐
190 rated list of key values, where the keys are event types (e.g.: cre‐
191 ation, oom) or "default" and the value is an integer. Default is
192 applied to all non-specified event types
193 --global_housekeeping_interval=0
196 Interval between global housekeepings
197 --housekeeping_interval=0
200 Interval between container housekeepings
201 --httptest.serve=""
204 if non-empty, httptest.NewServer serves on this address and blocks
205 --insecure-skip-tls-verify=false
208 If true, the server's certificate will not be checked for validity.
209 This will make your HTTPS connections insecure
210 --kubeconfig=""
213 Path to the kubeconfig file to use for CLI requests.
214 --log-flush-frequency=0
217 Maximum number of seconds between log flushes
218 --log_backtrace_at=:0
221 when logging hits line file:N, emit a stack trace
222 --log_cadvisor_usage=false
225 Whether to log the usage of the cAdvisor container
226 --log_dir=""
229 If non-empty, write log files in this directory
230 --logtostderr=true
233 log to standard error instead of files
234 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
237 Comma-separated list of files to check for machine-id. Use the
238 first one that exists.
239 --match-server-version=false
242 Require server version to match client version
243 -n, --namespace=""
246 If present, the namespace scope for this CLI request
247 --request-timeout="0"
250 The length of time to wait before giving up on a single server
251 request. Non-zero values should contain a corresponding time unit (e.g.
252 1s, 2m, 3h). A value of zero means don't timeout requests.
253 -s, --server=""
256 The address and port of the Kubernetes API server
257 --stderrthreshold=2
260 logs at or above this threshold go to stderr
261 --storage_driver_buffer_duration=0
264 Writes in the storage driver will be buffered for this duration,
265 and committed to the non memory backends as a single transaction
266 --storage_driver_db="cadvisor"
269 database name
270 --storage_driver_host="localhost:8086"
273 database host:port
274 --storage_driver_password="root"
277 database password
278 --storage_driver_secure=false
281 use secure connection with database
282 --storage_driver_table="stats"
285 table name
286 --storage_driver_user="root"
289 database username
290 --token=""
293 Bearer token for authentication to the API server
294 --user=""
297 The name of the kubeconfig user to use
298 -v, --v=0
301 log level for V logs
302 --version=false
305 Print version information and quit
306 --vmodule=
309 comma-separated list of pattern=N settings for file-filtered log‐
310 ging
311
315 # Open a shell session on the first container in pod 'foo'
316 oc rsh foo
317 # Run the command 'cat /etc/resolv.conf' inside pod 'foo'
319 oc rsh foo cat /etc/resolv.conf
320 # See the configuration of your internal registry
322 oc rsh dc/docker-registry cat config.yml
323 # Open a shell session on the container named 'index' inside a pod of your job
325 # oc rsh -c index job/sheduled
326
331 oc(1),
332
336 June 2016, Ported from the Kubernetes man-doc generator
337Openshift Openshift CLI User Manuals OC(1)