Skip to content

Commit 7100b9c

Browse files
committed
Revise kubectl reference layout
The reference is generated using an improve version of component reference generator (kubernetes-sigs/reference-docs#349).
1 parent f5e1703 commit 7100b9c

File tree

110 files changed

+5571
-1146
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+5571
-1146
lines changed

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

Lines changed: 93 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The file is auto-generated from the Go source code of the component using a gene
1111
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
1212
to generate the reference documentation, please read
1313
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
14-
To update the reference content, please follow the
14+
To update the reference content, please follow the
1515
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
1616
guide. You can file document formatting bugs against the
1717
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
@@ -213,6 +213,55 @@ kubectl [flags]
213213
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
214214
</tr>
215215

216+
<tr>
217+
<td colspan="2">--storage-driver-buffer-duration duration&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 1m0s</td>
218+
</tr>
219+
<tr>
220+
<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>
221+
</tr>
222+
223+
<tr>
224+
<td colspan="2">--storage-driver-db string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "cadvisor"</td>
225+
</tr>
226+
<tr>
227+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
228+
</tr>
229+
230+
<tr>
231+
<td colspan="2">--storage-driver-host string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "localhost:8086"</td>
232+
</tr>
233+
<tr>
234+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
235+
</tr>
236+
237+
<tr>
238+
<td colspan="2">--storage-driver-password string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "root"</td>
239+
</tr>
240+
<tr>
241+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
242+
</tr>
243+
244+
<tr>
245+
<td colspan="2">--storage-driver-secure</td>
246+
</tr>
247+
<tr>
248+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
249+
</tr>
250+
251+
<tr>
252+
<td colspan="2">--storage-driver-table string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "stats"</td>
253+
</tr>
254+
<tr>
255+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
256+
</tr>
257+
258+
<tr>
259+
<td colspan="2">--storage-driver-user string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "root"</td>
260+
</tr>
261+
<tr>
262+
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
263+
</tr>
264+
216265
<tr>
217266
<td colspan="2">--tls-server-name string</td>
218267
</tr>
@@ -262,47 +311,47 @@ kubectl [flags]
262311

263312
## {{% heading "seealso" %}}
264313

265-
* [kubectl annotate](kubectl_annotate/) - Update the annotations on a resource
266-
* [kubectl api-resources](kubectl_api-resources/) - Print the supported API resources on the server
267-
* [kubectl api-versions](kubectl_api-versions/) - Print the supported API versions on the server, in the form of "group/version"
268-
* [kubectl apply](kubectl_apply/) - Apply a configuration to a resource by file name or stdin
269-
* [kubectl attach](kubectl_attach/) - Attach to a running container
270-
* [kubectl auth](kubectl_auth/) - Inspect authorization
271-
* [kubectl autoscale](kubectl_autoscale/) - Auto-scale a deployment, replica set, stateful set, or replication controller
272-
* [kubectl certificate](kubectl_certificate/) - Modify certificate resources
273-
* [kubectl cluster-info](kubectl_cluster-info/) - Display cluster information
274-
* [kubectl completion](kubectl_completion/) - Output shell completion code for the specified shell (bash, zsh, fish, or powershell)
275-
* [kubectl config](kubectl_config/) - Modify kubeconfig files
276-
* [kubectl cordon](kubectl_cordon/) - Mark node as unschedulable
277-
* [kubectl cp](kubectl_cp/) - Copy files and directories to and from containers
278-
* [kubectl create](kubectl_create/) - Create a resource from a file or from stdin
279-
* [kubectl debug](kubectl_debug/) - Create debugging sessions for troubleshooting workloads and nodes
280-
* [kubectl delete](kubectl_delete/) - Delete resources by file names, stdin, resources and names, or by resources and label selector
281-
* [kubectl describe](kubectl_describe/) - Show details of a specific resource or group of resources
282-
* [kubectl diff](kubectl_diff/) - Diff the live version against a would-be applied version
283-
* [kubectl drain](kubectl_drain/) - Drain node in preparation for maintenance
284-
* [kubectl edit](kubectl_edit/) - Edit a resource on the server
285-
* [kubectl events](kubectl_events/) - List events
286-
* [kubectl exec](kubectl_exec/) - Execute a command in a container
287-
* [kubectl explain](kubectl_explain/) - Get documentation for a resource
288-
* [kubectl expose](kubectl_expose/) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes service
289-
* [kubectl get](kubectl_get/) - Display one or many resources
290-
* [kubectl kustomize](kubectl_kustomize/) - Build a kustomization target from a directory or URL
291-
* [kubectl label](kubectl_label/) - Update the labels on a resource
292-
* [kubectl logs](kubectl_logs/) - Print the logs for a container in a pod
293-
* [kubectl options](kubectl_options/) - Print the list of flags inherited by all commands
294-
* [kubectl patch](kubectl_patch/) - Update fields of a resource
295-
* [kubectl plugin](kubectl_plugin/) - Provides utilities for interacting with plugins
296-
* [kubectl port-forward](kubectl_port-forward/) - Forward one or more local ports to a pod
297-
* [kubectl proxy](kubectl_proxy/) - Run a proxy to the Kubernetes API server
298-
* [kubectl replace](kubectl_replace/) - Replace a resource by file name or stdin
299-
* [kubectl rollout](kubectl_rollout/) - Manage the rollout of a resource
300-
* [kubectl run](kubectl_run/) - Run a particular image on the cluster
301-
* [kubectl scale](kubectl_scale/) - Set a new size for a deployment, replica set, or replication controller
302-
* [kubectl set](kubectl_set/) - Set specific features on objects
303-
* [kubectl taint](kubectl_taint/) - Update the taints on one or more nodes
304-
* [kubectl top](kubectl_top/) - Display resource (CPU/memory) usage
305-
* [kubectl uncordon](kubectl_uncordon/) - Mark node as schedulable
306-
* [kubectl version](kubectl_version/) - Print the client and server version information
307-
* [kubectl wait](kubectl_wait/) - Experimental: Wait for a specific condition on one or many resources
314+
* [kubectl annotate](../kubectl_annotate/) - Update the annotations on a resource
315+
* [kubectl api-resources](../kubectl_api-resources/) - Print the supported API resources on the server
316+
* [kubectl api-versions](../kubectl_api-versions/) - Print the supported API versions on the server, in the form of "group/version"
317+
* [kubectl apply](../kubectl_apply/) - Apply a configuration to a resource by file name or stdin
318+
* [kubectl attach](../kubectl_attach/) - Attach to a running container
319+
* [kubectl auth](../kubectl_auth/) - Inspect authorization
320+
* [kubectl autoscale](../kubectl_autoscale/) - Auto-scale a deployment, replica set, stateful set, or replication controller
321+
* [kubectl certificate](../kubectl_certificate/) - Modify certificate resources
322+
* [kubectl cluster-info](../kubectl_cluster-info/) - Display cluster information
323+
* [kubectl completion](../kubectl_completion/) - Output shell completion code for the specified shell (bash, zsh, fish, or powershell)
324+
* [kubectl config](../kubectl_config/) - Modify kubeconfig files
325+
* [kubectl cordon](../kubectl_cordon/) - Mark node as unschedulable
326+
* [kubectl cp](../kubectl_cp/) - Copy files and directories to and from containers
327+
* [kubectl create](../kubectl_create/) - Create a resource from a file or from stdin
328+
* [kubectl debug](../kubectl_debug/) - Create debugging sessions for troubleshooting workloads and nodes
329+
* [kubectl delete](../kubectl_delete/) - Delete resources by file names, stdin, resources and names, or by resources and label selector
330+
* [kubectl describe](../kubectl_describe/) - Show details of a specific resource or group of resources
331+
* [kubectl diff](../kubectl_diff/) - Diff the live version against a would-be applied version
332+
* [kubectl drain](../kubectl_drain/) - Drain node in preparation for maintenance
333+
* [kubectl edit](../kubectl_edit/) - Edit a resource on the server
334+
* [kubectl events](../kubectl_events/) - List events
335+
* [kubectl exec](../kubectl_exec/) - Execute a command in a container
336+
* [kubectl explain](../kubectl_explain/) - Get documentation for a resource
337+
* [kubectl expose](../kubectl_expose/) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes service
338+
* [kubectl get](../kubectl_get/) - Display one or many resources
339+
* [kubectl kustomize](../kubectl_kustomize/) - Build a kustomization target from a directory or URL
340+
* [kubectl label](../kubectl_label/) - Update the labels on a resource
341+
* [kubectl logs](../kubectl_logs/) - Print the logs for a container in a pod
342+
* [kubectl options](../kubectl_options/) - Print the list of flags inherited by all commands
343+
* [kubectl patch](../kubectl_patch/) - Update fields of a resource
344+
* [kubectl plugin](../kubectl_plugin/) - Provides utilities for interacting with plugins
345+
* [kubectl port-forward](../kubectl_port-forward/) - Forward one or more local ports to a pod
346+
* [kubectl proxy](../kubectl_proxy/) - Run a proxy to the Kubernetes API server
347+
* [kubectl replace](../kubectl_replace/) - Replace a resource by file name or stdin
348+
* [kubectl rollout](../kubectl_rollout/) - Manage the rollout of a resource
349+
* [kubectl run](../kubectl_run/) - Run a particular image on the cluster
350+
* [kubectl scale](../kubectl_scale/) - Set a new size for a deployment, replica set, or replication controller
351+
* [kubectl set](../kubectl_set/) - Set specific features on objects
352+
* [kubectl taint](../kubectl_taint/) - Update the taints on one or more nodes
353+
* [kubectl top](../kubectl_top/) - Display resource (CPU/memory) usage
354+
* [kubectl uncordon](../kubectl_uncordon/) - Mark node as schedulable
355+
* [kubectl version](../kubectl_version/) - Print the client and server version information
356+
* [kubectl wait](../kubectl_wait/) - Experimental: Wait for a specific condition on one or many resources
308357

0 commit comments

Comments
 (0)