1OC EX(1) June 2016 OC EX(1)
2
6 oc ex ipfailover - Install an IP failover group to a set of nodes
7
11 oc ex ipfailover [OPTIONS]
12
16 Configure or view IP Failover configuration
17 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 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
35 --check-interval=2
36 Run the check-script at this interval (seconds)
37 --check-script=""
40 Run this script at the check-interval to verify service is OK
41 --create=false
44 If true, create the configuration if it does not exist.
45 --dry-run=false
48 If true, show the result of the operation without performing it.
49 --images="openshift/origin-${component}:${version}"
52 The image to base this IP failover configurator on - ${component}
53 will be replaced based on --type.
54 -i, --interface=""
57 Network interface bound by VRRP to use for the set of virtual IP
58 ranges/addresses specified.
59 --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 --latest-images=false
68 If true, attempt to use the latest images instead of the current
69 release
70 --notify-script=""
73 Run this script when state changes.
74 -o, --output=""
77 Output results as yaml or json instead of executing, or use name
78 for succint output (resource/name).
79 --output-version=""
82 The preferred API versions of the output objects
83 --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 -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 -l, --selector="ipfailover=<name>"
100 Selector (label query) to filter nodes on.
101 --service-account="ipfailover"
104 Name of the service account to use to run the ipfailover pod.
105 -a, --show-all=false
108 When printing, show all resources (default hide terminated pods.)
109 --show-labels=false
112 When printing, show all labels as the last column (default hide
113 labels column)
114 --sort-by=""
117 If non-empty, sort list types using this field specification. The
118 field specification is expressed as a JSONPath expression (e.g.
119 '{.metadata.name}'). The field in the API resource specified by this
120 JSONPath expression must be an integer or a string.
121 --template=""
124 Template string or path to template file to use when -o=go-tem‐
125 plate, -o=go-template-file. The template format is golang templates [
126 ⟨http://golang.org/pkg/text/template/#pkg-overview⟩].
127 --type="keepalived"
130 The type of IP failover configurator to use.
131 --virtual-ip-groups=0
134 Number of groups to create for VRRP, if not set a group will be
135 created for each virtual ip given on --virtual-ips.
136 --virtual-ips=""
139 A set of virtual IP ranges and/or addresses that the routers bind
140 and serve on and provide IP failover capability for.
141 --vrrp-id-offset=0
144 Offset to use for setting ids of VRRP instances (default offset is
145 0). This allows multiple ipfailover instances to run within the same
146 cluster.
147 -w, --watch-port=80
150 Port to monitor or watch for resource availability.
151
155 --allow_verification_with_non_compliant_keys=false
156 Allow a SignatureVerifier to use keys which are technically
157 non-compliant with RFC6962.
158 --alsologtostderr=false
161 log to standard error as well as files
162 --application_metrics_count_limit=100
165 Max number of application metrics to store (per container)
166 --as=""
169 Username to impersonate for the operation
170 --as-group=[]
173 Group to impersonate for the operation, this flag can be repeated
174 to specify multiple groups.
175 --azure-container-registry-config=""
178 Path to the file containing Azure container registry configuration
179 information.
180 --boot_id_file="/proc/sys/kernel/random/boot_id"
183 Comma-separated list of files to check for boot-id. Use the first
184 one that exists.
185 --cache-dir="/builddir/.kube/http-cache"
188 Default HTTP cache directory
189 --certificate-authority=""
192 Path to a cert file for the certificate authority
193 --client-certificate=""
196 Path to a client certificate file for TLS
197 --client-key=""
200 Path to a client key file for TLS
201 --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
204 CIDRs opened in GCE firewall for LB traffic proxy health checks
205 --cluster=""
208 The name of the kubeconfig cluster to use
209 --container_hints="/etc/cadvisor/container_hints.json"
212 location of the container hints file
213 --containerd="unix:///var/run/containerd.sock"
216 containerd endpoint
217 --context=""
220 The name of the kubeconfig context to use
221 --default-not-ready-toleration-seconds=300
224 Indicates the tolerationSeconds of the toleration for
225 notReady:NoExecute that is added by default to every pod that does not
226 already have such a toleration.
227 --default-unreachable-toleration-seconds=300
230 Indicates the tolerationSeconds of the toleration for unreach‐
231 able:NoExecute that is added by default to every pod that does not
232 already have such a toleration.
233 --docker="unix:///var/run/docker.sock"
236 docker endpoint
237 --docker-tls=false
240 use TLS to connect to docker
241 --docker-tls-ca="ca.pem"
244 path to trusted CA
245 --docker-tls-cert="cert.pem"
248 path to client certificate
249 --docker-tls-key="key.pem"
252 path to private key
253 --docker_env_metadata_whitelist=""
256 a comma-separated list of environment variable keys that needs to
257 be collected for docker containers
258 --docker_only=false
261 Only report docker containers in addition to root stats
262 --docker_root="/var/lib/docker"
265 DEPRECATED: docker root is read from docker info (this is a fall‐
266 back, default: /var/lib/docker)
267 --enable_load_reader=false
270 Whether to enable cpu load reader
271 --event_storage_age_limit="default=24h"
274 Max length of time for which to store events (per type). Value is a
275 comma separated list of key values, where the keys are event types
276 (e.g.: creation, oom) or "default" and the value is a duration. Default
277 is applied to all non-specified event types
278 --event_storage_event_limit="default=100000"
281 Max number of events to store (per type). Value is a comma sepa‐
282 rated list of key values, where the keys are event types (e.g.: cre‐
283 ation, oom) or "default" and the value is an integer. Default is
284 applied to all non-specified event types
285 --global_housekeeping_interval=0
288 Interval between global housekeepings
289 --housekeeping_interval=0
292 Interval between container housekeepings
293 --insecure-skip-tls-verify=false
296 If true, the server's certificate will not be checked for validity.
297 This will make your HTTPS connections insecure
298 --kubeconfig=""
301 Path to the kubeconfig file to use for CLI requests.
302 --log-flush-frequency=0
305 Maximum number of seconds between log flushes
306 --log_backtrace_at=:0
309 when logging hits line file:N, emit a stack trace
310 --log_cadvisor_usage=false
313 Whether to log the usage of the cAdvisor container
314 --log_dir=""
317 If non-empty, write log files in this directory
318 --logtostderr=true
321 log to standard error instead of files
322 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
325 Comma-separated list of files to check for machine-id. Use the
326 first one that exists.
327 --match-server-version=false
330 Require server version to match client version
331 -n, --namespace=""
334 If present, the namespace scope for this CLI request
335 --request-timeout="0"
338 The length of time to wait before giving up on a single server
339 request. Non-zero values should contain a corresponding time unit (e.g.
340 1s, 2m, 3h). A value of zero means don't timeout requests.
341 -s, --server=""
344 The address and port of the Kubernetes API server
345 --stderrthreshold=2
348 logs at or above this threshold go to stderr
349 --storage_driver_buffer_duration=0
352 Writes in the storage driver will be buffered for this duration,
353 and committed to the non memory backends as a single transaction
354 --storage_driver_db="cadvisor"
357 database name
358 --storage_driver_host="localhost:8086"
361 database host:port
362 --storage_driver_password="root"
365 database password
366 --storage_driver_secure=false
369 use secure connection with database
370 --storage_driver_table="stats"
373 table name
374 --storage_driver_user="root"
377 database username
378 --token=""
381 Bearer token for authentication to the API server
382 --user=""
385 The name of the kubeconfig user to use
386 -v, --v=0
389 log level for V logs
390 --version=false
393 Print version information and quit
394 --vmodule=
397 comma-separated list of pattern=N settings for file-filtered log‐
398 ging
399
403 # Check the default IP failover configuration ("ipfailover"):
404 oc ex ipfailover
405 # See what the IP failover configuration would look like if it is created:
407 oc ex ipfailover -o json
408 # Create an IP failover configuration if it does not already exist:
410 oc ex ipfailover ipf --virtual-ips="10.1.1.1-4" --create
411 # Create an IP failover configuration on a selection of nodes labeled
413 # "router=us-west-ha" (on 4 nodes with 7 virtual IPs monitoring a service
414 # listening on port 80, such as the router process).
415 oc ex 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
416 # Use a different IP failover config image and see the configuration:
418 oc ex ipfailover ipf-alt --selector="hagroup=us-west-ha" --virtual-ips="1.2.3.4" -o yaml --images=myrepo/myipfailover:mytag
419
424 oc-ex(1),
425
429 June 2016, Ported from the Kubernetes man-doc generator
430Openshift Openshift CLI User Manuals OC EX(1)