OC(1)

πŸ“¦
version 4.22.0 Β· 2 versions
, in nixpkgs unstable

✨ OC(1) β€” the oc plugin page, but make it a group chat ✨

okay so bestie, you found the OC(1) manual page for oc plugin. It’s giving β€œutilities for interacting with plugins,” and we’re about to go through every single inherited flag together. πŸ’…

🌸 NAME 🌸

oc plugin β€” provides utilities for interacting with plugins. That’s the whole name, and honestly it ate. ✨

πŸ¦‹ SYNOPSIS πŸ¦‹

oc plugin [OPTIONS]

πŸŽ€ DESCRIPTION πŸŽ€

Plugins are the moment when you want extended functionality that is not part of the major command-line distribution. It’s giving extra, on purpose. πŸ’–

Wanna write your own plugins? The documentation and examples have more information about how to write your own plugins. Go read them, iykyk. 🫢

The easiest way to discover and install plugins is via the kubernetes sub-project krew: [krew.sigs.k8s.io]. To install krew, visit ⟨https://krew.sigs.k8s.io/docs/user-guide/setup/install⟩. 🌈

πŸ’… OPTIONS INHERITED FROM PARENT COMMANDS πŸ’…

These are inherited from the parent commands, but they still matter for this page. Every default is right here, no cap. πŸ‘‘

  • --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. 🚨 no cap, that’s the warning 🚨
  • --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 🌟

Try these on for size, bestie:

# List all available plugins
oc plugin list

# List only binary names of available plugins without paths
oc plugin list --name-only

πŸ‘€ SEE ALSO πŸ‘€

Go say hi to oc(1) and oc-plugin-list(1). πŸ’–

πŸ•°οΈ HISTORY πŸ•°οΈ

June 2016, Ported from the Kubernetes man-doc generator. That’s the lore. 🫢

mwah πŸ’‹ β€” from Openshift, the Openshift CLI User Manuals, and your fave OC(1) page, dated June 2016. πŸŽ€

πŸ“¦ where this page comes from