Difference between revisions of "Kubectl --help"

From wikieduonline
Jump to navigation Jump to search
(Created page with "<pre> kubectl --help kubectl controls the Kubernetes cluster manager. Find more information at: https://kubernetes.io/docs/reference/kubectl/overview/ Basic Commands (Begin...")
 
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
<pre>
+
{{lowercase}}
kubectl --help
+
[[kubectl]] --help and [[kubectl options]]
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):
+
[[kubectl]] --help
  explain        Documentation of resources
+
kubectl controls the Kubernetes cluster manager.
  get            Display one or many resources
+
  edit          Edit a resource on the server
+
  Find more information at: https://kubernetes.io/docs/reference/kubectl/overview/
  delete        Delete resources by filenames, stdin, resources and names, or by resources and label selector
+
 +
Basic Commands (Beginner):
 +
  create        Create a resource from a file or from stdin.
 +
  [[kubeclt expose|expose]]        Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service
 +
  [[kubectl run|run]]            Run a particular image on the cluster
 +
  [[kubectl set|set]]            Set specific features on objects
 +
 +
Basic Commands (Intermediate):
 +
  explain        Documentation of resources
 +
  [[kubectl get|get]]           Display one or many resources
 +
  edit          Edit a resource on the server
 +
  [[kubectl delete|delete]]         Delete resources by filenames, stdin, resources and names, or by resources and label selector
 +
 +
[[Deploy]] Commands:
 +
  [[kubectl rollout|rollout]]        Manage the rollout of a resource
 +
  [[kubectl scale|scale]]        Set a new size for a Deployment, [[ReplicaSet]], Replication Controller, or Job
 +
  [[kubectl autoscale|autoscale]]      Auto-scale a [[Deployment]], ReplicaSet, or ReplicationController
 +
 +
Cluster Management Commands:
 +
  certificate    Modify certificate resources.
 +
  [[kubectl cluster-info|cluster-info]]  Display cluster info
 +
  [[kubectl top|top]]            Display Resource (CPU/Memory/Storage) usage.
 +
  cordon        Mark node as unschedulable
 +
  uncordon      Mark node as schedulable
 +
  [[kubectl drain|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:
 +
  [[kubectl diff|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:
 +
  [[kubectl api-resources|api-resources]]  Print the supported API resources on the server
 +
  [[kubectl api-versions|api-versions]]  Print the supported API versions on the server, in the form of "group/version"
 +
  [[kubectl config|config]]        Modify kubeconfig files
 +
  [[kubectl plugin|plugin]]        Provides utilities for interacting with plugins.
 +
  [[kubectl version|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).
  
Deploy Commands:
+
== Related terms ==
  rollout        Manage the rollout of a resource
+
* <code>[[--dry-run]]</code>
  scale          Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job
+
* [[Kubernetes changelog]]
  autoscale      Auto-scale a Deployment, ReplicaSet, or ReplicationController
+
* <code>[[kubectl krew]]</code>
 
+
* <code>[[kubectl options]]</code>
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).
 
</pre>
 
  
 
== 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]

Advertising: