OC-REGISTRY-LOGIN(1)

🎀 oc registry login 🎀

okay bestie, welcome to the OC REGISTRY(1) page from the oc CLI manual. We're logging in to the OpenShift integrated registry, and it's giving slay but also "please read the caveats." 💖

🌸 NAME 🌸

oc registry login — log in to the integrated registry. 💅

✨ SYNOPSIS ✨

oc registry login [OPTIONS]

🦋 DESCRIPTION 🦋

Okay so this command logs you in to the OpenShift integrated registry. It logs your local Docker client into that registry using the external registry name — if your administrator configured one. ✨

🚨 real talk: if you are logged in to the server using a client certificate, the command will report an error, because container registries do not generally allow client certificates. Not the vibe, but that's the rule. 😭

Advanced bestie move: you may specify the credentials to log in with using --auth-basic with USER:PASSWORD. iykyk. 🫶

You may specify an alternate file to write credentials to with --to instead of .docker/config.json in your home directory. Cute and customizable. 🎀

To detect the registry hostname, the client will attempt to find an image stream in the current namespace or the openshift namespace and use the status fields that indicate the registry hostnames. If no image stream is found, or if you do not have permission to view image streams, you will have to pass the --registry flag with the desired host name. That's the vibe check. 🦋

You may also pass the --registry flag to log in to the integrated registry but with a custom DNS name, or to an external registry. Note: in absence of --auth-basic=USER:PASSWORD, the authentication token from the connected kubeconfig file will be recorded as the auth entry in the credentials file (defaults to Docker config.json) for the passed registry value. Periodt. 👑

💅 OPTIONS 💅

• --auth-basic="" — provide credentials in the form 'user:password' to authenticate (advanced). It's the "I brought my own login" option. 🔥
• --insecure=false — bypass HTTPS certificate verification when checking the registry login. This is literally what it says, so don't act surprised. 💀
• --registry="" — an alternate domain name and port to use for the registry; defaults to the cluster's configured external hostname. 👑
• -a, --registry-config="" — the location of the file your credentials will be stored in. Alternatively the REGISTRY_AUTH_FILE env variable can be also specified. Defaults to ${XDG_RUNTIME_DIR}/containers/auth.json or /run/containers/${UID}/auth.json. The default can be changed via the REGISTRY_AUTH_PREFERENCE env variable (deprecated) to a "docker" value to prioritizes Docker credentials over Podman's. Yes, the manpage says "prioritizes," and we respect the sacred text. 🫶
• --skip-check=false — skip checking the credentials against the registry. Sometimes you just don't want the vibe check. 🙈
• --to="" — the location of the file your credentials will be stored in. Alternatively the REGISTRY_AUTH_FILE env variable can be also specified. Defaults to ${XDG_RUNTIME_DIR}/containers/auth.json or /run/containers/${UID}/auth.json. The default can be changed via the REGISTRY_AUTH_PREFERENCE env variable (deprecated) to a "docker" value to prioritizes Docker credentials over Podman's. Same energy as --registry-config, bestie. 💅

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

These are inherited from the parent command, so they're not new, they're just visiting. 🧚

• --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; 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 really says homeless-shelter. No cap. 💀
• --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. You have been warned, 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 the 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 🌈

# Log in to the integrated registry
oc registry login

# Log in to different registry using BASIC auth credentials
oc registry login --registry quay.io/myregistry --auth-basic=USER:PASS

🔗 SEE ALSO 🔗

oc-registry(1), — and that's it, bestie. The trailing comma is iconic, we keep it. 💖

📜 HISTORY 📜

June 2016, Ported from the Kubernetes man-doc generator. The lore is real. 🎀

---

k bye bestie 💖 — this whole thing is from Openshift and the Openshift CLI User Manuals, dated June 2016. Go log in and slay. ✨👑