OC-SET-ROUTE-BACKENDS(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

👑 oc set route-backends — a whole manual page, but make it a group chat ✨

okay so like. bestie. welcome to OC SET(1) 💅 this is the manual page for one specific little corner of oc set, and honestly? it's giving niche but powerful. we're talking route backends today, and you're gonna slay this i promise 🫶

🌸 NAME 🌸

oc set route-backends — update the backends for a route. that's it. that's the whole vibe. one command, one mission ✨

🦋 SYNOPSIS 🦋

oc set route-backends [OPTIONS]

literally just the command and then a pile of options, as one does 💖

🎀 DESCRIPTION 🎀

okay so real talk — this command sets and adjusts route backends. no cap.

Routes can have one or more optional backend services, and each one gets a weight that controls how much traffic flows to it. here's the tea: traffic is assigned proportional to the combined weights of each backend. so the math is mathing across all of them together 🧮✨

  • A weight of zero means that backend gets no traffic. ghosted. 💀
  • And if all the weights are zero? the route straight up won't send traffic to any backends. zero backends receiving love. tragic but true 😭

🧚 primary vs alternate — the friend group dynamics 🧚

when you're setting backends, the first backend is the primary and the other backends are considered alternates. main character energy for that first one, lowkey 💅

like, for example:

$ oc set route-backends web prod=99 canary=1

this sets the primary backend to service "prod" with a weight of 99, and the first alternate backend to service "canary" with a weight of 1. and that means 99%% of traffic goes to service "prod". prod is thriving, canary is the side character for now 🍓

🦋 the --adjust flag is where it gets spicy 🦋

--adjust lets you alter the weight of an individual service relative to itself or to the primary backend.

specifying a percentage will adjust the backend relative to either the primary or the first alternate (that second one's for when you specify the primary). and if there are other backends hanging around? their weights will be kept proportional to the changed one. everyone stays in ratio, no one gets left behind 🫶✨

⚠️ heads up bestie — not all routers may support multiple or weighted backends. so like. vibe check your router first, fr fr 🙈

✨ OPTIONS ✨

  • --adjust=false — adjust a single backend using an absolute or relative weight. oh and heads up: if the primary backend is selected and there's more than one alternate, an error will be returned. sorry bestie 💀
  • --all=false — if true, select all resources in the namespace of the specified resource types. all of them. every single one 👑
  • --allow-missing-template-keys=true — if true, ignore any errors in templates when a field or map key is missing in the template. only applies to golang and jsonpath output formats. very forgiving, love that for you 🌸
  • --dry-run="none" — must be "none", "server", or "client". if client strategy, only print the object that would be sent, without sending it. if server strategy, submit server-side request without persisting the resource. it's giving "look but don't touch" ✨
  • --equal=false — if true, set the weight of all backends to 100. equality! fairness! everyone gets 100! 🎀
  • --field-manager="kubectl-set" — name of the manager used to track field ownership. gotta know who owns what, iykyk 💅
  • -f, --filename=[] — filename, directory, or URL to files to use to edit the resource. yes you can pass a URL, iconic behavior 🌈
  • -k, --kustomize="" — process the kustomization directory. and no cap: this flag can't be used together with -f or -R. they do not coexist. pick a lane bestie 😤
  • --local=false — if true, set image will NOT contact api-server but run locally. offline era 💅
  • -o, --output="" — output format. one of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). so many choices, all valid, all slay 🌟
  • -R, --recursive=false — process the directory used in -f, --filename recursively. useful when you want to manage related manifests organized within the same directory. deeply organized, we stan 🧚
  • -l, --selector="" — selector (label query) to filter on. filter it out, keep it cute 🎀
  • --show-managed-fields=false — if true, keep the managedFields when printing objects in JSON or YAML format. transparency icon 👑
  • --template="" — template string or path to template file to use when -o=go-template, -o=go-template-file. the template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. fancy fancy 💖
  • --zero=false — if true, set the weight of all backends to zero. everyone to zero. total silence. dramatic but valid 💀

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these aren't even this command's own flags, they're inherited like hand-me-downs from the parent command, and honestly? they're still iconic 🫶

  • --as="" — username to impersonate for the operation. user could be a regular user or a service account in a namespace. be anyone you wanna be ✨
  • --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, UID specifically 💅
  • --as-user-extra=[] — user extras to impersonate for the operation. this flag can be repeated to specify multiple values for the same key. repeat repeat repeat 🔁
  • --cache-dir="/homeless-shelter/.kube/cache" — default cache directory. yes that's the actual path, no i'm not joking 😭
  • --certificate-authority="" — path to a cert file for the certificate authority. trust but verify fr fr 🎀
  • --client-certificate="" — path to a client certificate file for TLS. secure queen 🔒
  • --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 cluster bestie 🌈
  • --context="" — the name of the kubeconfig context to use. context is everything, literally 💅
  • --disable-compression=false — if true, opt-out of response compression for all requests to the server. uncompressed and unbothered ✨
  • --insecure-skip-tls-verify=false — if true, the server's certificate will not be checked for validity. this will make your HTTPS connections insecure ⚠️ bestie please be careful with this one 😭
  • --kubeconfig="" — path to the kubeconfig file to use for CLI requests. know where your 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. feature gate lore 💀
  • --match-server-version=false — require server version to match client version. matching outfits only 👯
  • -n, --namespace="" — if present, the namespace scope for this CLI request. namespace matters 🎀
  • --profile="none" — name of profile to capture. one of (none|cpu|heap|goroutine|threadcreate|block|mutex). so many profiles, so little time ⭐
  • --profile-output="profile.pprof" — name of the file to write the profile to. profile.pprof is the default, love that for it 💖
  • --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. patience is a virtue 🕰️
  • -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. defaults gonna default 🌸
  • --token="" — bearer token for authentication to the API server. your VIP pass 🎟️
  • --user="" — the name of the kubeconfig user to use. know your user 👑
  • --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code. strict mode activated 😤

🔥 EXAMPLE 🔥

okay these examples are genuinely so useful, let's go through them one by one 💅

oc set route-backends web

just looking. observing. no changes. vibe check only 👀

set two backend services on route 'web' with 2/3rds of traffic going to 'a'

oc set route-backends web a=2 b=1

a gets 2, b gets 1, so a gets two-thirds of the traffic. math slay 🔥

increase the traffic percentage going to b by 10%% relative to a

oc set route-backends web --adjust b=+10%%

note the + — that's relative adjustment, bestie. adding on top 🎀

set traffic percentage going to b to 10%% of the traffic going to a

oc set route-backends web --adjust b=10%%

no + this time, so it's setting it to 10%% of a's traffic. subtle difference, big impact ✨

set weight of b to 10

oc set route-backends web --adjust b=10

no percent sign, so it's an absolute weight of 10. simple. clean. iconic 🌸

set the weight to all backends to zero

oc set route-backends web --zero

everyone to zero. the great silencing. dramatic but sometimes you need it 💀

🌈 SEE ALSO 🌈

  • oc-set(1) — go read the parent page, it's the whole family 🫶

🎀 a lil sign-off 🎀

okay that's the whole page bestie, you made it to the end, i'm so proud 🥹💖 this was ported from the Kubernetes man-doc generator back in June 2016, and it lives in the Openshift CLI User Manuals — so like, vintage but still serving looks 👑✨ go forth and route your backends, you've got this, periodt 💅🌸

📦 where this page comes from