OC-CONFIG-SET-CREDENTIALS(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

💅 oc config set-credentials — a.k.a. the oc config glow-up page (manual name: OC CONFIG(1)) 🎀

okay so real talk, bestie — welcome to the page where you give a user entry in your kubeconfig its whole personality ✨ This one lives under oc config, and it's literally just about setting up users. Let's go 💖

✨ SYNOPSIS ✨

oc config set-credentials [OPTIONS]

🌸 DESCRIPTION 🌸

Set a user entry in kubeconfig. That's the whole vibe. 🫶

important bestie PSA: if you specify a name that already exists, it doesn't wipe anything — it merges the new fields on top of the existing values. lowkey the most respectful behaviour ever 💅

Here's the little menu of auth flavours you can hand it 👇

Client-certificate flags:
--client-certificate=certfile --client-key=keyfile

Bearer token flags:
--token=bearer_token

Basic auth flags:
--username=basic_user --password=basic_password

and the ✨ drama ✨ clause: bearer token and basic auth are mutually exclusive. pick a lane, girl. not both. 😭

🦋 OPTIONS 🦋

okay here's every single flag, no skips, no cuts, the full album 💿

  • --auth-provider="" — the auth provider for the user entry in kubeconfig
  • --auth-provider-arg=[] — 'key=value' arguments for the auth provider
  • --client-certificate="" — path to the client-certificate file for the user entry in kubeconfig
  • --client-key="" — path to the client-key file for the user entry in kubeconfig
  • --embed-certs=false — embed the client cert/key for the user entry in kubeconfig
  • --exec-api-version="" — API version of the exec credential plugin for the user entry in kubeconfig
  • --exec-arg=[] — new arguments for the exec credential plugin command for the user entry in kubeconfig
  • --exec-command="" — command for the exec credential plugin for the user entry in kubeconfig
  • --exec-env=[] — 'key=value' environment values for the exec credential plugin
  • --exec-interactive-mode="" — InteractiveMode of the exec credentials plugin for the user entry in kubeconfig
  • --exec-provide-cluster-info=false — ProvideClusterInfo of the exec credentials plugin for the user entry in kubeconfig
  • --password="" — password for the user entry in kubeconfig 🔐
  • --token="" — token for the user entry in kubeconfig 🎟️
  • --username="" — username for the user entry in kubeconfig 👤

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these aren't hers, they're handed down from the parent commands — nepo options, if you will 💀 still iconic though:

  • --as="" — username to impersonate for the operation. the user could be a regular user or a service account in a namespace. main character energy, honestly 🎭
  • --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
  • --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… genuinely. be so careful.
  • --kubeconfig="" — use a particular kubeconfig file
  • --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's not provided, the hostname used to contact the server is used
  • --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 🌈

this is the part where it eats, fr fr — every single one, copied exact, go off 👇

# Set only the "client-key" field on the "cluster-admin"
# entry, without touching other values
oc config set-credentials cluster-admin --client-key= /.kube/admin.key

# Set basic auth for the "cluster-admin" entry
oc config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif

# Embed client certificate data in the "cluster-admin" entry
oc config set-credentials cluster-admin --client-certificate= /.kube/admin.crt --embed-certs=true

# Enable the Google Compute Platform auth provider for the "cluster-admin" entry
oc config set-credentials cluster-admin --auth-provider=gcp

# Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional arguments
oc config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar

# Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry
oc config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-

# Enable new exec auth plugin for the "cluster-admin" entry
oc config set-credentials cluster-admin --exec-command=/path/to/the/executable --exec-api-version=client.authentication.k8s.io/v1beta1

# Enable new exec auth plugin for the "cluster-admin" entry with interactive mode
oc config set-credentials cluster-admin --exec-command=/path/to/the/executable --exec-api-version=client.authentication.k8s.io/v1beta1 --exec-interactive-mode=Never

# Define new exec auth plugin arguments for the "cluster-admin" entry
oc config set-credentials cluster-admin --exec-arg=arg1 --exec-arg=arg2

# Create or update exec auth plugin environment variables for the "cluster-admin" entry
oc config set-credentials cluster-admin --exec-env=key1=val1 --exec-env=key2=val2

# Remove exec auth plugin environment variables for the "cluster-admin" entry
oc config set-credentials cluster-admin --exec-env=var-to-remove-
🍓 little fyi bestie — that trailing-dash thing (--auth-provider-arg=client-secret- and --exec-env=var-to-remove-) is how you remove a value. the dash is doing the deleting. iykyk 💅

🧚 SEE ALSO 🧚

  • oc-config(1), — go read the parent page, she's the whole reason we're here 🫶

⭐ HISTORY ⭐

June 2016, Ported from the Kubernetes man-doc generator. vintage. antique. a classic 👑

and that's the page!! mwah 💖 huge thanks to Openshift for this one — it's from the Openshift CLI User Manuals, dated June 2016. now go set those credentials, you gorgeous genius 🎀✨🦋

📦 where this page comes from