Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

load_balancing: support least_outstanding_requests steering policy #1293

Merged
merged 1 commit into from
Jun 7, 2023
Merged

load_balancing: support least_outstanding_requests steering policy #1293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/1293.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
load_balancing: extend documentation for least_outstanding_requests steering policy
```
40 changes: 32 additions & 8 deletions load_balancing.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,31 @@ type LoadBalancerPool struct {

// LoadBalancerOrigin represents a Load Balancer origin's properties.
type LoadBalancerOrigin struct {
Name string `json:"name"`
Address string `json:"address"`
Enabled bool `json:"enabled"`
Weight float64 `json:"weight"`
Header map[string][]string `json:"header"`
Name string `json:"name"`
Address string `json:"address"`
Enabled bool `json:"enabled"`
// Weight of this origin relative to other origins in the pool.
// Based on the configured weight the total traffic is distributed
// among origins within the pool.
//
// When LoadBalancerOriginSteering.Policy="least_outstanding_requests", this
// weight is used to scale the origin's outstanding requests.
Weight float64 `json:"weight"`
Header map[string][]string `json:"header"`
}

// LoadBalancerOriginSteering controls origin selection for new sessions and traffic without session affinity.
type LoadBalancerOriginSteering struct {
// Policy defaults to "random" (weighted) when empty or unspecified.
// Policy determines the type of origin steering policy to use.
// It defaults to "random" (weighted) when empty or unspecified.
//
// "random": Select an origin randomly.
//
// "hash": Select an origin by computing a hash over the CF-Connecting-IP address.
//
// "least_outstanding_requests": Select an origin by taking into consideration origin weights,
// as well as each origin's number of outstanding requests. Origins with more pending requests
// are weighted proportionately less relative to others.
Policy string `json:"policy,omitempty"`
}

Expand Down Expand Up @@ -105,6 +120,10 @@ type LoadBalancer struct {
// the Cloudflare PoP location for proxied requests or the location determined by
// LocationStrategy for non-proxied requests.
//
// "least_outstanding_requests": Select a pool by taking into consideration
// RandomSteering weights, as well as each pool's number of outstanding requests.
// Pools with more pending requests are weighted proportionately less relative to others.
//
// "": Maps to "geo" if RegionPools or PopPools or CountryPools have entries otherwise "off".
SteeringPolicy string `json:"steering_policy,omitempty"`
}
Expand Down Expand Up @@ -178,8 +197,13 @@ type LoadBalancerRuleOverrides struct {
LocationStrategy *LocationStrategy `json:"location_strategy,omitempty"`
}

// RandomSteering represents fields used to set pool weights on a load balancer
// with "random" steering policy.
// RandomSteering configures pool weights.
//
// SteeringPolicy="random": A random pool is selected with probability
// proportional to pool weights.
//
// SteeringPolicy="least_outstanding_requests": Use pool weights to
// scale each pool's outstanding requests.
type RandomSteering struct {
DefaultWeight float64 `json:"default_weight,omitempty"`
PoolWeights map[string]float64 `json:"pool_weights,omitempty"`
Expand Down