KUBERNETES(1)(kubernetes)

πŸ“¦
version 1.37.2 Β· 2 versions
, in arch rolling, fedora 43, fedora 44, nixpkgs unstable

✨ KUBERNETES(1)(kubernetes) β€” aka the kubectl kuberc set page, bestie edition ✨

okay so like, you opened the manual for kubectl kuberc set and honestly? you're about to have a great time. this is from the kubernetes manual, section 1, and we're gonna walk through it together like it's a group chat at 2am. grab a boba πŸ§‹, let's go.


🌸 NAME 🌸

kubectl kuberc set β€” Set values in the kuberc configuration. that's the whole job. it sets values. in the kuberc config. slay. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

kubectl kuberc set [OPTIONS]

no positional args, no drama. just options. periodt.


πŸ’– DESCRIPTION πŸ’–

Set values in the kuberc configuration file. that's the vibe. you're writing values into the kuberc file, and it's gonna hold them for you. 🫢

use --section to specify whether you're setting defaults or aliases. those are the two flavors (there's also a third section value, more on that in OPTIONS, don't worry).

for defaults: it sets default flag values for kubectl commands. the --command flag should specify only the command β€” like "get", "create", "set env" β€” and not resources. resources do NOT go here, bestie, i'm serious. 🚫

for aliases: it creates command aliases with optional default flag values and arguments. use --prependarg and --appendarg to include resources or other arguments. that's how you sneak the resources in. iykyk. πŸ‘‘


✨ OPTIONS ✨

  • --allowlist-entry=[] β€” allowlist entry, in the form field=value. can be specified multiple times, so go off. 🌈
  • --appendarg=[] β€” argument to append to the command. can be specified multiple times, and it's for aliases only. πŸŽ€
  • --command="" β€” command to configure (e.g., 'get', 'create', 'set env'). just the command, remember? no resources. πŸ’€
  • --kuberc="" β€” path to the kuberc file to use for preferences. this can be disabled by exporting the KUBECTL_KUBERC=false feature gate, or by turning off the feature with KUBERC=off. two ways to shut it down, pick your fighter. πŸ₯Š
  • --name="" β€” alias name (required for --section=aliases, so don't skip it or you'll be sad 😭).
  • --option=[] β€” flag option in the form flag=value. can be specified multiple times. stack 'em. 🧚
  • --overwrite=false β€” allow overwriting existing entries. default is false, so it will NOT overwrite unless you say so. πŸ›‘
  • --policy="" β€” plugin policy to use for exec credential plugins. must be one of 'AllowAll', 'DenyAll' or 'Allowlist'. those are the only three, no freestyling. βœ‹
  • --prependarg=[] β€” argument to prepend to the command. can be specified multiple times, and it's for aliases only. 🌸
  • --section="" β€” section to modify: 'defaults', 'aliases', or 'credentialplugin'. the main character flag, honestly. πŸ‘‘

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these came from the parent command, they're not new here, they're just... visiting. still important though. 🫢

  • --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="/home/username/.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, so like... be so careful, bestie. πŸ™ˆ
  • --kubeconfig="" β€” path to the kubeconfig file to use for CLI requests.
  • --match-server-version=false β€” require server version to match client version.
  • -n, --namespace="" β€” if present, the namespace scope for this CLI request.
  • --password="" β€” password for basic authentication to the API server.
  • --profile="none" β€” name of profile to capture. one of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace).
  • --profile-output="profile.pprof" β€” name of the file to write the profile to.
  • --proxy-url="" β€” proxy URL to use for requests to the API server.
  • --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.
  • --username="" β€” username for basic authentication to the API server.
  • --version=false β€” --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version.
  • --warnings-as-errors=false β€” treat warnings received from the server as errors and exit with a non-zero exit code. spicy. 🌢️

πŸŽ€ EXAMPLE πŸŽ€

here's where it gets fun. copy these, they're exact:

# Set default output format for 'get' command
kubectl kuberc set --section defaults --command get --option output=wide

# Set default output format for a subcommand
kubectl kuberc set --section defaults --command "set env" --option output=yaml

# Create an alias 'getn' for 'get' command with prepended 'nodes' resource
kubectl kuberc set --section aliases --name getn --command get --prependarg nodes --option output=wide

# Create an alias 'runx' for 'run' command with appended arguments
kubectl kuberc set --section aliases --name runx --command run --option image=nginx --appendarg "--" --appendarg custom-arg1

# Overwrite an existing default
kubectl kuberc set --section defaults --command get --option output=json --overwrite

# Set the credential plugin policy and allowlist
kubectl kuberc set --section credentialplugin --policy Allowlist --allowlist-entry command=cloud-credential-helper

see how --prependarg nodes slides the resource in at the front and --appendarg tacks stuff on the end? and how you need --overwrite to, well, overwrite? the way that all makes sense. πŸ”₯


🫢 SEE ALSO 🫢

go read that one too, bestie. πŸ’œ


πŸ“œ HISTORY πŸ“œ

January 2015, originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material β€” but hopefully they have been automatically generated since! 😭 iconic honestly.


and that's the whole page, no cap. πŸ’– big kisses to the Manuals / User crew and to KUBERNETES(1)(kubernetes) itself, dated Jan 2015 β€” this manual was brought to you by Eric Paris and the letter K. bye bestie, go set some defaults! πŸ¦‹βœ¨πŸ’…

πŸ“¦ where this page comes from