Difference between revisions of "Kubectl --help"
Jump to navigation
Jump to search
(20 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | {{lowercase}} | ||
+ | [[kubectl]] --help and [[kubectl options]] | ||
− | kubectl --help | + | |
+ | |||
+ | [[kubectl]] --help | ||
kubectl controls the Kubernetes cluster manager. | kubectl controls the Kubernetes cluster manager. | ||
Line 7: | Line 11: | ||
Basic Commands (Beginner): | Basic Commands (Beginner): | ||
create Create a resource from a file or from stdin. | create Create a resource from a file or from stdin. | ||
− | expose Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service | + | [[kubeclt expose|expose]] Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service |
− | run Run a particular image on the cluster | + | [[kubectl run|run]] Run a particular image on the cluster |
− | set Set specific features on objects | + | [[kubectl set|set]] Set specific features on objects |
Basic Commands (Intermediate): | Basic Commands (Intermediate): | ||
explain Documentation of resources | explain Documentation of resources | ||
− | get Display one or many resources | + | [[kubectl get|get]] Display one or many resources |
edit Edit a resource on the server | edit Edit a resource on the server | ||
− | delete Delete resources by filenames, stdin, resources and names, or by resources and label selector | + | [[kubectl delete|delete]] Delete resources by filenames, stdin, resources and names, or by resources and label selector |
[[Deploy]] Commands: | [[Deploy]] Commands: | ||
Line 28: | Line 32: | ||
cordon Mark node as unschedulable | cordon Mark node as unschedulable | ||
uncordon Mark node as schedulable | uncordon Mark node as schedulable | ||
− | drain Drain node in preparation for maintenance | + | [[kubectl drain|drain]] Drain node in preparation for maintenance |
taint Update the taints on one or more nodes | taint Update the taints on one or more nodes | ||
− | + | ||
Troubleshooting and Debugging Commands: | Troubleshooting and Debugging Commands: | ||
− | describe Show details of a specific resource or group of resources | + | [[describe]] Show details of a specific resource or group of resources |
− | logs Print the logs for a container in a pod | + | [[logs]] Print the logs for a container in a pod |
− | attach Attach to a running container | + | [[attach]] Attach to a running container |
− | exec Execute a command in a container | + | [[exec]] Execute a command in a container |
− | port-forward Forward one or more local ports to a pod | + | [[port-forward]] Forward one or more local ports to a pod |
− | proxy Run a proxy to the Kubernetes API server | + | [[proxy]] Run a proxy to the Kubernetes API server |
− | cp Copy files and directories to and from containers. | + | [[cp]] Copy files and directories to and from containers. |
− | auth Inspect authorization | + | [[auth]] Inspect authorization |
− | + | ||
Advanced Commands: | Advanced Commands: | ||
− | diff Diff live version against would-be applied version | + | [[kubectl diff|diff]] Diff live version against would-be applied version |
apply Apply a configuration to a resource by filename or stdin | apply Apply a configuration to a resource by filename or stdin | ||
patch Update field(s) of a resource using strategic merge patch | patch Update field(s) of a resource using strategic merge patch | ||
Line 61: | Line 65: | ||
[[kubectl plugin|plugin]] Provides utilities for interacting with plugins. | [[kubectl plugin|plugin]] Provides utilities for interacting with plugins. | ||
[[kubectl version|version]] Print the client and server version information | [[kubectl version|version]] Print the client and server version information | ||
− | + | ||
Usage: | Usage: | ||
kubectl [flags] [options] | kubectl [flags] [options] | ||
− | + | ||
Use "kubectl <command> --help" for more information about a given command. | Use "kubectl <command> --help" for more information about a given command. | ||
Use "kubectl options" for a list of global command-line options (applies to all commands). | Use "kubectl options" for a list of global command-line options (applies to all commands). | ||
− | |||
== Related terms == | == Related terms == | ||
− | * [[--dry-run]] | + | * <code>[[--dry-run]]</code> |
+ | * [[Kubernetes changelog]] | ||
+ | * <code>[[kubectl krew]]</code> | ||
+ | * <code>[[kubectl options]]</code> | ||
== See also == | == See also == | ||
+ | * {{kubectl config}} | ||
* {{kubectl}} | * {{kubectl}} | ||
[[Category:K8s]] | [[Category:K8s]] |
Latest revision as of 12:00, 4 March 2024
kubectl --help and kubectl options
kubectl --help kubectl controls the Kubernetes cluster manager. Find more information at: https://kubernetes.io/docs/reference/kubectl/overview/ Basic Commands (Beginner): create Create a resource from a file or from stdin. expose Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service run Run a particular image on the cluster set Set specific features on objects Basic Commands (Intermediate): explain Documentation of resources get Display one or many resources edit Edit a resource on the server delete Delete resources by filenames, stdin, resources and names, or by resources and label selector Deploy Commands: rollout Manage the rollout of a resource scale Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job autoscale Auto-scale a Deployment, ReplicaSet, or ReplicationController Cluster Management Commands: certificate Modify certificate resources. cluster-info Display cluster info top Display Resource (CPU/Memory/Storage) usage. cordon Mark node as unschedulable uncordon Mark node as schedulable drain Drain node in preparation for maintenance taint Update the taints on one or more nodes Troubleshooting and Debugging Commands: describe Show details of a specific resource or group of resources logs Print the logs for a container in a pod attach Attach to a running container exec Execute a command in a container port-forward Forward one or more local ports to a pod proxy Run a proxy to the Kubernetes API server cp Copy files and directories to and from containers. auth Inspect authorization Advanced Commands: diff Diff live version against would-be applied version apply Apply a configuration to a resource by filename or stdin patch Update field(s) of a resource using strategic merge patch replace Replace a resource by filename or stdin wait Experimental: Wait for a specific condition on one or many resources. convert Convert config files between different API versions kustomize Build a kustomization target from a directory or a remote url. Settings Commands: label Update the labels on a resource annotate Update the annotations on a resource completion Output shell completion code for the specified shell (bash or zsh) Other Commands: api-resources Print the supported API resources on the server api-versions Print the supported API versions on the server, in the form of "group/version" config Modify kubeconfig files plugin Provides utilities for interacting with plugins. version Print the client and server version information Usage: kubectl [flags] [options] Use "kubectl <command> --help" for more information about a given command. Use "kubectl options" for a list of global command-line options (applies to all commands).
Related terms[edit]
See also[edit]
kubectl config
[view | get-contexts | current-context | get-clusters | set-context | set-credentials ], ~/.kube/config, kubectl config --help
,kubectx
, Kubernetes contexts,KUBECONFIG, kubectl --kubeconfig
kubectl
: [cp | config | create
|delete
|edit | explain |
apply
|exec
|get
|set
|drain | uncordon | rolling-update
|rollout
|logs
|run
|auth
|label | annotate
|version
|top
|diff
|debug
|replace
|describe
|port-forward | proxy
|scale
|rollout
|api-resources
| expose deployment | expose | patch | attach | get endpoints | ~/.kube/config | kubectl logs --help | kubectl --help, kubectl-convert, kubectl autoscale, kubectl.kubernetes.io
Advertising: