OC(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

🌸 OC(1) — the oc idle glow-up 🌸

okay bestie, so this is the manual for oc idle, which is part of the OpenShift CLI user manuals, and it's giving "let's put your scalable resources to sleep so they can wake up later when someone actually needs them." lowkey iconic. it's from June 2016 and was ported from the Kubernetes man-doc generator, so it's got history, periodt. 🫶

✨ NAME ✨

oc idle — idle scalable resources. literally just letting your stuff chill until traffic shows up. 💤

🦋 SYNOPSIS 🦋

oc idle [OPTIONS]

🎀 DESCRIPTION 🎀

Okay so here's the tea: oc idle idles scalable resources. simple as that. 💅

Idling works by discovering the scalable resources (think deployment configs and replication controllers) that are associated with a series of services. it does this by examining the endpoints of the service — yes, it's doing detective work, main character energy. 🔍

Each service is then marked as idled, the associated resources are recorded, and the resources are scaled down to zero replicas. zero. nada. they're napping. 😴

But here's the cute part: upon receiving network traffic, the services (and any associated routes) will "wake up" the associated resources by scaling them back up to their previous scale. it's giving sleepover and then everyone wakes up for breakfast. 🌈✨

💖 OPTIONS 💖

  • --all=false — if true, select all services in the namespace. like, all of them. every single one. no cap. 👑
  • -A, --all-namespaces=false — if true, select services across all namespaces. not just your little corner of the cluster, bestie. 🌍
  • --dry-run=false — If true, only print the annotations that would be written, without annotating or idling the relevant objects. it's a preview era. nothing actually happens. 🙈
  • --resource-names-file="" — file containing list of services whose scalable resources to idle. yes, a whole file. organized queen behavior. 📄
  • -l, --selector="" — Selector (label query) to use to select services. use your labels to pick the chosen ones. 🎯

🌟 OPTIONS INHERITED FROM PARENT COMMANDS 🌟

these are the flags that come from the parent command, and they're lowkey important, so don't skip them. fr fr.

  • --as="" — Username to impersonate for the operation. User could be a regular user or a service account in a namespace. basically cosplay, but for auth. 🎭
  • --as-group=[] — Group to impersonate for the operation, this flag can be repeated to specify multiple groups. stack 'em up. 🫶
  • --as-uid="" — UID to impersonate for the operation. yes, you can pick the UID too. 💅
  • --as-user-extra=[] — User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. extra extra, read all about it. 📰
  • --cache-dir="/homeless-shelter/.kube/cache" — Default cache directory. that path is literally what it is. don't @ me. 🗂️
  • --certificate-authority="" — Path to a cert file for the certificate authority. trust issues? solved. 🔐
  • --client-certificate="" — Path to a client certificate file for TLS. it's giving secure. 🛡️
  • --client-key="" — Path to a client key file for TLS. keep it secret, keep it safe. 🤫
  • --cluster="" — The name of the kubeconfig cluster to use. pick your cluster, bestie. ☁️
  • --context="" — The name of the kubeconfig context to use. context is everything. 💁‍♀️
  • --disable-compression=false — If true, opt-out of response compression for all requests to the server. no compression, no problem. 📦
  • --insecure-skip-tls-verify=false — If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. ⚠️ okay so this one is a big yikes — it literally makes your HTTPS insecure. use with caution, bestie. 🚨
  • --kubeconfig="" — Path to the kubeconfig file to use for CLI requests. your config, your rules. 📁
  • --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. preferences era. ⚙️
  • --match-server-version=false — Require server version to match client version. matchy matchy. 🧦
  • -n, --namespace="" — If present, the namespace scope for this CLI request. stay in your lane, but make it a namespace. 🚧
  • --profile="none" — Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex). pick your profile, queen. 📊
  • --profile-output="profile.pprof" — Name of the file to write the profile to. default is literally profile.pprof. 💾
  • --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. zero = patience of a saint. ⏳
  • -s, --server="" — The address and port of the Kubernetes API server. where the magic happens. 🌐
  • --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. it's giving "we'll figure it out." 🤷‍♀️
  • --token="" — Bearer token for authentication to the API server. your 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. no warnings allowed, only drama. 💀

🔥 EXAMPLE 🔥

# Idle the scalable controllers associated with the services listed in to-idle.txt
$ oc idle --resource-names-file to-idle.txt

see? simple. put your service names in a file, run the command, and let the idling begin. ✨

👀 SEE ALSO 👀

oc(1), — go check out the main character, oc. 👑

📜 HISTORY 📜

June 2016, Ported from the Kubernetes man-doc generator. a classic. 🧚

Openshift CLI User Manuals — and that's the vibe. this page is from Openshift, dated June 2016, and it's all about OC(1). slay. 💅✨

📦 where this page comes from