OC-ADM-NODE-IMAGE-MONITOR(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

💅 OC ADM NODE-IMAGE(1) — your girl's guide to oc adm node-image monitor

okay bestie, this is from the OpenShift CLI User Manuals, and the page itself is dated June 2016 (yes, really, she's vintage ✨). buckle up, we're monitoring nodes 🎀

🌸 NAME 🌸

oc adm node-image monitor — literally just sitting there watching brand new nodes get added to an OpenShift cluster 👀 like a group chat read-receipt but for servers.

✨ SYNOPSIS ✨

oc adm node-image monitor [OPTIONS]

🦋 DESCRIPTION 🦋

So here's the vibe: you're monitoring nodes being added to a cluster using an image generated from the oc adm node-image create command. That's the whole job. Main character energy, but make it infrastructure 💅

Once the node image ISO has been booted on the host, the monitor command reports any pre-flight validations that may have failed — those are the little gremlins impeding the host from being added to the cluster 🙈 and if validations are successful? the node installation starts. slay.

Now, before a node joins the cluster and becomes fully functional, two certificate signing requests (CSRs) need to be approved 👑 the monitor command will display CSRs pending your approval, so like, pay attention, because you're the one who has to approve them.

The command ends when the nodes have successfully joined the cluster. periodt.

Also, lowkey important: the command creates a pod in a temporary namespace on the target cluster to monitor the nodes 🌈

And the command also requires a connection to the target cluster, plus valid registry credentials to retrieve the required information from the target cluster release. no credentials, no vibes 😭

💖 OPTIONS 💖

  • --certificate-authority="" — the path to a certificate authority bundle to use when communicating with the managed container image registries. and if --insecure is used, this flag will be ignored, so don't even worry about it 🫶
  • --insecure=false — allow push and pull operations to registries to be made over HTTP
  • --ip-addresses="" — IP addresses of nodes to monitor. this is the one you'll actually use, ngl 📍
  • -a, --registry-config="" — path to your registry credentials. alternatively the REGISTRY_AUTH_FILE env variable can be also specified. it defaults to ${XDG_RUNTIME_DIR}/containers/auth.json, /run/containers/${UID}/auth.json, ${XDG_CONFIG_HOME}/containers/auth.json, ${DOCKER_CONFIG}, /.docker/config.json, /.dockercfg. the order can be changed via the REGISTRY_AUTH_PREFERENCE env variable (deprecated) to a "docker" value to prioritizes Docker credentials over Podman's.
  • --skip-verification=false — skip verifying the integrity of the retrieved content. ⚠️ this is not recommended, but may be necessary when importing images from older image registries. only bypass verification if the registry is known to be trustworthy. like, fr fr, trust matters here 💀
okay so that "to prioritizes" is exactly how it's written in the original, don't come for me, I'm a faithful narrator 💀

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the ones she got from her parents, and honestly? iconic inheritance 🧚

  • --as="" — username to impersonate for the operation. the user could be a regular user or a service account in a namespace.
  • --as-group=[] — group to impersonate for the operation, and 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. yes that path is real. yes it's a whole mood 😭
  • --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 — so like, know what you're doing, bestie.
  • --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.
  • --match-server-version=false — require server version to match client version
  • -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 🕐
  • -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 😤

🍓 EXAMPLE 🍓

okay these are the exact examples, copied verbatim, do not touch 💜

# Monitor a single node being added to a cluster
oc adm node-image monitor --ip-addresses 192.168.111.83

# Monitor multiple nodes being added to a cluster by separating each
# IP address with a comma
oc adm node-image monitor --ip-addresses 192.168.111.83,192.168.111.84

like, the comma is doing so much heavy lifting there and she ate 🔥

👑 SEE ALSO 👑

(that trailing comma is canon, bestie, it's in the source 🌸)

⭐ HISTORY ⭐

June 2016, Ported from the Kubernetes man-doc generator 💫

so yeah, that's the whole page 🎀 go forth, monitor those nodes, approve those CSRs, and remember — you're the main character of this cluster 💅

Openshift — Openshift CLI User Manuals — OC ADM NODE-IMAGE(1) 🦋 and yes, that footer says Openshift twice-ish and June 2016, she's consistent, we love her 🫶

📦 where this page comes from