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

NAME

6       oc set route-backends - Update the backends for a route
7
8
9

SYNOPSIS

11       oc set route-backends [OPTIONS]
12
13
14

DESCRIPTION

16       Set and adjust route backends
17
18
19       Routes may have one or more optional backend services with weights con‐
20       trolling how much traffic flows to each service.  Traffic  is  assigned
21       proportional  to the combined weights of each backend. A weight of zero
22       means that the backend will receive no traffic. If all weights are zero
23       the route will not send traffic to any backends.
24
25
26       When  setting  backends, the first backend is the primary and the other
27       backends are considered alternates. For example:
28
29
30       $ oc set route-backends web prod=99 canary=1
31
32
33       will set the primary backend to service "prod" with a weight of 99  and
34       the  first  alternate  backend  to service "canary" with a weight of 1.
35       This means 99% of traffic will be sent to the service "prod".
36
37
38       The --adjust flag allows you to alter the weight of an individual  ser‐
39       vice  relative  to  itself or to the primary backend. Specifying a per‐
40       centage will adjust the backend relative to either the primary  or  the
41       first  alternate (if you specify the primary). If there are other back‐
42       ends their weights will be kept proportional to the changed.
43
44
45       Not all routers may support multiple or weighted backends.
46
47
48

OPTIONS

50       --adjust=false
51           Adjust a single backend using an absolute or  relative  weight.  If
52       the primary backend is selected and there is more than one alternate an
53       error will be returned.
54
55
56       --all=false
57           If true, select all resources in the  namespace  of  the  specified
58       resource types
59
60
61       --allow-missing-template-keys=true
62           If  true, ignore any errors in templates when a field or map key is
63       missing in the template. Only applies to  golang  and  jsonpath  output
64       formats.
65
66
67       --dry-run=false
68           If  true, only print the object that would be sent, without sending
69       it.
70
71
72       --equal=false
73           If true, set the weight of all backends to 100.
74
75
76       -f, --filename=[]
77           Filename, directory, or URL to files to use to edit the resource
78
79
80       --local=false
81           If true, set image will NOT contact api-server but run locally.
82
83
84       -o, --output=""
85           Output format. One of:  json|yaml|name|template|go-template|go-tem‐
86       plate-file|templatefile|jsonpath|jsonpath-file.
87
88
89       -R, --recursive=false
90           Process  the  directory  used in -f, --filename recursively. Useful
91       when you want to manage related manifests  organized  within  the  same
92       directory.
93
94
95       -l, --selector=""
96           Selector (label query) to filter on
97
98
99       --template=""
100           Template  string  or  path  to template file to use when -o=go-tem‐
101       plate, -o=go-template-file. The template format is golang  templates  [
102http://golang.org/pkg/text/template/#pkg-overview⟩].
103
104
105       --zero=false
106           If true, set the weight of all backends to zero.
107
108
109

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

359                # Print the backends on the route 'web'
360                oc set route-backends web
361
362                # Set two backend services on route 'web' with 2/3rds of traffic going to 'a'
363                oc set route-backends web a=2 b=1
364
365                # Increase the traffic percentage going to b by 10% relative to a
366                oc set route-backends web --adjust b=+10%
367
368                # Set traffic percentage going to b to 10% of the traffic going to a
369                oc set route-backends web --adjust b=10%
370
371                # Set weight of b to 10
372                oc set route-backends web --adjust b=10
373
374                # Set the weight to all backends to zero
375                oc set route-backends web --zero
376
377
378
379

SEE ALSO

381       oc-set(1),
382
383
384

HISTORY

386       June 2016, Ported from the Kubernetes man-doc generator
387
388
389
390Openshift                  Openshift CLI User Manuals                OC SET(1)
Impressum