Editing Kubectl

{{lowercase}}
<code>[[wikipedia:kubectl]]</code> is a command line interface for running commands against [[Kubernetes]] clusters.<ref>https://kubernetes.io/docs/reference/kubectl/overview/</ref>

== Installation ==
* To install in [[macOS]] execute: <code>[[brew install kubernetes-cli]]</code>
* Ubuntu [[Kubernetes installation]]: <code>[[snap install kubectl --classic]]</code>
* <code>[[~/.kube/config]]</code>

== Commands ==
* <code>[[kubectl --help]]</code>
* <code>[[kubectl api-versions]]</code>
* <code>[[kubectl apply]]</code>
* <code>[[kubectl auth]]</code>
* <code>[[kubectl create]]</code>
* <code>[[kubectl completion]]</code>
* <code>[[kubectl config]]</code>
* <code>[[kubectl debug]]</code> (since [[v1.18]], March 2020)
* <code>[[kubectl delete]]</code>
* <code>[[kubectl describe]]</code>
* <code>[[kubectl diff]]</code> (since [[v1.18]], March 2020)
* <code>[[kubectl edit]]</code>
* <code>[[kubectl expose]]</code>
* <code>[[kubectl exec]]</code>
* <code>[[kubectl get]] [[kubectl get all|all]] | [[kubectl get nodes|nodes]] | [[kubectl get pvc|pvc]] | [[kubectl get pods|pods]] | [[kubectl get replicaset|replicaset]] .../... </code> 
* <code>[[kubectl label]]</code>
* <code>[[kubectl logs]]</code>
* <code>[[kubectl patch]]</code>
* <code>[[kubectl port-forward]]</code>
* <code>[[kubectl proxy]]</code>
* <code>[[kubectl plugin]]</code>
* <code>[[kubectl replace]]</code>
* <code>[[kubectl rolling-update]]</code>
* <code>[[kubectl rollout]]</code>
* <code>[[kubectl set]]</code>
* <code>[[kubectl top]]</code>
* <code>[[kubectl virt]]</code>

== [[Kubectl information commands]] ==
{{kubectl information TOC}}

== kubectl operation commands ==
* <code>[[kubectl create]]</code>
* <code>[[kubectl delete pod]]</code>
* <code>[[kubectl delete namespace]] MY_NAMESPACE</code>
* Connect to a Pod: <code>[[kubectl exec]] -it YOUR_POD_NANE -- /bin/bash</code>

== kubectl command reference ==
The following table includes short descriptions and the general syntax for all of the <code>kubectl</code> operations:<ref>https://kubernetes.io/docs/reference/kubectl/overview/</ref>

*'''Apply''' <code>[[kubectl apply]] -f FILENAME [flags]</code>. Apply a configuration change to a resource from a file or stdin. Allows to [[Create and configure a basic Pod|create a Pod]].

*'''Attach''' <code>kubectl attach POD -c CONTAINER [-i] [-t] [flags]</code>:Attach to a running container either to view the output stream or interact with the container (stdin)

*'''Auto Scale''' <code>kubectl autoscale (-f FILENAME \| TYPE NAME \| TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]</code>: Automatically scale the set of pods that are managed by a replication controller 


*'''Cluster Info''' <code>[[kubectl cluster-info]] [flags]</code> :Display endpoint information about the master and services in the cluster

*'''Create''' <code>[[kubectl create]] -f FILENAME [flags]</code>: Create one or more resources from a file or stdin
** <code>kubectl create namespace myexamplenamespace</code>
** <code>kubectl create sa my_new_user</code> (Create service account for your my_new_user)
** <code>kubectl create -f mypod.[[yaml]]</code>


*'''Config''': <code>kubectl config .../...</code>
** <code>[[kubectl config view]]</code>

*'''Delete''' <code>kubectl delete (-f FILENAME \| TYPE [NAME \| /NAME \| -l label \| --all]) [flags]</code> :Delete resources 
** <code>kubectl delete --all namespaces</code>

*'''Describe''' <code>kubectl describe (-f FILENAME \| TYPE [NAME_PREFIX \| /NAME \| -l label]) [flags]</code> : Detailed state of one or more resources.
** <code>kubectl describe pod MyPodName</code>
** <code>kubectl describe pods</code>
** <code>kubectl describe replicaset MyReplicaName</code>

*'''Edit''' <code>kubectl edit (-f FILENAME \| TYPE NAME \| TYPE/NAME) [flags]</code> : Edit and update the definition of one or more resources on the server by using the default editor.

*'''Execute''' <code>kubectl exec POD [-c CONTAINER] [-i] [-t] [flags] [-- COMMAND [args...]]</code>: Execute a command against a container in a pod

*'''Logs''' <code>kubectl logs POD [-c CONTAINER] [--follow] [flags]</code>: Print the logs for a container in a pod.
** <code>kubectl logs -l app=elasticsearch</code> (using labels: -l)

* '''[[kubectl get|Get]]''': 

* '''Replace''': <code>[[kubectl replace]] --force -f yml_file_describing_pod.yml</code>

* '''Proxy''': <code>[[kubectl proxy]] --port=8080</code><ref>https://kubernetes.io/docs/tasks/access-kubernetes-api/http-proxy-access-api/</ref>

* '''Rolling-update:''' <code>[[kubectl rolling-update]]</code>

*'''Run''' <code>[[kubectl run]] NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [flags]</code>: Run a specified image on the cluster.

*'''Scale''': <code>[[kubectl scale]] deployment YOUR_DEPLOYMENT_NAME</code>

*'''Stop''' <code>kubectl stop</code>

*'''Version''' <code>kubectl version [--client] [flags]</code>: Display the Kubernetes version running on the client and server.

== Activities ==
* [[Create and configure a basic Pod]] (<code>[[kubectl apply]]</code>)
* Read official <code>kubectl</code> cheat sheet: https://kubernetes.io/docs/reference/kubectl/cheatsheet/
* Check examples: https://www.codegrepper.com/code-examples/shell/kubectl+describe+ingress+output+yaml
* https://stackoverflow.com/questions/tagged/kubectl?tab=Votes

== Related ==
* [[Krew]]
* [[kops]]
* <code>[[aws eks]] --region $(terraform output -raw region) [[update-kubeconfig]] --name $(terraform output -raw cluster_name)</code>
* [[kubectl-convert]]
* <code>[[kubeadm]]</code>

== See also ==
* {{Kubernetes components}}
* {{kubectl}}
* {{k8s}}

[[Category: Kubernetes]]
[[Category: kubectl]]

{{CC license}}
Source: https://en.wikiversity.org/wiki/DevOps/Kubernetes/kubectl