OC-ADM-PRUNE-GROUPS(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

💅 oc adm prune groups — OC ADM PRUNE(1)

okay so bestie, welcome to OC ADM PRUNE(1) — the June 2016 edition of your new fave cleanup era. this one's about yeeting old OpenShift groups that are referencing records which literally do not exist anymore in an external provider. very "blocked and reported but for group entries" energy. 🧹✨

✨ NAME ✨

oc adm prune groups — Remove old OpenShift groups referencing missing records from an external provider

🎀 SYNOPSIS 🎀

oc adm prune groups [OPTIONS]

🦋 DESCRIPTION 🦋

Prune OpenShift groups referencing missing records from an external provider. periodt.

so here's the vibe check: to prune OpenShift group records using the ones from an external provider, first figure out which groups you wanna prune. for instance, all or some groups may be selected from the current groups stored in OpenShift that have been synced previously. any combination of a literal whitelist, a whitelist file and a blacklist file is supported — mix and match, go off 👑

the path to a sync configuration file that was used for syncing the groups in question is required, because that's how it describes how data is requested from the external record store. no config, no clue, no cap.

default behavior is to just indicate all OpenShift groups for which the external record does not exist — like, it shows you the receipts but doesn't touch anything. to actually run the pruning process and commit the results, use the --confirm flag. that's the main character moment right there 🔥

🌸 OPTIONS 🌸

  • --blacklist="" — path to the group blacklist file
  • --confirm=false — if true, modify OpenShift groups; if false, display groups (this is your "are you sure bestie" switch 💀)
  • --sync-config="" — path to the sync config
  • --whitelist="" — path to the group whitelist file

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

yes there's a whole inheritance situation, the parent command's flags just show up like they pay rent here. all of them, in order, no skips:

  • --as="" — Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
  • --as-group=[] — Group to impersonate for the operation, 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
  • --certificate-authority="" — Path to a cert file for the certificate authority
  • --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
  • --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
🫶 quick reminder that --insecure-skip-tls-verify is literally telling your client "don't check the cert, it's fine" — which makes your HTTPS connections insecure. iconic for testing, not it for production, iykyk.

⭐ EXAMPLE ⭐

the examples are giving tutorial energy and we ate, so here they are verbatim:

# Prune all orphaned groups
oc adm prune groups --sync-config=/path/to/ldap-sync-config.yaml --confirm

# Prune all orphaned groups except the ones from the denylist file
oc adm prune groups --blacklist=/path/to/denylist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm

# Prune all orphaned groups from a list of specific groups specified in an allowlist file
oc adm prune groups --whitelist=/path/to/allowlist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm

# Prune all orphaned groups from a list of specific groups specified in a list
oc adm prune groups groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm

💜 SEE ALSO 💜

🍓 HISTORY 🍓

June 2016, Ported from the Kubernetes man-doc generator

and that's the whole page, bestie 🎀 so much love to the Openshift girlies and the Openshift CLI User Manuals — this one lives under OC ADM PRUNE(1), dated June 2016. go prune responsibly, don't forget your --confirm 💅🦋

📦 where this page comes from