Generic Per-Route Options incl. Load Balancing Algorithm

Dariquest commented 4 months ago

Summary

Detailed specification including that of for all the involved components is provided in the RFC

Route definition is extended by generic options map with a load balancing algorithm. Options can be optionally specified in the following way with a json key lb_algo for the load balancing algorithm, e.g.

{
  "host": "127.0.0.1",
  "port": 4567,
  "protocol": "http1",
  "uris": ["url.localhost.routing.cf-app.com"],
  "options": {
    "lb_algo": "least-connection"
  },
  "app": "some_app_guid",
  "stale_threshold_in_seconds": 120,
  "server_cert_domain_san": "some_subject_alternative_name"
}

Supported load-balancing algorithms are specified in the Gorouter configuration in the LoadBalancingStrategies list. If a load balancing algorithm, provided for a route, is not in this configured list, the pool load balancing algorithm is kept and the error invalid-endpoint-load-balancing-algorithm-provided-keeping-pool-lb-algo is logged.

RegistryMessage structure is extended by an Options field of type RegistryMessageOpts structure, currently only containing the LoadBalancingAlgorithm field. Endpoint structure is extended by LoadBalancingAlgorithm field.

When initialising new endpoints, the load balancing algorithm is initialised to the value from the corresponding registry message option. When endpoints are registered and added to the pool, the load balancing algorithm of a pool is set to that one of a new endpoint.

RouteRegistry structure is extended by a new field DefaultLoadBalancingAlgorithm, which is initialised by the Gorouter default load balancing configuration property LoadBalance. This default value is a default load balancing algorithm for a new pool.

Since the route options are optional, not providing them has no effect on the existing default load balancing algorithm logic.

Backward Compatibility

Breaking Change? No

Check list

[x] Read the Contributing document
[x] I have viewed signed and have submitted the Contributor License Agreement
[x] I have made this pull request to the main branch
[x] I have run all the unit tests.

Resolves: cloudfoundry/routing-release#421

linux-foundation-easycla[bot] commented 4 months ago

The committers listed above are authorized under a signed CLA.

:white_check_mark: login: Dariquest / name: Daria (1025d7fd61876149d084c3f3dfda283402705e18, 116b2617577ddd2a9c2778e39f25031c4d0f4bb1, ddc45c3abd55ed3a5310bfec8192109791be8aa1, 0bc1f945eb6b4e9a48319a76742aae23d552be5b, ad78583524322780ac4b902693e75d067599bd60, 661e71909ecd809bd66bf44be356878010481585, 3ec1d821cf30a8c4d940382b4175bb027a069239, b63dafd0eb87dd3af73250c1553d95de122c5ef5, 36fe4a2827a43ccc688219bac8b5b14520a49c3e, 4ba2c19948123c0d7ebdb5f6c70203ab3f5a352a, 265708f9c1bb2c76f41085731e7b755589d4bf84, bdf44406e0a5303fe87592745077172a92f2a574, 88bffcc0c046eaed1767e493a0b6413826152137, 4275c3890d6ca51b3da27efc603f15f2490f757a, 2a773d074e597452992c9287255b8f9844b61472, d2c1fcef784d4eadce450570e61d406f83cae7fe, a1d4b2329e3a454cc3939d80833857dc8b3e3e10, 13ae338d696bca36f1179e8c6470de5588f9a505, 2d758bf7d48095e3825e109edabd8744796c2333, e2bc91e24987560b8ca02c4ebeb3ba0c752e6391, b5852cbf70e64ed5b4eacc2b11f544a4395f1cff, 1b5eb7bc0861bc9058867ff29cdd913b7e4d9da4, 87e9194a31e150368a1b1a01ffc2dd20740f0354, 0b2350454a9178d1ce61eb1f1f1fabd429a55ab8, c1e1f78ffff1aece056c444b6d2fd3807ea9f25a, f5dfd0c5ab1079c60452fae9a37eddfb3d8b6375, 82008c2c990c0d77d46d0d5d30955b1d70cce250, 2e926ac8d1232c97ba94f10af5fe42d8940b8038, e087a74210922365b4febcc7f2d480f0ec7889b4, 4f11cc7b8e49b9d36fac66f386d25fd41462aa89, 95970a316938ab04851c4175ae0c99f2504e5ac3, c38098970035c4dbd0efb3c2f46f1a2f806551e8, 51cadeb8384377f7df8ddac7f59251e453a20330)

Dariquest commented 3 months ago

Corresponding issue https://github.com/cloudfoundry/routing-release/issues/421

Dariquest commented 3 months ago

Found a small typo, looks good overall.

@stefanlay Thanks!

cloudfoundry / gorouter