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

NAME

6       oc adm ipfailover - Install an IP failover group to a set of nodes
7
8
9

SYNOPSIS

11       oc adm ipfailover [OPTIONS]
12
13
14

DESCRIPTION

16       Configure or view IP Failover configuration
17
18
19       This  command helps to setup an IP failover configuration for the clus‐
20       ter. An administrator can configure IP failover on an entire cluster or
21       on a subset of nodes (as defined via a labeled selector).
22
23
24       If an IP failover configuration does not exist with the given name, the
25       --create flag can be passed to create a deployment  configuration  that
26       will  provide IP failover capability. If you are running in production,
27       it is recommended that the labeled selector for the  nodes  matches  at
28       least 2 nodes to ensure you have failover protection, and that you pro‐
29       vide a --replicas= <n> value that matches the number of nodes  for  the
30       given labeled selector.
31
32
33

OPTIONS

35       --check-interval=2
36           Run the check-script at this interval (seconds)
37
38
39       --check-script=""
40           Run this script at the check-interval to verify service is OK
41
42
43       --create=false
44           If true, create the configuration if it does not exist.
45
46
47       --dry-run=false
48           If true, show the result of the operation without performing it.
49
50
51       --images="openshift/origin-${component}:${version}"
52           The  image  to base this IP failover configurator on - ${component}
53       will be replaced based on --type.
54
55
56       -i, --interface=""
57           Network interface bound by VRRP to use for the set  of  virtual  IP
58       ranges/addresses specified.
59
60
61       --iptables-chain="INPUT"
62           Add  a  rule  to this iptables chain to accept 224.0.0.28 multicast
63       packets if no rule exists. When iptables-chain is empty do  not  change
64       iptables.
65
66
67       --latest-images=false
68           If  true,  attempt  to use the latest images instead of the current
69       release
70
71
72       --notify-script=""
73           Run this script when state changes.
74
75
76       -o, --output=""
77           Output results as yaml or json instead of executing,  or  use  name
78       for succint output (resource/name).
79
80
81       --output-version=""
82           The preferred API versions of the output objects
83
84
85       --preemption-strategy="preempt_delay 300"
86           Normlly  VRRP  will  preempt a lower priority machine when a higher
87       priority one  comes  online.  'nopreempt'  allows  the  lower  priority
88       machine  to maintain its MASTER status. The default 'preempt_delay 300'
89       causes MASTER to switch after 5 min.
90
91
92       -r, --replicas=1
93           The replication factor of this IP failover configuration;  commonly
94       2  when  high  availability  is desired. Please ensure this matches the
95       number of nodes that satisfy the selector (or default selector)  speci‐
96       fied.
97
98
99       -l, --selector="ipfailover=<name>"
100           Selector (label query) to filter nodes on.
101
102
103       --service-account="ipfailover"
104           Name of the service account to use to run the ipfailover pod.
105
106
107       -a, --show-all=true
108           When  printing,  show  all  resources  (false means hide terminated
109       pods.)
110
111
112       --show-labels=false
113           When printing, show all labels as the  last  column  (default  hide
114       labels column)
115
116
117       --sort-by=""
118           If  non-empty, sort list types using this field specification.  The
119       field  specification  is  expressed  as  a  JSONPath  expression  (e.g.
120       '{.metadata.name}').  The  field  in the API resource specified by this
121       JSONPath expression must be an integer or a string.
122
123
124       --template=""
125           Template string or path to template file  to  use  when  -o=go-tem‐
126       plate,  -o=go-template-file.  The template format is golang templates [
127http://golang.org/pkg/text/template/#pkg-overview⟩].
128
129
130       --type="keepalived"
131           The type of IP failover configurator to use.
132
133
134       --virtual-ip-groups=0
135           Number of groups to create for VRRP, if not set  a  group  will  be
136       created for each virtual ip given on --virtual-ips.
137
138
139       --virtual-ips=""
140           A  set  of virtual IP ranges and/or addresses that the routers bind
141       and serve on and provide IP failover capability for.
142
143
144       --vrrp-id-offset=0
145           Offset to use for setting ids of VRRP instances (default offset  is
146       0).  This  allows  multiple ipfailover instances to run within the same
147       cluster.
148
149
150       -w, --watch-port=80
151           Port to monitor or watch for resource availability.
152
153
154

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

404                # Check the default IP failover configuration ("ipfailover"):
405                oc adm ipfailover
406
407                # See what the IP failover configuration would look like if it is created:
408                oc adm ipfailover -o json
409
410                # Create an IP failover configuration if it does not already exist:
411                oc adm ipfailover ipf --virtual-ips="10.1.1.1-4" --create
412
413                # Create an IP failover configuration on a selection of nodes labeled
414                # "router=us-west-ha" (on 4 nodes with 7 virtual IPs monitoring a service
415                # listening on port 80, such as the router process).
416                oc adm ipfailover ipfailover --selector="router=us-west-ha" --virtual-ips="1.2.3.4,10.1.1.100-104,5.6.7.8" --watch-port=80 --replicas=4 --create
417
418                # Use a different IP failover config image and see the configuration:
419                oc adm ipfailover ipf-alt --selector="hagroup=us-west-ha" --virtual-ips="1.2.3.4" -o yaml --images=myrepo/myipfailover:mytag
420
421
422
423

SEE ALSO

425       oc-adm(1),
426
427
428

HISTORY

430       June 2016, Ported from the Kubernetes man-doc generator
431
432
433
434Openshift                  Openshift CLI User Manuals                OC ADM(1)
Impressum