KUBERNETES(1)(kubernetes)

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

πŸ’– KUBERNETES(1) β€” the kubectl events page, bestie edition πŸ’–

okay so we're in the kubernetes manual, section 1, and today's main character is kubectl events. Eric Paris started this whole thing back in Jan 2015 and honestly? legend behavior. anyway, sit down, grab a boba, let's get you fluent in events πŸ§‹βœ¨


✨ NAME ✨

kubectl events β€” List events πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

kubectl events [OPTIONS]

🌸 DESCRIPTION 🌸

Display events. That's the whole vibe.

It prints a table of the most important information about events. You can request events for a namespace, for all namespaces, or filter down to only the ones pertaining to a specified resource. choose your own adventure, bestie πŸŽ€


πŸ’… OPTIONS πŸ’…

  • -A, --all-namespaces=false β€” If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. it said what it said, the context namespace gets ghosted πŸ’€
  • --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. missing key? we simply do not perceive it πŸ™ˆ
  • --chunk-size=500 β€” Return large lists in chunks rather than all at once. Pass 0 to disable. big list energy handled in bite-size pieces πŸ“
  • --for="" β€” Filter events to only those pertaining to the specified resource. like a search bar but for one specific thing 🎯
  • --no-headers=false β€” When using the default output format, don't print headers. headers are cancelled 🚫
  • -o, --output="" β€” Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). pick your aesthetic ✨
  • --show-managed-fields=false β€” If true, keep the managedFields when printing objects in JSON or YAML format. keep the receipts, periodt 🧾
  • --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]. diy your own output, crafty queen πŸ‘‘
  • --types=[] β€” Output only events of given types. filter by type, iconic 🌈
  • -w, --watch=false β€” After listing the requested events, watch for more events. it literally never stops watching and neither do we πŸ‘€

πŸ”₯ OPTIONS INHERITED FROM PARENT COMMANDS πŸ”₯

these came with the family, we don't question it, we just respect them 🫢

  • --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
  • --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
  • --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
ngl bestie, a couple of these are giving "security who?" β€” --insecure-skip-tls-verify=false means the server's certificate is not checked for validity and your HTTPS connections become insecure if you flip it. use with intention, not on autopilot πŸ’€

πŸŽ€ EXAMPLE πŸŽ€

copy-paste these, they're pre-approved πŸ’–

# List recent events in the default namespace
kubectl events

# List recent events in all namespaces
kubectl events --all-namespaces

# List recent events for the specified pod, then wait for more events and list them as they arrive
kubectl events --for pod/web-pod-13je7 --watch

# List recent events in YAML format
kubectl events -oyaml

# List recent only events of type 'Warning' or 'Normal'
kubectl events --types=Warning,Normal

🧚 SEE ALSO 🧚


πŸ“œ 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! shoutout to Eric, the original main character, and to the autogenerator that has been carrying ever since 🌟


and that's the whole page bestie, you ate that πŸ’…βœ¨ this was the kubernetes manual, section 1 β€” page KUBERNETES(1)(kubernetes) β€” brought to you by the Manuals collection for User kind of people, dated Jan 2015 up top with a User footer situation, and honestly it's giving timeless. go list some events, you're doing amazing sweetie πŸ«ΆπŸŽ€πŸ’–

πŸ“¦ where this page comes from