Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include genyaml in update/verify generated docs scripts #24223

Merged
merged 1 commit into from
Apr 14, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions .generated_docs
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,36 @@ docs/user-guide/kubectl/kubectl_run.md
docs/user-guide/kubectl/kubectl_scale.md
docs/user-guide/kubectl/kubectl_uncordon.md
docs/user-guide/kubectl/kubectl_version.md
docs/yaml/kubectl/kubectl.yaml
docs/yaml/kubectl/kubectl_annotate.yaml
docs/yaml/kubectl/kubectl_api-versions.yaml
docs/yaml/kubectl/kubectl_apply.yaml
docs/yaml/kubectl/kubectl_attach.yaml
docs/yaml/kubectl/kubectl_autoscale.yaml
docs/yaml/kubectl/kubectl_cluster-info.yaml
docs/yaml/kubectl/kubectl_config.yaml
docs/yaml/kubectl/kubectl_convert.yaml
docs/yaml/kubectl/kubectl_cordon.yaml
docs/yaml/kubectl/kubectl_create.yaml
docs/yaml/kubectl/kubectl_delete.yaml
docs/yaml/kubectl/kubectl_describe.yaml
docs/yaml/kubectl/kubectl_drain.yaml
docs/yaml/kubectl/kubectl_edit.yaml
docs/yaml/kubectl/kubectl_exec.yaml
docs/yaml/kubectl/kubectl_explain.yaml
docs/yaml/kubectl/kubectl_expose.yaml
docs/yaml/kubectl/kubectl_get.yaml
docs/yaml/kubectl/kubectl_label.yaml
docs/yaml/kubectl/kubectl_logs.yaml
docs/yaml/kubectl/kubectl_namespace.yaml
docs/yaml/kubectl/kubectl_patch.yaml
docs/yaml/kubectl/kubectl_port-forward.yaml
docs/yaml/kubectl/kubectl_proxy.yaml
docs/yaml/kubectl/kubectl_replace.yaml
docs/yaml/kubectl/kubectl_rolling-update.yaml
docs/yaml/kubectl/kubectl_rollout.yaml
docs/yaml/kubectl/kubectl_run.yaml
docs/yaml/kubectl/kubectl_scale.yaml
docs/yaml/kubectl/kubectl_stop.yaml
docs/yaml/kubectl/kubectl_uncordon.yaml
docs/yaml/kubectl/kubectl_version.yaml
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_annotate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ options:
default_value: '[]'
usage: |
Filename, directory, or URL to a file identifying the resource to update the annotation
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: no-headers
default_value: "false"
usage: When using the default output, don't print headers.
Expand All @@ -39,6 +43,10 @@ options:
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: resource-version
usage: |
If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_apply.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,21 @@ options:
default_value: '[]'
usage: |
Filename, directory, or URL to file that contains the configuration to apply
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: output
shorthand: o
usage: |
Output mode. Use "-o name" for shorter output (resource/name).
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: schema-cache-dir
default_value: ~/.kube/schema
usage: |
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_autoscale.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ options:
default_value: horizontalpodautoscaler/v1beta1
usage: |
The name of the API generator to use. Currently there is only 1 generator.
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: max
default_value: "-1"
usage: |
Expand All @@ -48,6 +52,10 @@ options:
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: save-config
default_value: "false"
usage: |
Expand Down
5 changes: 5 additions & 0 deletions docs/yaml/kubectl/kubectl_cluster-info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@ name: cluster-info
synopsis: Display cluster info
description: |
Display addresses of the master and services with label kubernetes.io/cluster-service=true
options:
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
inherited_options:
- name: alsologtostderr
default_value: "false"
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_convert.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ options:
default_value: '[]'
usage: |
Filename, directory, or URL to file to need to get converted.
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: local
default_value: "true"
usage: |
Expand All @@ -30,6 +34,10 @@ options:
- name: output-version
usage: |
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: schema-cache-dir
default_value: ~/.kube/schema
usage: |
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,21 @@ options:
default_value: '[]'
usage: |
Filename, directory, or URL to file to use to create the resource
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: output
shorthand: o
usage: |
Output mode. Use "-o name" for shorter output (resource/name).
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: save-config
default_value: "false"
usage: |
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_delete.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,18 @@ options:
default_value: "false"
usage: |
Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified.
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: output
shorthand: o
usage: |
Output mode. Use "-o name" for shorter output (resource/name).
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: selector
shorthand: l
usage: Selector (label query) to filter on.
Expand Down
10 changes: 9 additions & 1 deletion docs/yaml/kubectl/kubectl_describe.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,22 @@ description: |-
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.
options:
- name: filename
shorthand: f
default_value: '[]'
usage: |
Filename, directory, or URL to a file containing the resource to describe
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: selector
shorthand: l
usage: Selector (label query) to filter on
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_edit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ options:
default_value: '[]'
usage: |
Filename, directory, or URL to file to use to edit the resource
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: output
shorthand: o
default_value: yaml
Expand All @@ -36,6 +40,10 @@ options:
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: save-config
default_value: "false"
usage: |
Expand Down
6 changes: 5 additions & 1 deletion docs/yaml/kubectl/kubectl_explain.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ description: |-
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.
options:
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: recursive
default_value: "false"
usage: Print the fields of fields (Currently only 1 level deep)
Expand Down
6 changes: 5 additions & 1 deletion docs/yaml/kubectl/kubectl_expose.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: expose
synopsis: |
Take a replication controller, service, or pod and expose it as a new Kubernetes Service
Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service
description: "Take a deployment, service, replica set, replication controller, or
pod and expose it as a new Kubernetes service.\n\nLooks up a deployment, service,
replica set, replication controller or pod by name and uses the selector\nfor that
Expand Down Expand Up @@ -64,6 +64,10 @@ options:
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: save-config
default_value: "false"
usage: |
Expand Down
10 changes: 9 additions & 1 deletion docs/yaml/kubectl/kubectl_get.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: |-
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.

