This section provides reference information for all Edge-LB pool configuration settings and examples to demonstrate various use-cases.

Configuration reference

The API reference, in swagger format, can be found by running the command below. It contains all possible options and a short description for each endpoint.

dcos edgelb show --reference

For more information, see the CLI Reference Guide entry for dcos edgelb show.

Choose an API version on the sidebar to view the appropriate configuration reference or examples.

API versions

A new top-level pool configuration field named apiVersion was introduced in Edge-LB v1.0.0. The two models are almost identical, with one important difference: pool.haproxy.backends.servers (in apiVersion V1) has been replaced with pool.haproxy.backends.services, with a more intuitive way to select services/backends for HAProxy.

NOTE: Edge-LB 1.0 and later supports both the V1 and V2 API for backward compatibility. Therefore clients that were written against Edge-LB versions prior to Edge-LB 1.0 should work without any modifications with Edge-LB 1.0 and later. New setups should use API V2 as at some point V1 is going to be deprecated and then removed.

NOTE: The apiVersion field in the pool definition defaults to V2 if it was not provided. Hence, in order to use the V1 config, you must explicitly set the pool.apiVersion to `"V1"`.