openshift-kube-rollout-pause man page

openshift kube rollout pause — Mark the provided resource as paused

Synopsis

openshift kube rollout pause [Options]

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 only deployments support being paused.

Options

-f, --filename=[]
   Filename, directory, or URL to a file identifying the resource to get from a server.
-R, --recursive=false
   Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.

Options Inherited from Parent Commands

--allow-verification-with-non-compliant-keys=false
   Allow a SignatureVerifier to use keys which are technically non-compliant with RFC6962.
--alsologtostderr=false
   log to standard error as well as files
--api-version=""
   DEPRECATED: The API version to use when talking to the server
--application-metrics-count-limit=100
   Max number of application metrics to store (per container)
--as=""
   Username to impersonate for the operation
--boot-id-file="/proc/sys/kernel/random/boot_id"
   Comma-separated list of files to check for boot-id. Use the first one that exists.
--certificate-authority=""
   Path to a cert. file for the certificate authority
--client-certificate=""
   Path to a client certificate file for TLS
--client-key=""
   Path to a client key file for TLS
--cluster=""
   The name of the kubeconfig cluster to use
--config=""
   Path to the config file to use for CLI requests.
--container-hints="/etc/cadvisor/container_hints.json"
   location of the container hints file
--context=""
   The name of the kubeconfig context to use
--docker="unix:///var/run/docker.sock"
   docker endpoint
--docker-env-metadata-whitelist=""
   a comma-separated list of environment variable keys that needs to be collected for docker containers
--docker-only=false
   Only report docker containers in addition to root stats
--docker-root="/var/lib/docker"
   DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)
--enable-load-reader=false
   Whether to enable cpu load reader
--event-storage-age-limit="default=0"
   Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types
--event-storage-event-limit="default=0"
   Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types
--global-housekeeping-interval=0
   Interval between global housekeepings
--google-json-key=""
   The Google Cloud Platform Service Account JSON Key to use for authentication.
--housekeeping-interval=0
   Interval between container housekeepings
--httptest.serve=""
   if non-empty, httptest.NewServer serves on this address and blocks
--insecure-skip-tls-verify=false
   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--ir-data-source="influxdb"
   Data source used by InitialResources. Supported options: influxdb, gcm.
--ir-dbname="k8s"
   InfluxDB database name which contains metrics requred by InitialResources
--ir-hawkular=""
   Hawkular configuration URL
--ir-influxdb-host="localhost:8080/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb:api"
   Address of InfluxDB which contains metrics requred by InitialResources
--ir-namespace-only=false
   Whether the estimation should be made only based on data from the same namespace.
--ir-password="root"
   Password used for connecting to InfluxDB
--ir-percentile=90
   Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.
--ir-user="root"
   User used for connecting to InfluxDB
--kubeconfig=""
   Specify a kubeconfig file to define the configuration
--log-backtrace-at=:0
   when logging hits line file:N, emit a stack trace
--log-cadvisor-usage=false
   Whether to log the usage of the cAdvisor container
--log-dir=""
   If non-empty, write log files in this directory
--log-flush-frequency=0
   Maximum number of seconds between log flushes
--logtostderr=true
   log to standard error instead of files
--machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
   Comma-separated list of files to check for machine-id. Use the first one that exists.
--match-server-version=false
   Require server version to match client version
-n, --namespace=""
   If present, the namespace scope for this CLI request
--request-timeout="0"
   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.
--server=""
   The address and port of the Kubernetes API server
--stderrthreshold=2
   logs at or above this threshold go to stderr
--storage-driver-buffer-duration=0
   Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction
--storage-driver-db="cadvisor"
   database name
--storage-driver-host="localhost:8086"
   database host:port
--storage-driver-password="root"
   database password
--storage-driver-secure=false
   use secure connection with database
--storage-driver-table="stats"
   table name
--storage-driver-user="root"
   database username
--token=""
   Bearer token for authentication to the API server
--user=""
   The name of the kubeconfig user to use
-v, --v=0
   log level for V logs
--vmodule=
   comma-separated list of pattern=N settings for file-filtered logging

Example

# 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

See Also

openshift-kube-rollout(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-kube-rollout(1).

Openshift CLI User Manuals June 2016