Skip to content

Commit

Permalink
Revise kubectl reference layout
Browse files Browse the repository at this point in the history 
The reference is generated using an improve version of component
reference generator
(kubernetes-sigs/reference-docs#349).
  • Loading branch information
@tengqm
tengqm committed Jan 6, 2024
1 parent f5e1703 commit 7100b9c
Show file tree
Hide file tree
Showing 110 changed files with 5,571 additions and 1,146 deletions.
137 changes: 93 additions & 44 deletions content/en/docs/reference/kubectl/generated/kubectl.md
View file
Expand Up @@ -11,7 +11,7 @@ The file is auto-generated from the Go source code of the component using a gene
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
Expand Down Expand Up @@ -213,6 +213,55 @@ kubectl [flags]
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
</tr>

<tr>
<td colspan="2">--storage-driver-buffer-duration duration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 1m0s</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
</tr>

<tr>
<td colspan="2">--storage-driver-db string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "cadvisor"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
</tr>

<tr>
<td colspan="2">--storage-driver-host string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "localhost:8086"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
</tr>

<tr>
<td colspan="2">--storage-driver-password string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
</tr>

<tr>
<td colspan="2">--storage-driver-secure</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
</tr>

<tr>
<td colspan="2">--storage-driver-table string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "stats"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
</tr>

<tr>
<td colspan="2">--storage-driver-user string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "root"</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
</tr>

<tr>
<td colspan="2">--tls-server-name string</td>
</tr>
Expand Down Expand Up @@ -262,47 +311,47 @@ kubectl [flags]

## {{% heading "seealso" %}}

* [kubectl annotate](kubectl_annotate/) - Update the annotations on a resource
* [kubectl api-resources](kubectl_api-resources/) - Print the supported API resources on the server
* [kubectl api-versions](kubectl_api-versions/) - Print the supported API versions on the server, in the form of "group/version"
* [kubectl apply](kubectl_apply/) - Apply a configuration to a resource by file name or stdin
* [kubectl attach](kubectl_attach/) - Attach to a running container
* [kubectl auth](kubectl_auth/) - Inspect authorization
* [kubectl autoscale](kubectl_autoscale/) - Auto-scale a deployment, replica set, stateful set, or replication controller
* [kubectl certificate](kubectl_certificate/) - Modify certificate resources
* [kubectl cluster-info](kubectl_cluster-info/) - Display cluster information
* [kubectl completion](kubectl_completion/) - Output shell completion code for the specified shell (bash, zsh, fish, or powershell)
* [kubectl config](kubectl_config/) - Modify kubeconfig files
* [kubectl cordon](kubectl_cordon/) - Mark node as unschedulable
* [kubectl cp](kubectl_cp/) - Copy files and directories to and from containers
* [kubectl create](kubectl_create/) - Create a resource from a file or from stdin
* [kubectl debug](kubectl_debug/) - Create debugging sessions for troubleshooting workloads and nodes
* [kubectl delete](kubectl_delete/) - Delete resources by file names, stdin, resources and names, or by resources and label selector
* [kubectl describe](kubectl_describe/) - Show details of a specific resource or group of resources
* [kubectl diff](kubectl_diff/) - Diff the live version against a would-be applied version
* [kubectl drain](kubectl_drain/) - Drain node in preparation for maintenance
* [kubectl edit](kubectl_edit/) - Edit a resource on the server
* [kubectl events](kubectl_events/) - List events
* [kubectl exec](kubectl_exec/) - Execute a command in a container
* [kubectl explain](kubectl_explain/) - Get documentation for a resource
* [kubectl expose](kubectl_expose/) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes service
* [kubectl get](kubectl_get/) - Display one or many resources
* [kubectl kustomize](kubectl_kustomize/) - Build a kustomization target from a directory or URL
* [kubectl label](kubectl_label/) - Update the labels on a resource
* [kubectl logs](kubectl_logs/) - Print the logs for a container in a pod
* [kubectl options](kubectl_options/) - Print the list of flags inherited by all commands
* [kubectl patch](kubectl_patch/) - Update fields of a resource
* [kubectl plugin](kubectl_plugin/) - Provides utilities for interacting with plugins
* [kubectl port-forward](kubectl_port-forward/) - Forward one or more local ports to a pod
* [kubectl proxy](kubectl_proxy/) - Run a proxy to the Kubernetes API server
* [kubectl replace](kubectl_replace/) - Replace a resource by file name or stdin
* [kubectl rollout](kubectl_rollout/) - Manage the rollout of a resource
* [kubectl run](kubectl_run/) - Run a particular image on the cluster
* [kubectl scale](kubectl_scale/) - Set a new size for a deployment, replica set, or replication controller
* [kubectl set](kubectl_set/) - Set specific features on objects
* [kubectl taint](kubectl_taint/) - Update the taints on one or more nodes
* [kubectl top](kubectl_top/) - Display resource (CPU/memory) usage
* [kubectl uncordon](kubectl_uncordon/) - Mark node as schedulable
* [kubectl version](kubectl_version/) - Print the client and server version information
* [kubectl wait](kubectl_wait/) - Experimental: Wait for a specific condition on one or many resources
* [kubectl annotate](../kubectl_annotate/) - Update the annotations on a resource
* [kubectl api-resources](../kubectl_api-resources/) - Print the supported API resources on the server
* [kubectl api-versions](../kubectl_api-versions/) - Print the supported API versions on the server, in the form of "group/version"
* [kubectl apply](../kubectl_apply/) - Apply a configuration to a resource by file name or stdin
* [kubectl attach](../kubectl_attach/) - Attach to a running container
* [kubectl auth](../kubectl_auth/) - Inspect authorization
* [kubectl autoscale](../kubectl_autoscale/) - Auto-scale a deployment, replica set, stateful set, or replication controller
* [kubectl certificate](../kubectl_certificate/) - Modify certificate resources
* [kubectl cluster-info](../kubectl_cluster-info/) - Display cluster information
* [kubectl completion](../kubectl_completion/) - Output shell completion code for the specified shell (bash, zsh, fish, or powershell)
* [kubectl config](../kubectl_config/) - Modify kubeconfig files
* [kubectl cordon](../kubectl_cordon/) - Mark node as unschedulable
* [kubectl cp](../kubectl_cp/) - Copy files and directories to and from containers
* [kubectl create](../kubectl_create/) - Create a resource from a file or from stdin
* [kubectl debug](../kubectl_debug/) - Create debugging sessions for troubleshooting workloads and nodes
* [kubectl delete](../kubectl_delete/) - Delete resources by file names, stdin, resources and names, or by resources and label selector
* [kubectl describe](../kubectl_describe/) - Show details of a specific resource or group of resources
* [kubectl diff](../kubectl_diff/) - Diff the live version against a would-be applied version
* [kubectl drain](../kubectl_drain/) - Drain node in preparation for maintenance
* [kubectl edit](../kubectl_edit/) - Edit a resource on the server
* [kubectl events](../kubectl_events/) - List events
* [kubectl exec](../kubectl_exec/) - Execute a command in a container
* [kubectl explain](../kubectl_explain/) - Get documentation for a resource
* [kubectl expose](../kubectl_expose/) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes service
* [kubectl get](../kubectl_get/) - Display one or many resources
* [kubectl kustomize](../kubectl_kustomize/) - Build a kustomization target from a directory or URL
* [kubectl label](../kubectl_label/) - Update the labels on a resource
* [kubectl logs](../kubectl_logs/) - Print the logs for a container in a pod
* [kubectl options](../kubectl_options/) - Print the list of flags inherited by all commands
* [kubectl patch](../kubectl_patch/) - Update fields of a resource
* [kubectl plugin](../kubectl_plugin/) - Provides utilities for interacting with plugins
* [kubectl port-forward](../kubectl_port-forward/) - Forward one or more local ports to a pod
* [kubectl proxy](../kubectl_proxy/) - Run a proxy to the Kubernetes API server
* [kubectl replace](../kubectl_replace/) - Replace a resource by file name or stdin
* [kubectl rollout](../kubectl_rollout/) - Manage the rollout of a resource
* [kubectl run](../kubectl_run/) - Run a particular image on the cluster
* [kubectl scale](../kubectl_scale/) - Set a new size for a deployment, replica set, or replication controller
* [kubectl set](../kubectl_set/) - Set specific features on objects
* [kubectl taint](../kubectl_taint/) - Update the taints on one or more nodes
* [kubectl top](../kubectl_top/) - Display resource (CPU/memory) usage
* [kubectl uncordon](../kubectl_uncordon/) - Mark node as schedulable
* [kubectl version](../kubectl_version/) - Print the client and server version information
* [kubectl wait](../kubectl_wait/) - Experimental: Wait for a specific condition on one or many resources

0 comments on commit 7100b9c

Please sign in to comment.