1OC(1)                              June 2016                             OC(1)
2
3
4

NAME

6       oc idle - Idle scalable resources
7
8
9

SYNOPSIS

11       oc idle [OPTIONS]
12
13
14

DESCRIPTION

16       Idle scalable resources
17
18
19       Idling discovers the scalable resources (such as deployment configs and
20       replication controllers) associated with a series of services by  exam‐
21       ining  the  endpoints  of  the  service. Each service is then marked as
22       idled, the associated resources are recorded,  and  the  resources  are
23       scaled down to zero replicas.
24
25
26       Upon  receiving  network  traffic,  the  services  (and  any associated
27       routes) will "wake up" the associated resources by scaling them back up
28       to their previous scale.
29
30
31

OPTIONS

33       --all=false
34           if true, select all services in the namespace
35
36
37       --all-namespaces=false
38           if true, select services across all namespaces
39
40
41       --dry-run=false
42           If  true, only print the annotations that would be written, without
43       annotating or idling the relevant objects
44
45
46       --resource-names-file=""
47           file containing list of services whose scalable resources to idle
48
49
50       -l, --selector=""
51           Selector (label query) to use to select services
52
53
54

OPTIONS INHERITED FROM PARENT COMMANDS

56       --allow_verification_with_non_compliant_keys=false
57           Allow  a  SignatureVerifier  to  use  keys  which  are  technically
58       non-compliant with RFC6962.
59
60
61       --alsologtostderr=false
62           log to standard error as well as files
63
64
65       --application_metrics_count_limit=100
66           Max number of application metrics to store (per container)
67
68
69       --as=""
70           Username to impersonate for the operation
71
72
73       --as-group=[]
74           Group  to  impersonate for the operation, this flag can be repeated
75       to specify multiple groups.
76
77
78       --azure-container-registry-config=""
79           Path to the file containing Azure container registry  configuration
80       information.
81
82
83       --boot_id_file="/proc/sys/kernel/random/boot_id"
84           Comma-separated  list  of files to check for boot-id. Use the first
85       one that exists.
86
87
88       --cache-dir="/builddir/.kube/http-cache"
89           Default HTTP cache directory
90
91
92       --certificate-authority=""
93           Path to a cert file for the certificate authority
94
95
96       --client-certificate=""
97           Path to a client certificate file for TLS
98
99
100       --client-key=""
101           Path to a client key file for TLS
102
103
104       --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
105           CIDRs opened in GCE firewall for LB traffic proxy  health checks
106
107
108       --cluster=""
109           The name of the kubeconfig cluster to use
110
111
112       --container_hints="/etc/cadvisor/container_hints.json"
113           location of the container hints file
114
115
116       --containerd="unix:///var/run/containerd.sock"
117           containerd endpoint
118
119
120       --context=""
121           The name of the kubeconfig context to use
122
123
124       --default-not-ready-toleration-seconds=300
125           Indicates    the    tolerationSeconds   of   the   toleration   for
126       notReady:NoExecute that is added by default to every pod that does  not
127       already have such a toleration.
128
129
130       --default-unreachable-toleration-seconds=300
131           Indicates  the  tolerationSeconds  of  the  toleration for unreach‐
132       able:NoExecute that is added by default to  every  pod  that  does  not
133       already have such a toleration.
134
135
136       --docker="unix:///var/run/docker.sock"
137           docker endpoint
138
139
140       --docker-tls=false
141           use TLS to connect to docker
142
143
144       --docker-tls-ca="ca.pem"
145           path to trusted CA
146
147
148       --docker-tls-cert="cert.pem"
149           path to client certificate
150
151
152       --docker-tls-key="key.pem"
153           path to private key
154
155
156       --docker_env_metadata_whitelist=""
157           a  comma-separated  list of environment variable keys that needs to
158       be collected for docker containers
159
160
161       --docker_only=false
162           Only report docker containers in addition to root stats
163
164
165       --docker_root="/var/lib/docker"
166           DEPRECATED: docker root is read from docker info (this is  a  fall‐
167       back, default: /var/lib/docker)
168
169
170       --enable_load_reader=false
171           Whether to enable cpu load reader
172
173
174       --event_storage_age_limit="default=24h"
175           Max length of time for which to store events (per type). Value is a
176       comma separated list of key values, where  the  keys  are  event  types
177       (e.g.: creation, oom) or "default" and the value is a duration. Default
178       is applied to all non-specified event types
179
180
181       --event_storage_event_limit="default=100000"
182           Max number of events to store (per type). Value is  a  comma  sepa‐
183       rated  list  of  key values, where the keys are event types (e.g.: cre‐
184       ation, oom) or "default" and  the  value  is  an  integer.  Default  is
185       applied to all non-specified event types
186
187
188       --global_housekeeping_interval=0
189           Interval between global housekeepings
190
191
192       --housekeeping_interval=0
193           Interval between container housekeepings
194
195
196       --httptest.serve=""
197           if non-empty, httptest.NewServer serves on this address and blocks
198
199
200       --insecure-skip-tls-verify=false
201           If true, the server's certificate will not be checked for validity.
202       This will make your HTTPS connections insecure
203
204
205       --kubeconfig=""
206           Path to the kubeconfig file to use for CLI requests.
207
208
209       --log-flush-frequency=0
210           Maximum number of seconds between log flushes
211
212
213       --log_backtrace_at=:0
214           when logging hits line file:N, emit a stack trace
215
216
217       --log_cadvisor_usage=false
218           Whether to log the usage of the cAdvisor container
219
220
221       --log_dir=""
222           If non-empty, write log files in this directory
223
224
225       --logtostderr=true
226           log to standard error instead of files
227
228
229       --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
230           Comma-separated list of files to  check  for  machine-id.  Use  the
231       first one that exists.
232
233
234       --match-server-version=false
235           Require server version to match client version
236
237
238       -n, --namespace=""
239           If present, the namespace scope for this CLI request
240
241
242       --request-timeout="0"
243           The  length  of  time  to  wait before giving up on a single server
244       request. Non-zero values should contain a corresponding time unit (e.g.
245       1s, 2m, 3h). A value of zero means don't timeout requests.
246
247
248       -s, --server=""
249           The address and port of the Kubernetes API server
250
251
252       --stderrthreshold=2
253           logs at or above this threshold go to stderr
254
255
256       --storage_driver_buffer_duration=0
257           Writes  in  the  storage driver will be buffered for this duration,
258       and committed to the non memory backends as a single transaction
259
260
261       --storage_driver_db="cadvisor"
262           database name
263
264
265       --storage_driver_host="localhost:8086"
266           database host:port
267
268
269       --storage_driver_password="root"
270           database password
271
272
273       --storage_driver_secure=false
274           use secure connection with database
275
276
277       --storage_driver_table="stats"
278           table name
279
280
281       --storage_driver_user="root"
282           database username
283
284
285       --token=""
286           Bearer token for authentication to the API server
287
288
289       --user=""
290           The name of the kubeconfig user to use
291
292
293       -v, --v=0
294           log level for V logs
295
296
297       --version=false
298           Print version information and quit
299
300
301       --vmodule=
302           comma-separated list of pattern=N settings for  file-filtered  log‐
303       ging
304
305
306

EXAMPLE

308                # Idle the scalable controllers associated with the services listed in to-idle.txt
309                $ oc idle --resource-names-file to-idle.txt
310
311
312
313

SEE ALSO

315       oc(1),
316
317
318

HISTORY

320       June 2016, Ported from the Kubernetes man-doc generator
321
322
323
324Openshift                  Openshift CLI User Manuals                    OC(1)
Impressum