OC ADM(1)

NAME

oc adm ipfailover - Install an IP failover group to a set of nodes

SYNOPSIS

oc adm ipfailover [OPTIONS]

DESCRIPTION

Configure or view IP Failover configuration

This command helps to setup an IP failover configuration for the cluster. An administrator can configure IP failover on an entire cluster or on a subset of nodes (as defined via a labeled selector).

If an IP failover configuration does not exist with the given name, the --create flag can be passed to create a deployment configuration that will provide IP failover capability. If you are running in production, it is recommended that the labeled selector for the nodes matches at least 2 nodes to ensure you have failover protection, and that you provide a --replicas=<n> value that matches the number of nodes for the given labeled selector.

OPTIONS

--create=false
    Create the configuration if it does not exist.

--credentials=""
    Path to a .kubeconfig file that will contain the credentials the router should use to contact the master.

--dry-run=false
    If true, show the result of the operation without performing it.

--images="openshift/origin-${component}:${version}"
    The image to base this IP failover configurator on - ${component} will be replaced based on --type.

-i, --interface=""
    Network interface bound by VRRP to use for the set of virtual IP ranges/addresses specified.

--latest-images=false
    If true, attempt to use the latest images instead of the current release

-o, --output=""
    Output results as yaml or json instead of executing, or use name for succint output (resource/name).

--output-version=""
    The preferred API versions of the output objects

-r, --replicas=1
    The replication factor of this IP failover configuration; commonly 2 when high availability is desired. Please ensure this matches the number of nodes that satisfy the selector (or default selector) specified.

-l, --selector="ipfailover=<name>"
    Selector (label query) to filter nodes on.

--service-account="ipfailover"
    Name of the service account to use to run the ipfailover pod.

--type="keepalived"
    The type of IP failover configurator to use.

--virtual-ips=""
    A set of virtual IP ranges and/or addresses that the routers bind and serve on and provide IP failover capability for.

--vrrp-id-offset=0
    Offset to use for setting ids of VRRP instances (default offset is 0). This allows multiple ipfailover instances to run within the same cluster.

-w, --watch-port=80
    Port to monitor or watch for resource availability.

OPTIONS INHERITED FROM PARENT COMMANDS

--api-version=""
    DEPRECATED: The API version to use when talking to the server

--as=""
    Username to impersonate for the operation.

--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.

--context=""
    The name of the kubeconfig context to use

--google-json-key=""
    The Google Cloud Platform Service Account JSON Key to use for authentication.

--insecure-skip-tls-verify=false
    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.

--log-flush-frequency=0
    Maximum number of seconds between log flushes

--match-server-version=false
    Require server version to match client version

-n, --namespace=""
    If present, the namespace scope for this CLI request.

--server=""
    The address and port of the Kubernetes API server

--token=""
    Bearer token for authentication to the API server.

--user=""
    The name of the kubeconfig user to use

EXAMPLE

      # Check the default IP failover configuration ("ipfailover"):
      oc adm ipfailover
      # See what the IP failover configuration would look like if it is created:
      oc adm ipfailover -o json
      # Create an IP failover configuration if it does not already exist:
      oc adm ipfailover ipf --virtual-ips="10.1.1.1-4" --create
      # Create an IP failover configuration on a selection of nodes labeled
      # "router=us-west-ha" (on 4 nodes with 7 virtual IPs monitoring a service
      # listening on port 80, such as the router process).
      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
      # Use a different IP failover config image and see the configuration:
      oc adm ipfailover ipf-alt --selector="hagroup=us-west-ha" --virtual-ips="1.2.3.4" -o yaml --images=myrepo/myipfailover:mytag

SEE ALSO

oc-adm(1),

HISTORY

June 2016, Ported from the Kubernetes man-doc generator