OC(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

OC(1) 💅✨ — Extract Secrets or Config Maps to Disk (bestie edition)

okay so you want to pull secrets and config maps out of your cluster and onto your disk? say less, bestie. this is literally the command for that. oc extract is the main character here, and it's about to make your life so much easier. periodt.

NAME 💖

oc extract — extract secrets or config maps to disk. that's it. that's the vibe. 🎀

SYNOPSIS ✨

oc extract [OPTIONS]

DESCRIPTION 🌸

okay so picture this: you've got a config map or a secret sitting in your cluster, and you're like "bestie, i need those files locally." that's literally what oc extract does. it downloads the contents of a config map or secret into a directory, and each key in that config map or secret becomes its own separate file — with the name of the key as the filename. it's exactly the same way it works when you mount a secret or config map into a container. no cap. 🫶

you can also extract the contents to standard out by passing - to the --to option. and when you do that? the names of each key get written to standard error, so you can still see what's what. it's giving "best of both worlds." 😭

want to be picky about which keys you pull? easy. limit which keys are extracted with the --keys=NAME flag. and if you want to choose where everything lands, just set the directory with --to=DIRECTORY. slay. 💅

OPTIONS 🔥

  • --confirm=false — if you set this to true, it'll overwrite files that already exist. lowkey important if you don't want to be surprised. 👑
  • -f, --filename=[] — filename, directory, or URL to a file that identifies the resource you want to extract. it's like a little pointer saying "hey, this one!" 🎀
  • --keys=[] — an optional list of keys to extract. default is all keys. so if you're like "just the nginx.conf please," this is your flag. ✨
  • --to="." — directory to extract files to. the default is . which means "right here, bestie." 🌸

OPTIONS INHERITED FROM PARENT COMMANDS 💜

these are the flags you get from the parent command, and honestly? there are a lot of them. but we're not skipping any. we would never. 💅

  • --as="" — username to impersonate for the operation. user could be a regular user or a service account in a namespace. it's giving "identity crisis but make it kubernetes." 🙈
  • --as-group=[] — group to impersonate for the operation. this flag can be repeated to specify multiple groups. so you can be in multiple groups at once. iconic. 👑
  • --as-uid="" — UID to impersonate for the operation. yes, you can be a whole different UID. main character energy. 🌟
  • --as-user-extra=[] — user extras to impersonate for the operation. this flag can be repeated to specify multiple values for the same key. fancy. 🎀
  • --cache-dir="/homeless-shelter/.kube/cache" — default cache directory. that's the path. no cap. 🗂️
  • --certificate-authority="" — path to a cert file for the certificate authority. you know, for trust. 💖
  • --client-certificate="" — path to a client certificate file for TLS. secure vibes only. 🔒
  • --client-key="" — path to a client key file for TLS. the key to the kingdom. 🔑
  • --cluster="" — the name of the kubeconfig cluster to use. pick your fighter. ⚔️
  • --context="" — the name of the kubeconfig context to use. like choosing which universe you're in. 🌌
  • --disable-compression=false — if true, opt-out of response compression for all requests to the server. sometimes you just want it raw. 💀
  • --insecure-skip-tls-verify=false — if true, the server's certificate will not be checked for validity. bestie, this will make your HTTPS connections insecure. so maybe don't unless you know what you're doing. ⚠️
seriously, that one's a little risky. proceed with caution, okay? 🫶
  • --kubeconfig="" — path to the kubeconfig file to use for CLI requests. where your cluster config lives. 🏠
  • --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. if you're picky about versions, this is your flag. 🎯
  • -n, --namespace="" — if present, the namespace scope for this CLI request. where the magic happens. 🌈
  • --profile="none" — name of profile to capture. one of (none|cpu|heap|goroutine|threadcreate|block|mutex). yes, those are the exact options. pick your poison. 🔬
  • --profile-output="profile.pprof" — name of the file to write the profile to. default is profile.pprof. cute. 📁
  • --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 is literally "wait forever." 😴
  • -s, --server="" — the address and port of the Kubernetes API server. where you're connecting to. 🌐
  • --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. default behavior is fine, but you can override. ✨
  • --token="" — bearer token for authentication to the API server. like a VIP pass. 🎟️
  • --user="" — the name of the kubeconfig user to use. who are you today? 💁‍♀️
  • --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code. if you're dramatic and want warnings to be full-on errors, this is it. 💀

EXAMPLE 🌟

here's how you'd actually use it, bestie. these are the exact examples from the original, so you know they're legit:

# Extract the secret "test" to the current directory
oc extract secret/test

# Extract the config map "nginx" to the /tmp directory
oc extract configmap/nginx --to=/tmp

# Extract the config map "nginx" to STDOUT
oc extract configmap/nginx --to=-

# Extract only the key "nginx.conf" from config map "nginx" to the /tmp directory
oc extract configmap/nginx --to=/tmp --keys=nginx.conf

see? literally that easy. you got this. 💅

SEE ALSO 👀

check out oc(1) for more. that's the parent command, and it's also iconic. 🌈

HISTORY 📜

june 2016, ported from the Kubernetes man-doc generator. so it's been around for a minute, but it's still relevant. periodt. 💖

this page is from Openshift, part of the Openshift CLI User Manuals, and it was last updated in June 2016. slay. 🎀✨

📦 where this page comes from