Difference between revisions of "Kubectl rollout pause --help"
Jump to navigation
Jump to search
(2 intermediate revisions by the same user not shown) | |||
Line 6: | Line 6: | ||
Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. | Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. | ||
Currently only [[Kubernetes deployments|deployments]] support being paused. | Currently only [[Kubernetes deployments|deployments]] support being paused. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | Options: | + | Examples: |
+ | # Mark the nginx deployment as paused | ||
+ | # Any current state of the deployment will continue its function; new updates | ||
+ | # to the deployment will not have an effect as long as the deployment is paused | ||
+ | kubectl rollout pause deployment/nginx | ||
+ | |||
+ | Options: | ||
--allow-missing-template-keys=true: | --allow-missing-template-keys=true: | ||
− | + | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to | |
golang and jsonpath output formats. | golang and jsonpath output formats. | ||
--field-manager='kubectl-rollout': | --field-manager='kubectl-rollout': | ||
− | + | Name of the manager used to track field ownership. | |
-f, --filename=[]: | -f, --filename=[]: | ||
− | + | Filename, directory, or URL to files identifying the resource to get from a server. | |
− | + | ||
-k, --kustomize='': | -k, --kustomize='': | ||
− | + | Process the kustomization directory. This flag can't be used together with -f or -R. | |
− | + | ||
-o, --output='': | -o, --output='': | ||
− | + | Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, | |
jsonpath-as-json, jsonpath-file). | jsonpath-as-json, jsonpath-file). | ||
− | + | ||
-R, --recursive=false: | -R, --recursive=false: | ||
− | + | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests | |
organized within the same directory. | organized within the same directory. | ||
− | + | ||
-l, --selector='': | -l, --selector='': | ||
− | + | Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching | |
objects must satisfy all of the specified label constraints. | objects must satisfy all of the specified label constraints. | ||
− | + | ||
− | --show-managed-fields=false: | + | [[--show-managed-fields]]=false: |
− | + | If true, keep the [[managedFields]] when printing objects in JSON or YAML format. | |
--template='': | --template='': | ||
Line 46: | Line 46: | ||
is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | ||
+ | <pre> | ||
Usage: | Usage: | ||
kubectl rollout pause RESOURCE [options] | kubectl rollout pause RESOURCE [options] | ||
Use "kubectl options" for a list of global command-line options (applies to all commands). | Use "kubectl options" for a list of global command-line options (applies to all commands). | ||
− | + | your-user@your-server reputation % kubectl rollout pause --help | prepend_space | |
Mark the provided resource as paused. | Mark the provided resource as paused. | ||
Latest revision as of 20:34, 7 November 2022
kubectl rollout pause --help
Mark the provided resource as paused. Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. Currently only deployments support being paused.
Examples: # Mark the nginx deployment as paused # Any current state of the deployment will continue its function; new updates # to the deployment will not have an effect as long as the deployment is paused kubectl rollout pause deployment/nginx Options: --allow-missing-template-keys=true: If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to
golang and jsonpath output formats.
--field-manager='kubectl-rollout': Name of the manager used to track field ownership.
-f, --filename=[]: Filename, directory, or URL to files identifying the resource to get from a server. -k, --kustomize=: Process the kustomization directory. This flag can't be used together with -f or -R. -o, --output=: Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath,
jsonpath-as-json, jsonpath-file).
-R, --recursive=false: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests
organized within the same directory.
-l, --selector=: Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching
objects must satisfy all of the specified label constraints.
--show-managed-fields=false: If true, keep the managedFields when printing objects in JSON or YAML format.
--template=:
Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [1].
Usage: kubectl rollout pause RESOURCE [options] Use "kubectl options" for a list of global command-line options (applies to all commands). your-user@your-server reputation % kubectl rollout pause --help | prepend_space Mark the provided resource as paused. Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. Currently only deployments support being paused. Examples: # Mark the nginx deployment as paused # Any current state of the deployment will continue its function; new updates # to the deployment will not have an effect as long as the deployment is paused kubectl rollout pause deployment/nginx Options: --allow-missing-template-keys=true: If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. --field-manager='kubectl-rollout': Name of the manager used to track field ownership. -f, --filename=[]: Filename, directory, or URL to files identifying the resource to get from a server. -k, --kustomize='': Process the kustomization directory. This flag can't be used together with -f or -R. -o, --output='': Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). -R, --recursive=false: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -l, --selector='': Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints. --show-managed-fields=false: If true, keep the managedFields when printing objects in JSON or YAML format. --template='': 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]. Usage: kubectl rollout pause RESOURCE [options] Use "kubectl options" for a list of global command-line options (applies to all commands).
See also[edit]
kubectl rollout [ status | restart | resume | pause | history | undo ], kubectl rollout --help
Advertising: