OC-ADM-GROUPS-SYNC(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

💅 oc adm groups sync — like, the whole manual but make it make sense

Hey bestie 🫶 so you found oc adm groups sync in the OpenShift CLI User Manuals section of the man pages (June 2016 vintage, we love a legacy icon 👑). Buckle up, because this one's actually iconic once you get the vibe.

✨ NAME ✨

oc adm groups sync — syncs your OpenShift groups with records from an external provider. That's it. That's the whole thing. Periodt 💅

🌸 SYNOPSIS 🌸

oc adm groups sync [OPTIONS]

🦋 DESCRIPTION 🦋

Okay so here's the tea ☕ — this command syncs OpenShift groups with records from an external provider.

To actually do that, you gotta figure out two things first: which groups you wanna sync, and where their records live. And like, no cap, there are options:

  • all or some groups could be picked from the current groups stored in OpenShift that have been synced previously, or
  • similarly, all or some groups could be picked from those stored on an LDAP server.

Either way, you need the path to a sync configuration file — that's what describes how data gets requested from the external record store and migrated into OpenShift records. Required. Non-negotiable. 💀

⚠️ Default behavior is a dry-run — nothing in OpenShift gets changed. Passing --confirm is what actually syncs all groups from the LDAP server returned by the LDAP query templates. So yeah, dry-run first, main character energy later. 😌

🎀 OPTIONS 🎀

  • --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, iykyk.
  • --blacklist="" — path to the group blacklist file 🚫
  • --confirm=false — if true, modify OpenShift groups; if false, display results of a dry-run. This is the flag, bestie.
  • -o, --output="yaml" — Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
  • --show-managed-fields=false — If true, keep the managedFields when printing objects in JSON or YAML format.
  • --sync-config="" — path to the sync config 📄
  • --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].
  • --type="ldap" — which groups white- and blacklist entries refer to: ldap, openshift
  • --whitelist="" — path to the group whitelist file ✅

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

These are the ones you get for free from the parent command, no extra charge, slay:

  • --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. (Yes, that path is really what it says. Iconicly unhinged. 🙈)
  • --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 — like, actually, be careful with this one 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 🌈

Honestly the examples are the moment, look at these 🫶

# Sync all groups with an LDAP server
oc adm groups sync --sync-config=/path/to/ldap-sync-config.yaml --confirm

# Sync all groups except the ones from the blacklist file with an LDAP server
oc adm groups sync --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm

# Sync specific groups specified in an allowlist file with an LDAP server
oc adm groups sync --whitelist=/path/to/allowlist.txt --sync-config=/path/to/sync-config.yaml --confirm

# Sync all OpenShift groups that have been synced previously with an LDAP server
oc adm groups sync --type=openshift --sync-config=/path/to/ldap-sync-config.yaml --confirm

# Sync specific OpenShift groups if they have been synced previously with an LDAP server
oc adm groups sync groups/group1 groups/group2 groups/group3 --sync-config=/path/to/sync-config.yaml --confirm

⭐ SEE ALSO ⭐

🧚 HISTORY 🧚

June 2016, Ported from the Kubernetes man-doc generator. A true elder of the ecosystem, we stan a historical figure 💖

Okay that's the whole page!! This beauty comes to you from Openshift, in the Openshift CLI User Manuals collection, dated June 2016 — go forth and sync responsibly, bestie 🦋✨🍓

📦 where this page comes from