109 lines
4.8 KiB
YAML
109 lines
4.8 KiB
YAML
name: kubectl-kruise rollout pause
|
|
synopsis: Mark the provided resource as paused
|
|
description: |-
|
|
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 deployments, clonesets, rollouts support being paused.
|
|
usage: kubectl-kruise rollout pause RESOURCE
|
|
options:
|
|
- name: allow-missing-template-keys
|
|
default_value: "true"
|
|
usage: |
|
|
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.
|
|
- name: filename
|
|
shorthand: f
|
|
default_value: '[]'
|
|
usage: |
|
|
Filename, directory, or URL to files identifying the resource to get from a server.
|
|
- name: help
|
|
shorthand: h
|
|
default_value: "false"
|
|
usage: help for pause
|
|
- name: kustomize
|
|
shorthand: k
|
|
usage: |
|
|
Process the kustomization directory. This flag can't be used together with -f or -R.
|
|
- name: output
|
|
shorthand: o
|
|
usage: |
|
|
Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
|
|
- name: recursive
|
|
shorthand: R
|
|
default_value: "false"
|
|
usage: |
|
|
Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
|
- name: show-managed-fields
|
|
default_value: "false"
|
|
usage: |
|
|
If true, keep the managedFields when printing objects in JSON or YAML format.
|
|
- 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].
|
|
inherited_options:
|
|
- name: as
|
|
usage: |
|
|
Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
|
|
- name: as-group
|
|
default_value: '[]'
|
|
usage: |
|
|
Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
|
|
- name: as-uid
|
|
usage: UID to impersonate for the operation.
|
|
- name: cache-dir
|
|
default_value: $HOME/.kube/cache
|
|
usage: Default cache directory
|
|
- 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: match-server-version
|
|
default_value: "false"
|
|
usage: Require server version to match client version
|
|
- name: namespace
|
|
shorthand: "n"
|
|
usage: If present, the namespace scope for this CLI request
|
|
- name: password
|
|
usage: Password for basic authentication to the API server
|
|
- name: profile
|
|
default_value: none
|
|
usage: |
|
|
Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)
|
|
- name: profile-output
|
|
default_value: profile.pprof
|
|
usage: Name of the file to write the profile to
|
|
- name: request-timeout
|
|
default_value: "0"
|
|
usage: |
|
|
The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.
|
|
- name: server
|
|
shorthand: s
|
|
usage: The address and port of the Kubernetes API server
|
|
- name: tls-server-name
|
|
usage: |
|
|
Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
|
|
- 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: warnings-as-errors
|
|
default_value: "false"
|
|
usage: |
|
|
Treat warnings received from the server as errors and exit with a non-zero exit code
|
|
example: " # Mark the nginx deployment as paused. Any current state of\n # the deployment will continue its function, new updates to the deployment will not\n # have an effect as long as the deployment is paused.\n \n kubectl-kruise rollout pause deployment/nginx"
|
|
see_also:
|
|
- kubectl-kruise rollout - Manage the rollout of a resource
|