{"id":150,"date":"2022-10-19T17:57:07","date_gmt":"2022-10-19T17:57:07","guid":{"rendered":"https:\/\/merserver.com\/?p=150"},"modified":"2022-10-19T17:57:07","modified_gmt":"2022-10-19T17:57:07","slug":"kubectl-cheat-sheet","status":"publish","type":"post","link":"http:\/\/merserver.com\/index.php\/2022\/10\/19\/kubectl-cheat-sheet\/","title":{"rendered":"kubectl Cheat Sheet"},"content":{"rendered":"\n

This page contains a list of commonly used kubectl<\/code> commands and flags.<\/p>\n\n\n\n

Kubectl autocomplete<\/a><\/h2>\n\n\n\n

BASH<\/a><\/h3>\n\n\n\n
source <(kubectl completion bash) # setup autocomplete in bash into the current shell, bash-completion package should be installed first.<\/em>\necho \"source <(kubectl completion bash)\" >> ~\/.bashrc # add autocomplete permanently to your bash shell.<\/em>\n<\/code><\/pre>\n\n\n\n
You can also use a shorthand alias for kubectl<\/code> that also works with completion:<\/p>\n\n\n\n
alias k=kubectl\ncomplete -o default -F __start_kubectl k\n<\/code><\/pre>\n\n\n\n
ZSH<\/a><\/h3>\n\n\n\n
source <(kubectl completion zsh)  # setup autocomplete in zsh into the current shell<\/em>\necho '[[ $commands[kubectl] ]] && source <(kubectl completion zsh)' >> ~\/.zshrc # add autocomplete permanently to your zsh shell<\/em>\n<\/code><\/pre>\n\n\n\n
A Note on –all-namespaces<\/a><\/h3>\n\n\n\n
Appending --all-namespaces<\/code> happens frequently enough where you should be aware of the shorthand for --all-namespaces<\/code>:<\/p>\n\n\n\n
kubectl -A<\/code><\/p>\n\n\n\n
Kubectl context and configuration<\/a><\/h2>\n\n\n\n
Set which Kubernetes cluster kubectl<\/code> communicates with and modifies configuration information. See Authenticating Across Clusters with kubeconfig<\/a> documentation for detailed config file information.<\/p>\n\n\n\n
kubectl config view # Show Merged kubeconfig settings.<\/em>\n\n# use multiple kubeconfig files at the same time and view merged config<\/em>\nKUBECONFIG=~\/.kube\/config:~\/.kube\/kubconfig2\n\nkubectl config view\n\n# get the password for the e2e user<\/em>\nkubectl config view -o jsonpath='{.users[?(@.name == \"e2e\")].user.password}'\n\nkubectl config view -o jsonpath='{.users[].name}'    # display the first user<\/em>\nkubectl config view -o jsonpath='{.users[*].name}'   # get a list of users<\/em>\nkubectl config get-contexts                          # display list of contexts<\/em>\nkubectl config current-context                       # display the current-context<\/em>\nkubectl config use-context my-cluster-name           # set the default context to my-cluster-name<\/em>\n\nkubectl config set-cluster my-cluster-name           # set a cluster entry in the kubeconfig<\/em>\n\n# configure the URL to a proxy server to use for requests made by this client in the kubeconfig<\/em>\nkubectl config set-cluster my-cluster-name --proxy-url=my-proxy-url\n\n# add a new user to your kubeconf that supports basic auth<\/em>\nkubectl config set-credentials kubeuser\/foo.kubernetes.com --username=kubeuser --password=kubepassword\n\n# permanently save the namespace for all subsequent kubectl commands in that context.<\/em>\nkubectl config set-context --current --namespace=ggckad-s2\n\n# set a context utilizing a specific username and namespace.<\/em>\nkubectl config set-context gce --user=cluster-admin --namespace=foo \\\n<\/strong><\/strong>  && kubectl config use-context gce\n\nkubectl config unset users.foo                       # delete user foo<\/em>\n\n# short alias to set\/show context\/namespace (only works for bash and bash-compatible shells, current context to be set before using kn to set namespace) <\/em>\nalias kx='f() { [ \"$1\" ] && kubectl config use-context $1 || kubectl config current-context ; } ; f'\nalias kn='f() { [ \"$1\" ] && kubectl config set-context --current --namespace $1 || kubectl config view --minify | grep namespace | cut -d\" \" -f6 ; } ; f'\n<\/code><\/pre>\n\n\n\n
Kubectl apply<\/a><\/h2>\n\n\n\n
apply<\/code> manages applications through files defining Kubernetes resources. It creates and updates resources in a cluster through running kubectl apply<\/code>. This is the recommended way of managing Kubernetes applications on production. See Kubectl Book<\/a>.<\/p>\n\n\n\n
Creating objects<\/a><\/h2>\n\n\n\n
Kubernetes manifests can be defined in YAML or JSON. The file extension .yaml<\/code>, .yml<\/code>, and .json<\/code> can be used.<\/p>\n\n\n\n
kubectl apply -f .\/my-manifest.yaml            # create resource(s)<\/em>\nkubectl apply -f .\/my1.yaml -f .\/my2.yaml      # create from multiple files<\/em>\nkubectl apply -f .\/dir                         # create resource(s) in all manifest files in dir<\/em>\nkubectl apply -f https:\/\/git.io\/vPieo          # create resource(s) from url<\/em>\nkubectl create deployment nginx --image=nginx  # start a single instance of nginx<\/em>\n\n# create a Job which prints \"Hello World\"<\/em>\nkubectl create job hello --image=busybox:1.28 -- echo \"Hello World\"\n\n# create a CronJob that prints \"Hello World\" every minute<\/em>\nkubectl create cronjob hello --image=busybox:1.28   --schedule=\"*\/1 * * * *\" -- echo \"Hello World\"\n\nkubectl explain pods                           # get the documentation for pod manifests<\/em>\n\n# Create multiple YAML objects from stdin<\/em>\ncat <<EOF | kubectl apply -f -\napiVersion: v1\nkind: Pod\nmetadata:\n  name: busybox-sleep\nspec:\n  containers:\n  - name: busybox\n    image: busybox:1.28\n    args:\n    - sleep\n    - \"1000000\"\n---\napiVersion: v1\nkind: Pod\nmetadata:\n  name: busybox-sleep-less\nspec:\n  containers:\n  - name: busybox\n    image: busybox:1.28\n    args:\n    - sleep\n    - \"1000\"\nEOF\n\n# Create a secret with several keys<\/em>\ncat <<EOF | kubectl apply -f -\napiVersion: v1\nkind: Secret\nmetadata:\n  name: mysecret\ntype: Opaque\ndata:\n  password: $(echo -n \"s33msi4\" | base64 -w0)\n  username: $(echo -n \"jane\" | base64 -w0)\nEOF\n<\/code><\/pre>\n\n\n\n
Viewing, finding resources<\/a><\/h2>\n\n\n\n
# Get commands with basic output<\/em>\nkubectl get services                          # List all services in the namespace<\/em>\nkubectl get pods --all-namespaces             # List all pods in all namespaces<\/em>\nkubectl get pods -o wide                      # List all pods in the current namespace, with more details<\/em>\nkubectl get deployment my-dep                 # List a particular deployment<\/em>\nkubectl get pods                              # List all pods in the namespace<\/em>\nkubectl get pod my-pod -o yaml                # Get a pod's YAML<\/em>\n\n# Describe commands with verbose output<\/em>\nkubectl describe nodes my-node\nkubectl describe pods my-pod\n\n# List Services Sorted by Name<\/em>\nkubectl get services --sort-by=.metadata.name\n\n# List pods Sorted by Restart Count<\/em>\nkubectl get pods --sort-by='.status.containerStatuses[0].restartCount'\n\n# List PersistentVolumes sorted by capacity<\/em>\nkubectl get pv --sort-by=.spec.capacity.storage\n\n# Get the version label of all pods with label app=cassandra<\/em>\nkubectl get pods --selector=app=cassandra -o \\\n<\/strong><\/strong>  jsonpath='{.items[*].metadata.labels.version}'\n\n# Retrieve the value of a key with dots, e.g. 'ca.crt'<\/em>\nkubectl get configmap myconfig \\\n<\/strong><\/strong>  -o jsonpath='{.data.ca\\.crt}'\n\n# Retrieve a base64 encoded value with dashes instead of underscores.<\/em>\nkubectl get secret my-secret --template='{{index .data \"key-name-with-dashes\"}}'\n\n# Get all worker nodes (use a selector to exclude results that have a label<\/em>\n# named 'node-role.kubernetes.io\/control-plane')<\/em>\nkubectl get node --selector='!node-role.kubernetes.io\/control-plane'\n\n# Get all running pods in the namespace<\/em>\nkubectl get pods --field-selector=status.phase=Running\n\n# Get ExternalIPs of all nodes<\/em>\nkubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type==\"ExternalIP\")].address}'\n\n# List Names of Pods that belong to Particular RC<\/em>\n# \"jq\" command useful for transformations that are too complex for jsonpath, it can be found at https:\/\/stedolan.github.io\/jq\/<\/em>\nsel=${<\/strong>$(<\/strong>kubectl get rc my-rc --output=json | jq -j '.spec.selector | to_entries | .[] | \"\\(.key)=\\(.value),\"')<\/strong>%?}<\/strong>\necho $(<\/strong>kubectl get pods --selector=$sel --output=jsonpath={.items..metadata.name})<\/strong>\n\n# Show labels for all pods (or any other Kubernetes object that supports labelling)<\/em>\nkubectl get pods --show-labels\n\n# Check which nodes are ready<\/em>\nJSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}' \\\n<\/strong><\/strong> && kubectl get nodes -o jsonpath=\"$JSONPATH\" | grep \"Ready=True\"\n\n# Output decoded secrets without external tools<\/em>\nkubectl get secret my-secret -o go-template='{{range $k,$v := .data}}{{\"### \"}}{{$k}}{{\"\\n\"}}{{$v|base64decode}}{{\"\\n\\n\"}}{{end}}'\n\n# List all Secrets currently in use by a pod<\/em>\nkubectl get pods -o json | jq '.items[].spec.containers[].env[]?.valueFrom.secretKeyRef.name' | grep -v null | sort | uniq\n\n# List all containerIDs of initContainer of all pods<\/em>\n# Helpful when cleaning up stopped containers, while avoiding removal of initContainers.<\/em>\nkubectl get pods --all-namespaces -o jsonpath='{range .items[*].status.initContainerStatuses[*]}{.containerID}{\"\\n\"}{end}' | cut -d\/ -f3\n\n# List Events sorted by timestamp<\/em>\nkubectl get events --sort-by=.metadata.creationTimestamp\n\n# Compares the current state of the cluster against the state that the cluster would be in if the manifest was applied.<\/em>\nkubectl diff -f .\/my-manifest.yaml\n\n# Produce a period-delimited tree of all keys returned for nodes<\/em>\n# Helpful when locating a key within a complex nested JSON structure<\/em>\nkubectl get nodes -o json | jq -c 'paths|join(\".\")'\n\n# Produce a period-delimited tree of all keys returned for pods, etc<\/em>\nkubectl get pods -o json | jq -c 'paths|join(\".\")'\n\n# Produce ENV for all pods, assuming you have a default container for the pods, default namespace and the `env` command is supported.<\/em>\n# Helpful when running any supported command across all pods, not just `env`<\/em>\nfor<\/strong> pod in $(<\/strong>kubectl get po --output=jsonpath={.items..metadata.name})<\/strong>; do<\/strong> echo $pod && kubectl exec -it $pod -- env; done<\/strong>\n\n# Get a deployment's status subresource<\/em>\nkubectl get deployment nginx-deployment --subresource=status\n<\/code><\/pre>\n\n\n\n
Updating resources<\/a><\/h2>\n\n\n\n
kubectl set image deployment\/frontend www=image:v2               # Rolling update \"www\" containers of \"frontend\" deployment, updating the image<\/em>\nkubectl rollout history deployment\/frontend                      # Check the history of deployments including the revision<\/em>\nkubectl rollout undo deployment\/frontend                         # Rollback to the previous deployment<\/em>\nkubectl rollout undo deployment\/frontend --to-revision=2         # Rollback to a specific revision<\/em>\nkubectl rollout status -w deployment\/frontend                    # Watch rolling update status of \"frontend\" deployment until completion<\/em>\nkubectl rollout restart deployment\/frontend                      # Rolling restart of the \"frontend\" deployment<\/em>\n\n\ncat pod.json | kubectl replace -f -                              # Replace a pod based on the JSON passed into stdin<\/em>\n\n# Force replace, delete and then re-create the resource. Will cause a service outage.<\/em>\nkubectl replace --force -f .\/pod.json\n\n# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000<\/em>\nkubectl expose rc nginx --port=80 --target-port=8000\n\n# Update a single-container pod's image version (tag) to v4<\/em>\nkubectl get pod mypod -o yaml | sed 's\/\\(image: myimage\\):.*$\/\\1:v4\/' | kubectl replace -f -\n\nkubectl label pods my-pod new-label=awesome                      # Add a Label<\/em>\nkubectl annotate pods my-pod icon-url=http:\/\/goo.gl\/XXBTWq       # Add an annotation<\/em>\nkubectl autoscale deployment foo --min=2 --max=10                # Auto scale a deployment \"foo\"<\/em>\n<\/code><\/pre>\n\n\n\n
Patching resources<\/a><\/h2>\n\n\n\n
# Partially update a node<\/em>\nkubectl patch node k8s-node-1 -p '{\"spec\":{\"unschedulable\":true}}'\n\n# Update a container's image; spec.containers[*].name is required because it's a merge key<\/em>\nkubectl patch pod valid-pod -p '{\"spec\":{\"containers\":[{\"name\":\"kubernetes-serve-hostname\",\"image\":\"new image\"}]}}'\n\n# Update a container's image using a json patch with positional arrays<\/em>\nkubectl patch pod valid-pod --type='json' -p='[{\"op\": \"replace\", \"path\": \"\/spec\/containers\/0\/image\", \"value\":\"new image\"}]'\n\n# Disable a deployment livenessProbe using a json patch with positional arrays<\/em>\nkubectl patch deployment valid-deployment  --type json   -p='[{\"op\": \"remove\", \"path\": \"\/spec\/template\/spec\/containers\/0\/livenessProbe\"}]'\n\n# Add a new element to a positional array<\/em>\nkubectl patch sa default --type='json' -p='[{\"op\": \"add\", \"path\": \"\/secrets\/1\", \"value\": {\"name\": \"whatever\" } }]'\n\n# Update a deployment's replica count by patching its scale subresource<\/em>\nkubectl patch deployment nginx-deployment --subresource='scale' --type='merge' -p '{\"spec\":{\"replicas\":2}}'\n<\/code><\/pre>\n\n\n\n
Editing resources<\/a><\/h2>\n\n\n\n
Edit any API resource in your preferred editor.<\/p>\n\n\n\n
kubectl edit svc\/docker-registry                      # Edit the service named docker-registry<\/em>\nKUBE_EDITOR=\"nano\" kubectl edit svc\/docker-registry   # Use an alternative editor<\/em>\n<\/code><\/pre>\n\n\n\n
Scaling resources<\/a><\/h2>\n\n\n\n
kubectl scale --replicas=3 rs\/foo                                 # Scale a replicaset named 'foo' to 3<\/em>\nkubectl scale --replicas=3 -f foo.yaml                            # Scale a resource specified in \"foo.yaml\" to 3<\/em>\nkubectl scale --current-replicas=2 --replicas=3 deployment\/mysql  # If the deployment named mysql's current size is 2, scale mysql to 3<\/em>\nkubectl scale --replicas=5 rc\/foo rc\/bar rc\/baz                   # Scale multiple replication controllers<\/em>\n<\/code><\/pre>\n\n\n\n
Deleting resources<\/a><\/h2>\n\n\n\n
kubectl delete -f .\/pod.json                                      # Delete a pod using the type and name specified in pod.json<\/em>\nkubectl delete pod unwanted --now                                 # Delete a pod with no grace period<\/em>\nkubectl delete pod,service baz foo                                # Delete pods and services with same names \"baz\" and \"foo\"<\/em>\nkubectl delete pods,services -l name=myLabel                      # Delete pods and services with label name=myLabel<\/em>\nkubectl -n my-ns delete pod,svc --all                             # Delete all pods and services in namespace my-ns,<\/em>\n# Delete all pods matching the awk pattern1 or pattern2<\/em>\nkubectl get pods  -n mynamespace --no-headers=true | awk '\/pattern1|pattern2\/{print $1}' | xargs  kubectl delete -n mynamespace pod\n<\/code><\/pre>\n\n\n\n
Interacting with running Pods<\/a><\/h2>\n\n\n\n
kubectl logs my-pod                                 # dump pod logs (stdout)<\/em>\nkubectl logs -l name=myLabel                        # dump pod logs, with label name=myLabel (stdout)<\/em>\nkubectl logs my-pod --previous                      # dump pod logs (stdout) for a previous instantiation of a container<\/em>\nkubectl logs my-pod -c my-container                 # dump pod container logs (stdout, multi-container case)<\/em>\nkubectl logs -l name=myLabel -c my-container        # dump pod logs, with label name=myLabel (stdout)<\/em>\nkubectl logs my-pod -c my-container --previous      # dump pod container logs (stdout, multi-container case) for a previous instantiation of a container<\/em>\nkubectl logs -f my-pod                              # stream pod logs (stdout)<\/em>\nkubectl logs -f my-pod -c my-container              # stream pod container logs (stdout, multi-container case)<\/em>\nkubectl logs -f -l name=myLabel --all-containers    # stream all pods logs with label name=myLabel (stdout)<\/em>\nkubectl run -i --tty busybox --image=busybox:1.28 -- sh  # Run pod as interactive shell<\/em>\nkubectl run nginx --image=nginx -n mynamespace      # Start a single instance of nginx pod in the namespace of mynamespace<\/em>\nkubectl run nginx --image=nginx                     # Run pod nginx and write its spec into a file called pod.yaml<\/em>\n--dry-run=client -o yaml > pod.yaml\n\nkubectl attach my-pod -i                            # Attach to Running Container<\/em>\nkubectl port-forward my-pod 5000:6000               # Listen on port 5000 on the local machine and forward to port 6000 on my-pod<\/em>\nkubectl exec my-pod -- ls \/                         # Run command in existing pod (1 container case)<\/em>\nkubectl exec --stdin --tty my-pod -- \/bin\/sh        # Interactive shell access to a running pod (1 container case)<\/em>\nkubectl exec my-pod -c my-container -- ls \/         # Run command in existing pod (multi-container case)<\/em>\nkubectl top pod POD_NAME --containers               # Show metrics for a given pod and its containers<\/em>\nkubectl top pod POD_NAME --sort-by=cpu              # Show metrics for a given pod and sort it by 'cpu' or 'memory'<\/em>\n<\/code><\/pre>\n\n\n\n
Copy files and directories to and from containers<\/a><\/h2>\n\n\n\n
kubectl cp \/tmp\/foo_dir my-pod:\/tmp\/bar_dir            # Copy \/tmp\/foo_dir local directory to \/tmp\/bar_dir in a remote pod in the current namespace<\/em>\nkubectl cp \/tmp\/foo my-pod:\/tmp\/bar -c my-container    # Copy \/tmp\/foo local file to \/tmp\/bar in a remote pod in a specific container<\/em>\nkubectl cp \/tmp\/foo my-namespace\/my-pod:\/tmp\/bar       # Copy \/tmp\/foo local file to \/tmp\/bar in a remote pod in namespace my-namespace<\/em>\nkubectl cp my-namespace\/my-pod:\/tmp\/foo \/tmp\/bar       # Copy \/tmp\/foo from a remote pod to \/tmp\/bar locally<\/em>\n<\/code><\/pre>\n\n\n\n
Note:<\/strong> kubectl cp<\/code> requires that the ‘tar’ binary is present in your container image. If ‘tar’ is not present,kubectl cp<\/code> will fail. For advanced use cases, such as symlinks, wildcard expansion or file mode preservation consider using kubectl exec<\/code>.<\/p>\n\n\n\n
tar cf - \/tmp\/foo | kubectl exec -i -n my-namespace my-pod -- tar xf - -C \/tmp\/bar           # Copy \/tmp\/foo local file to \/tmp\/bar in a remote pod in namespace my-namespace<\/em>\nkubectl exec -n my-namespace my-pod -- tar cf - \/tmp\/foo | tar xf - -C \/tmp\/bar    # Copy \/tmp\/foo from a remote pod to \/tmp\/bar locally<\/em>\n<\/code><\/pre>\n\n\n\n
Interacting with Deployments and Services<\/a><\/h2>\n\n\n\n
kubectl logs deploy\/my-deployment                         # dump Pod logs for a Deployment (single-container case)<\/em>\nkubectl logs deploy\/my-deployment -c my-container         # dump Pod logs for a Deployment (multi-container case)<\/em>\n\nkubectl port-forward svc\/my-service 5000                  # listen on local port 5000 and forward to port 5000 on Service backend<\/em>\nkubectl port-forward svc\/my-service 5000:my-service-port  # listen on local port 5000 and forward to Service target port with name <my-service-port><\/em>\n\nkubectl port-forward deploy\/my-deployment 5000:6000       # listen on local port 5000 and forward to port 6000 on a Pod created by <my-deployment><\/em>\nkubectl exec deploy\/my-deployment -- ls                   # run command in first Pod and first container in Deployment (single- or multi-container cases)<\/em>\n<\/code><\/pre>\n\n\n\n
Interacting with Nodes and cluster<\/a><\/h2>\n\n\n\n
kubectl cordon my-node                                                # Mark my-node as unschedulable<\/em>\nkubectl drain my-node                                                 # Drain my-node in preparation for maintenance<\/em>\nkubectl uncordon my-node                                              # Mark my-node as schedulable<\/em>\nkubectl top node my-node                                              # Show metrics for a given node<\/em>\nkubectl cluster-info                                                  # Display addresses of the master and services<\/em>\nkubectl cluster-info dump                                             # Dump current cluster state to stdout<\/em>\nkubectl cluster-info dump --output-directory=\/path\/to\/cluster-state   # Dump current cluster state to \/path\/to\/cluster-state<\/em>\n\n# View existing taints on which exist on current nodes.<\/em>\nkubectl get nodes -o=custom-columns=NodeName:.metadata.name,TaintKey:.spec.taints[*].key,TaintValue:.spec.taints[*].value,TaintEffect:.spec.taints[*].effect\n\n# If a taint with that key and effect already exists, its value is replaced as specified.<\/em>\nkubectl taint nodes foo dedicated=special-user:NoSchedule\n<\/code><\/pre>\n\n\n\n
Resource types<\/a><\/h3>\n\n\n\n
List all supported resource types along with their shortnames, API group<\/a>, whether they are namespaced<\/a>, and Kind<\/a>:<\/p>\n\n\n\n
kubectl api-resources\n<\/code><\/pre>\n\n\n\n
Other operations for exploring API resources:<\/p>\n\n\n\n
kubectl api-resources --namespaced=true      # All namespaced resources<\/em>\nkubectl api-resources --namespaced=false     # All non-namespaced resources<\/em>\nkubectl api-resources -o name                # All resources with simple output (only the resource name)<\/em>\nkubectl api-resources -o wide                # All resources with expanded (aka \"wide\") output<\/em>\nkubectl api-resources --verbs=list,get       # All resources that support the \"list\" and \"get\" request verbs<\/em>\nkubectl api-resources --api-group=extensions # All resources in the \"extensions\" API group<\/em>\n<\/code><\/pre>\n\n\n\n
Formatting output<\/a><\/h3>\n\n\n\n
To output details to your terminal window in a specific format, add the -o<\/code> (or --output<\/code>) flag to a supported kubectl<\/code> command.<\/p>\n\n\n\n
Output format<\/th>Description<\/th><\/tr><\/thead>
-o=custom-columns=<spec><\/code><\/td>Print a table using a comma separated list of custom columns<\/td><\/tr>
-o=custom-columns-file=<filename><\/code><\/td>Print a table using the custom columns template in the <filename><\/code> file<\/td><\/tr>
-o=json<\/code><\/td>Output a JSON formatted API object<\/td><\/tr>
-o=jsonpath=<template><\/code><\/td>Print the fields defined in a jsonpath<\/a> expression<\/td><\/tr>
-o=jsonpath-file=<filename><\/code><\/td>Print the fields defined by the jsonpath<\/a> expression in the <filename><\/code> file<\/td><\/tr>
-o=name<\/code><\/td>Print only the resource name and nothing else<\/td><\/tr>
-o=wide<\/code><\/td>Output in the plain-text format with any additional information, and for pods, the node name is included<\/td><\/tr>
-o=yaml<\/code><\/td>Output a YAML formatted API object<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples using -o=custom-columns<\/code>:<\/p>\n\n\n\n
# All images running in a cluster<\/em>\nkubectl get pods -A -o=custom-columns='DATA:spec.containers[*].image'\n\n# All images running in namespace: default, grouped by Pod<\/em>\nkubectl get pods --namespace default --output=custom-columns=\"NAME:.metadata.name,IMAGE:.spec.containers[*].image\"\n\n # All images excluding \"registry.k8s.io\/coredns:1.6.2\"<\/em>\nkubectl get pods -A -o=custom-columns='DATA:spec.containers[?(@.image!=\"registry.k8s.io\/coredns:1.6.2\")].image'\n\n# All fields under metadata regardless of name<\/em>\nkubectl get pods -A -o=custom-columns='DATA:metadata.*'\n<\/code><\/pre>\n\n\n\n
More examples in the kubectl reference documentation<\/a>.<\/p>\n\n\n\n
Kubectl output verbosity and debugging<\/a><\/h3>\n\n\n\n
Kubectl verbosity is controlled with the -v<\/code> or --v<\/code> flags followed by an integer representing the log level. General Kubernetes logging conventions and the associated log levels are described here<\/a>.<\/p>\n\n\n\n
Verbosity<\/th>Description<\/th><\/tr><\/thead>
--v=0<\/code><\/td>Generally useful for this to always<\/em> be visible to a cluster operator.<\/td><\/tr>
--v=1<\/code><\/td>A reasonable default log level if you don’t want verbosity.<\/td><\/tr>
--v=2<\/code><\/td>Useful steady state information about the service and important log messages that may correlate to significant changes in the system. This is the recommended default log level for most systems.<\/td><\/tr>
--v=3<\/code><\/td>Extended information about changes.<\/td><\/tr>
--v=4<\/code><\/td>Debug level verbosity.<\/td><\/tr>
--v=5<\/code><\/td>Trace level verbosity.<\/td><\/tr>
--v=6<\/code><\/td>Display requested resources.<\/td><\/tr>
--v=7<\/code><\/td>Display HTTP request headers.<\/td><\/tr>
--v=8<\/code><\/td>Display HTTP request contents.<\/td><\/tr>
--v=9<\/code><\/td>Display HTTP request contents without truncation of contents.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"
This page contains a list of commonly used kubectl commands and flags. Kubectl autocomplete BASH You can also use a shorthand alias for kubectl that also works with completion: ZSH A Note on –all-namespaces Appending –all-namespaces happens frequently enough where you should be aware of the shorthand for –all-namespaces: kubectl -A Kubectl context and configuration Set which Kubernetes cluster kubectl communicates with and modifies…<\/p>\n
Read More “kubectl Cheat Sheet”<\/span> »<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[6,5],"tags":[],"class_list":["post-150","post","type-post","status-publish","format-standard","hentry","category-it","category-kubernetes"],"_links":{"self":[{"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/posts\/150","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/comments?post=150"}],"version-history":[{"count":1,"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/posts\/150\/revisions"}],"predecessor-version":[{"id":151,"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/posts\/150\/revisions\/151"}],"wp:attachment":[{"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/media?parent=150"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/categories?post=150"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/merserver.com\/index.php\/wp-json\/wp\/v2\/tags?post=150"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}