OC(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

🐚 oc rsh — NAME

okay so bestie, this is oc rsh from oc(1), dated June 2016 — and it's the "start a shell session in a container" girlie. That's the whole vibe. You wanna get inside a container and poke around? This is the command. 💅

✨ SYNOPSIS ✨

oc rsh [OPTIONS]

🫶 DESCRIPTION 🫶

So here's the tea: oc rsh opens a remote shell session to a container. Literally, you get a shell inside the container, no cap. 🔥

This command will attempt to start a shell session in a pod for the resource you specify. It works with pods, deployment configs, deployments, jobs, daemon sets, replication controllers and replica sets. Any of those resources (apart from pods — pods are already pods, they don't need resolving, main character energy) will be resolved to a ready pod.

It'll default to the first container if you don't specify one, and it 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 that. 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 your local environment; if it's not set, 'xterm' is used. 🌈

Heads up bestie 🙈 — some containers may not include a shell. If that's your situation, use 'oc exec' when you need to run commands directly. Not every container is gonna serve looks.

💖 OPTIONS 💖

  • -c, --container="" — container name; defaults to the first container. simple as that, she picks for you 💅
  • -f, --filename=[] — to use to rsh into the resource (yes, that's literally how it's worded, I'm just the messenger 🎀)
  • -T, --no-tty=false — disable pseudo-terminal allocation. no fake tty for you ✨
  • --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. patience is a virtue, but she's got a limit ⏳
  • --shell="/bin/sh" — path to the shell command 🐚
  • -t, --tty=false — force a pseudo-terminal to be allocated. give her the tty, she deserves it 💖

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the family heirlooms, bestie — inherited, still iconic:

  • --as="" — username to impersonate for the operation. user could be a regular user or a service account in a namespace. dress up as someone else, we love a transformation arc 🦋
  • --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.
  • --as-user-extra=[] — user extras to impersonate for the operation; this flag can be repeated to specify multiple values for the same key.
  • --cache-dir="/homeless-shelter/.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. ⚠️ like, genuinely insecure, not cute-insecure. be careful babes.
  • --kubeconfig="" — path to the kubeconfig file to use for CLI requests.
  • --kuberc="" — path to the kuberc file to use for preferences. this can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off. iykyk 🧚
  • --match-server-version=false — require server version to match client version. she's picky, and honestly? valid.
  • -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. she'll wait forever, that's her toxic trait 💀
  • -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. no warnings, only consequences 😭

🌸 EXAMPLE 🌸

okay these are the ~lewks~, copied exactly, go off:

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

(that trailing comma is hers, we respect it 💜)

🎀 HISTORY 🎀

  • June 2016 — Ported from the Kubernetes man-doc generator. vintage! an icon was born ✨

okay bestie, that's the whole page 🫶 go forth and shell into things responsibly. this little number comes to you from Openshift, part of the Openshift CLI User Manuals, and it's dated all the way back to June 2016 — stan a timeless classic 🎀💖🦋

📦 where this page comes from