OC(1)

🌸 OC(1) — okay so here's the tea, bestie 🌸

okay so bestie, this is the OC(1) manual page for oc port-forward, and it's literally about forwarding one or more local ports to a pod. no cap. 🎯 the way that this command just works is giving main character energy. iykyk. 💅

---

✨ NAME ✨

oc port-forward — forward one or more local ports to a pod. that's the whole vibe. 🎀

---

🦋 SYNOPSIS 🦋

oc port-forward [OPTIONS]

---

💖 DESCRIPTION 💖

okay so picture this: you've got a pod running and you need to forward one or more local ports to it. that's literally what this command does. it's giving "i need to talk to this pod's service from my local machine" and oc port-forward is here to make it happen. slay. ✨

you can pick which pod by using resource type/name — like deployment/mydeployment — to select a pod. if you leave out the resource type, it just defaults to 'pod'. no cap.

and here's the thing, bestie: if there are multiple pods matching the criteria, a pod will be selected automatically. the algorithm picks one for you. but heads up — the forwarding session ends when the selected pod terminates, and you'll need to rerun the command to resume forwarding. so when your pod dies, your connection dies too. that's just the way it is. 💀

---

🎀 OPTIONS 🎀

here are the actual options that are specific to this command:

• --address=[localhost] — addresses to listen on (comma separated). it only accepts IP addresses or localhost as a value. when localhost is supplied, kubectl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these addresses are available to bind. so basically, if you say localhost, it's going to try both the IPv4 and IPv6 loopback addresses, and if neither works, it's a no-go. 😭
• --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. so if your pod is still spinning up, you can tell it to wait a bit. the default is 0, which means no waiting. you have to set it to something higher than zero (like 5s or 2m) to actually wait. ⏳

---

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these are the options that come from the parent commands. they're kind of the OG flags that get passed down. let's go through them one by one, bestie:

• --as="" — username to impersonate for the operation. user could be a regular user or a service account in a namespace. so you're basically saying "pretend to be this user." 👑
• --as-group=[] — group to impersonate for the operation. this flag can be repeated to specify multiple groups. so if you need to impersonate multiple groups, just throw this flag in multiple times. 🎯
• --as-uid="" — UID to impersonate for the operation. like, the numeric user ID. 🔢
• --as-user-extra=[] — user extras to impersonate for the operation. this flag can be repeated to specify multiple values for the same key. so if the user has extra attributes, this is how you pass them. 🎒
• --cache-dir="/homeless-shelter/.kube/cache" — default cache directory. that's the path where it caches stuff. the default is "/homeless-shelter/.kube/cache". kinda specific, ngl. 📁
• --certificate-authority="" — path to a cert file for the certificate authority. so if you've got a custom CA, point to it here. 🔐
• --client-certificate="" — path to a client certificate file for TLS. your client cert goes here. 📜
• --client-key="" — path to a client key file for TLS. and the key that matches the cert goes here. 🔑
• --cluster="" — the name of the kubeconfig cluster to use. pick which cluster from your kubeconfig. 🏢
• --context="" — the name of the kubeconfig context to use. pick which context. 🎭
• --disable-compression=false — if true, opt-out of response compression for all requests to the server. so if you set it to true, no compression. the default is false. 🗜️
• --insecure-skip-tls-verify=false — if true, the server's certificate will not be checked for validity. this will make your HTTPS connections insecure. so like, don't do this unless you're in a test environment or you're feeling reckless. the default is false. ⚠️
• --kubeconfig="" — path to the kubeconfig file to use for CLI requests. where's your kubeconfig? put the path here. 📄
• --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. so if you don't want to use kuberc, you can disable it. 🛠️
• --match-server-version=false — require server version to match client version. if true, the server and client versions need to match. default is false. 🎯
• -n, --namespace="" — if present, the namespace scope for this CLI request. so you can scope the request to a specific namespace. 🏷️
• --profile="none" — name of profile to capture. one of (none|cpu|heap|goroutine|threadcreate|block|mutex). so if you need performance profiling, this is where you pick which profile. default is "none". 📊
• --profile-output="profile.pprof" — name of the file to write the profile to. default is "profile.pprof". so it writes to that file by default. 📁
• --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. so 0 means wait forever. 🕰️
• -s, --server="" — the address and port of the Kubernetes API server. where's your API server? put it here. 🌐
• --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. so if you need to override the server name for TLS validation, this is it. 🔐
• --token="" — bearer token for authentication to the API server. your token goes here. 🎟️
• --user="" — the name of the kubeconfig user to use. pick which user from your kubeconfig. 👤
• --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code. if true, warnings become errors and the command exits non-zero. default is false. 🚨

---

🌟 EXAMPLE 🌟

okay so here are the iconic examples. i'm going to put them in code blocks so you can see exactly what's going on. no cap, these are literally the best examples. 💅

listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod:

# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
oc port-forward pod/mypod 5000 6000

listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment:

# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment
oc port-forward deployment/mydeployment 5000 6000

listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service:

# Listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service
oc port-forward service/myservice 8443:https

listen on port 8888 locally, forwarding to 5000 in the pod:

# Listen on port 8888 locally, forwarding to 5000 in the pod
oc port-forward pod/mypod 8888:5000

listen on port 8888 on all addresses, forwarding to 5000 in the pod:

# Listen on port 8888 on all addresses, forwarding to 5000 in the pod
oc port-forward --address 0.0.0.0 pod/mypod 8888:5000

listen on port 8888 on localhost and selected IP, forwarding to 5000 in the pod:

# Listen on port 8888 on localhost and selected IP, forwarding to 5000 in the pod
oc port-forward --address localhost,10.19.21.23 pod/mypod 8888:5000

listen on a random port locally, forwarding to 5000 in the pod:

# Listen on a random port locally, forwarding to 5000 in the pod
oc port-forward pod/mypod :5000

---

👀 SEE ALSO 👀

• oc(1), — that's it, bestie. go read the main character's page. 👑

---

📜 HISTORY 📜

June 2016, Ported from the Kubernetes man-doc generator. so this page has been serving looks since 2016. iconic. 💅

---

this slay page was brought to you by Openshift and the Openshift CLI User Manuals, dated June 2016. periodt. 💖