By specifying the output as 'template' and providing a Go template as the value
Expand All @@ -25,6 +25,10 @@ options:
default_value: '[]'
usage: |
Filename, directory, or URL to a file identifying the resource to get from a server.
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: label-columns
shorthand: L
default_value: '[]'
Expand All @@ -40,6 +44,10 @@ options:
- name: output-version
usage: |
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: selector
shorthand: l
usage: Selector (label query) to filter on
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_label.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ options:
default_value: '[]'
usage: |
Filename, directory, or URL to a file identifying the resource to update the labels
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: no-headers
default_value: "false"
usage: When using the default output, don't print headers.
Expand All @@ -37,6 +41,10 @@ options:
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: resource-version
usage: |
If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.
Expand Down
4 changes: 4 additions & 0 deletions docs/yaml/kubectl/kubectl_logs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ options:
shorthand: f
default_value: "false"
usage: Specify if the logs should be streamed.
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: interactive
default_value: "false"
usage: If true, prompt the user for input when required.
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_patch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ options:
default_value: '[]'
usage: |
Filename, directory, or URL to a file identifying the resource to update
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: output
shorthand: o
usage: |
Expand All @@ -22,6 +26,10 @@ options:
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: type
default_value: strategic
usage: |
Expand Down
8 changes: 8 additions & 0 deletions docs/yaml/kubectl/kubectl_replace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,21 @@ options:
default_value: "-1"
usage: |
Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative.
- name: include-extended-apis
default_value: "true"
usage: |
If true, include definitions of new APIs via calls to the API server. [default true]
- name: output
shorthand: o
usage: |
Output mode. Use "-o name" for shorter output (resource/name).
- name: record
default_value: "false"
usage: Record current kubectl command in the resource annotation.
- name: recursive
shorthand: R
default_value: "false"
usage: If true, process directory recursively.
- name: save-config
default_value: "false"
usage: |
Expand Down