Skip to content

Commit 8f2710f

Browse files
authored
Merge pull request #20909 from sharet-adl/patch-1
Update kubectl overview page - list of operations
2 parents 9b2254e + c57fa62 commit 8f2710f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

content/en/docs/reference/kubectl/overview.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,31 +69,49 @@ The following table includes short descriptions and the general syntax for all o
6969

7070
Operation | Syntax | Description
7171
-------------------- | -------------------- | --------------------
72+
`alpha` | `kubectl alpha SUBCOMMAND [flags]` | List the available commands that correspond to alpha features, which are not enabled in Kubernetes clusters by default.
7273
`annotate` | <code>kubectl annotate (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]</code> | Add or update the annotations of one or more resources.
74+
`api-resources` | `kubectl api-resources [flags]` | List the API resources that are available.
7375
`api-versions` | `kubectl api-versions [flags]` | List the API versions that are available.
7476
`apply` | `kubectl apply -f FILENAME [flags]`| Apply a configuration change to a resource from a file or stdin.
7577
`attach` | `kubectl attach POD -c CONTAINER [-i] [-t] [flags]` | Attach to a running container either to view the output stream or interact with the container (stdin).
78+
`auth` | `kubectl auth [flags] [options]` | Inspect authorization.
7679
`autoscale` | <code>kubectl autoscale (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]</code> | Automatically scale the set of pods that are managed by a replication controller.
80+
`certificate` | `kubectl certificate SUBCOMMAND [options]` | Modify certificate resources.
7781
`cluster-info` | `kubectl cluster-info [flags]` | Display endpoint information about the master and services in the cluster.
82+
`completion` | `kubectl completion SHELL [options]` | Output shell completion code for the specified shell (bash or zsh).
7883
`config` | `kubectl config SUBCOMMAND [flags]` | Modifies kubeconfig files. See the individual subcommands for details.
84+
`convert` | `kubectl convert -f FILENAME [options]` | Convert config files between different API versions. Both YAML and JSON formats are accepted.
85+
`cordon` | `kubectl cordon NODE [options]` | Mark node as unschedulable.
86+
`cp` | `kubectl cp <file-spec-src> <file-spec-dest> [options]` | Copy files and directories to and from containers.
7987
`create` | `kubectl create -f FILENAME [flags]` | Create one or more resources from a file or stdin.
8088
`delete` | <code>kubectl delete (-f FILENAME &#124; TYPE [NAME &#124; /NAME &#124; -l label &#124; --all]) [flags]</code> | Delete resources either from a file, stdin, or specifying label selectors, names, resource selectors, or resources.
8189
`describe` | <code>kubectl describe (-f FILENAME &#124; TYPE [NAME_PREFIX &#124; /NAME &#124; -l label]) [flags]</code> | Display the detailed state of one or more resources.
8290
`diff` | `kubectl diff -f FILENAME [flags]`| Diff file or stdin against live configuration.
91+
`drain` | `kubectl drain NODE [options]` | Drain node in preparation for maintenance.
8392
`edit` | <code>kubectl edit (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) [flags]</code> | Edit and update the definition of one or more resources on the server by using the default editor.
8493
`exec` | `kubectl exec POD [-c CONTAINER] [-i] [-t] [flags] [-- COMMAND [args...]]` | Execute a command against a container in a pod.
8594
`explain` | `kubectl explain [--recursive=false] [flags]` | Get documentation of various resources. For instance pods, nodes, services, etc.
8695
`expose` | <code>kubectl expose (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) [--port=port] [--protocol=TCP&#124;UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type] [flags]</code> | Expose a replication controller, service, or pod as a new Kubernetes service.
8796
`get` | <code>kubectl get (-f FILENAME &#124; TYPE [NAME &#124; /NAME &#124; -l label]) [--watch] [--sort-by=FIELD] [[-o &#124; --output]=OUTPUT_FORMAT] [flags]</code> | List one or more resources.
97+
`kustomize` | `kubectl kustomize <dir> [flags] [options]` | List a set of API resources generated from instructions in a kustomization.yaml file. The argument must be the path to the directory containing the file, or a git repository URL with a path suffix specifying same with respect to the repository root.
8898
`label` | <code>kubectl label (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]</code> | Add or update the labels of one or more resources.
8999
`logs` | `kubectl logs POD [-c CONTAINER] [--follow] [flags]` | Print the logs for a container in a pod.
100+
`options` | `kubectl options` | List of global command-line options, which apply to all commands.
90101
`patch` | <code>kubectl patch (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) --patch PATCH [flags]</code> | Update one or more fields of a resource by using the strategic merge patch process.
102+
`plugin` | `kubectl plugin [flags] [options]` | Provides utilities for interacting with plugins.
91103
`port-forward` | `kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] [flags]` | Forward one or more local ports to a pod.
92104
`proxy` | `kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] [flags]` | Run a proxy to the Kubernetes API server.
93105
`replace` | `kubectl replace -f FILENAME` | Replace a resource from a file or stdin.
106+
`rollout` | `kubectl rollout SUBCOMMAND [options]` | Manage the rollout of a resource. Valid resource types include: deployments, daemonsets and statefulsets.
94107
`run` | <code>kubectl run NAME --image=image [--env="key=value"] [--port=port] [--dry-run=server&#124;client&#124;none] [--overrides=inline-json] [flags]</code> | Run a specified image on the cluster.
95108
`scale` | <code>kubectl scale (-f FILENAME &#124; TYPE NAME &#124; TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags]</code> | Update the size of the specified replication controller.
109+
`set` | `kubectl set SUBCOMMAND [options]` | Configure application resources.
110+
`taint` | `kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N [options]` | Update the taints on one or more nodes.
111+
`top` | `kubectl top [flags] [options]` | Display Resource (CPU/Memory/Storage) usage.
112+
`uncordon` | `kubectl uncordon NODE [options]` | Mark node as schedulable.
96113
`version` | `kubectl version [--client] [flags]` | Display the Kubernetes version running on the client and server.
114+
`wait` | <code>kubectl wait ([-f FILENAME] &#124; resource.group/resource.name &#124; resource.group [(-l label &#124; --all)]) [--for=delete&#124;--for condition=available] [options]</code> | Experimental: Wait for a specific condition on one or many resources.
97115

98116
Remember: For more about command operations, see the [kubectl](/docs/user-guide/kubectl/) reference documentation.
99117

0 commit comments

Comments
 (0)