mirror of https://github.com/k3s-io/k3s
137 lines
5.1 KiB
YAML
137 lines
5.1 KiB
YAML
name: convert
|
|
synopsis: Convert config files between different API versions
|
|
description: |
|
|
Convert config files between different API versions. Both YAML
|
|
and JSON formats are accepted.
|
|
|
|
The command takes filename, directory, or URL as input, and convert it into format
|
|
of version specified by --output-version flag. If target version is not specified or
|
|
not supported, convert to latest version.
|
|
|
|
The default output will be printed to stdout in YAML format. One can use -o option
|
|
to change to output destination.
|
|
options:
|
|
- name: filename
|
|
shorthand: f
|
|
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: |
|
|
If true, convert will NOT try to contact api-server but run locally.
|
|
- name: no-headers
|
|
default_value: "false"
|
|
usage: When using the default output, don't print headers.
|
|
- name: output
|
|
shorthand: o
|
|
usage: |
|
|
Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md].
|
|
- 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: |
|
|
If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
|
- name: show-all
|
|
shorthand: a
|
|
default_value: "false"
|
|
usage: |
|
|
When printing, show all resources (default hide terminated pods.)
|
|
- name: show-labels
|
|
default_value: "false"
|
|
usage: |
|
|
When printing, show all labels as the last column (default hide labels column)
|
|
- name: sort-by
|
|
usage: |
|
|
If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
|
- name: template
|
|
usage: |
|
|
Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
|
- name: validate
|
|
default_value: "true"
|
|
usage: |
|
|
If true, use a schema to validate the input before sending it
|
|
inherited_options:
|
|
- name: alsologtostderr
|
|
default_value: "false"
|
|
usage: log to standard error as well as files
|
|
- name: api-version
|
|
usage: |
|
|
DEPRECATED: The API version to use when talking to the server
|
|
- name: as
|
|
usage: Username to impersonate for the operation.
|
|
- name: certificate-authority
|
|
usage: Path to a cert. file for the certificate authority.
|
|
- name: client-certificate
|
|
usage: Path to a client certificate file for TLS.
|
|
- name: client-key
|
|
usage: Path to a client key file for TLS.
|
|
- name: cluster
|
|
usage: The name of the kubeconfig cluster to use
|
|
- name: context
|
|
usage: The name of the kubeconfig context to use
|
|
- name: insecure-skip-tls-verify
|
|
default_value: "false"
|
|
usage: |
|
|
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
|
|
- name: kubeconfig
|
|
usage: Path to the kubeconfig file to use for CLI requests.
|
|
- name: log-backtrace-at
|
|
default_value: :0
|
|
usage: when logging hits line file:N, emit a stack trace
|
|
- name: log-dir
|
|
usage: If non-empty, write log files in this directory
|
|
- name: log-flush-frequency
|
|
default_value: 5s
|
|
usage: Maximum number of seconds between log flushes
|
|
- name: logtostderr
|
|
default_value: "true"
|
|
usage: log to standard error instead of files
|
|
- name: match-server-version
|
|
default_value: "false"
|
|
usage: Require server version to match client version
|
|
- name: namespace
|
|
usage: If present, the namespace scope for this CLI request.
|
|
- name: password
|
|
usage: Password for basic authentication to the API server.
|
|
- name: server
|
|
shorthand: s
|
|
usage: The address and port of the Kubernetes API server
|
|
- name: stderrthreshold
|
|
default_value: "2"
|
|
usage: logs at or above this threshold go to stderr
|
|
- name: token
|
|
usage: Bearer token for authentication to the API server.
|
|
- name: user
|
|
usage: The name of the kubeconfig user to use
|
|
- name: username
|
|
usage: Username for basic authentication to the API server.
|
|
- name: v
|
|
default_value: "0"
|
|
usage: log level for V logs
|
|
- name: vmodule
|
|
usage: |
|
|
comma-separated list of pattern=N settings for file-filtered logging
|
|
example: |
|
|
# Convert 'pod.yaml' to latest version and print to stdout.
|
|
kubectl convert -f pod.yaml
|
|
|
|
# Convert the live state of the resource specified by 'pod.yaml' to the latest version
|
|
# and print to stdout in json format.
|
|
kubectl convert -f pod.yaml --local -o json
|
|
|
|
# Convert all files under current directory to latest version and create them all.
|
|
kubectl convert -f . | kubectl create -f -
|
|
see_also:
|
|
- kubectl
|