Skip to content

Commit

Permalink
resource/cloudflare_load_balancer: Add support for session affinity a…
Browse files Browse the repository at this point in the history
…ttributes

Updates the load balancer resource with the ability to manage the
`session_affinity_attributes`.

Documentation: https://api.cloudflare.com/#load-balancers-create-load-balancer
  • Loading branch information
jacobbednarz committed Dec 3, 2020
1 parent a6b657b commit 1216305
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
34 changes: 34 additions & 0 deletions cloudflare/resource_cloudflare_load_balancer.go
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,14 @@ func resourceCloudflareLoadBalancer() *schema.Resource {
ValidateFunc: validation.IntBetween(1800, 604800),
},

"session_affinity_attributes": {
Type: schema.TypeMap,
Optional: true,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},

// nb enterprise only
"pop_pools": {
Type: schema.TypeSet,
Expand Down Expand Up @@ -214,6 +222,10 @@ func resourceCloudflareLoadBalancerCreate(d *schema.ResourceData, meta interface
newLoadBalancer.PersistenceTTL = sessionAffinityTTL.(int)
}

if sessionAffinityAttrs, ok := d.GetOk("session_affinity_attributes"); ok {
newLoadBalancer.SessionAffinityAttributes = expandSessionAffinityAttrs(sessionAffinityAttrs)
}

log.Printf("[INFO] Creating Cloudflare Load Balancer from struct: %+v", newLoadBalancer)

r, err := client.CreateLoadBalancer(zoneID, newLoadBalancer)
Expand Down Expand Up @@ -274,6 +286,10 @@ func resourceCloudflareLoadBalancerUpdate(d *schema.ResourceData, meta interface
loadBalancer.PersistenceTTL = sessionAffinityTTL.(int)
}

if sessionAffinityAttrs, ok := d.GetOk("session_affinity_attributes"); ok {
loadBalancer.SessionAffinityAttributes = expandSessionAffinityAttrs(sessionAffinityAttrs)
}

log.Printf("[INFO] Updating Cloudflare Load Balancer from struct: %+v", loadBalancer)

_, err := client.ModifyLoadBalancer(zoneID, loadBalancer)
Expand Down Expand Up @@ -324,6 +340,7 @@ func resourceCloudflareLoadBalancerRead(d *schema.ResourceData, meta interface{}
d.Set("ttl", loadBalancer.TTL)
d.Set("steering_policy", loadBalancer.SteeringPolicy)
d.Set("session_affinity", loadBalancer.Persistence)
d.Set("session_affinity_attributes", loadBalancer.SessionAffinityAttributes)
d.Set("created_on", loadBalancer.CreatedOn.Format(time.RFC3339Nano))
d.Set("modified_on", loadBalancer.ModifiedOn.Format(time.RFC3339Nano))

Expand Down Expand Up @@ -392,3 +409,20 @@ func resourceCloudflareLoadBalancerImport(d *schema.ResourceData, meta interface

return []*schema.ResourceData{d}, nil
}

func expandSessionAffinityAttrs(attrs interface{}) *cloudflare.SessionAffinityAttributes {
var cfSessionAffinityAttrs cloudflare.SessionAffinityAttributes

for k, v := range attrs.(map[string]interface{}) {
switch k {
case "secure":
cfSessionAffinityAttrs.Secure = v.(string)
case "samesite":
cfSessionAffinityAttrs.SameSite = v.(string)
case "drain_duration":
cfSessionAffinityAttrs.DrainDuration = v.(int)
}
}

return &cfSessionAffinityAttrs
}
9 changes: 9 additions & 0 deletions cloudflare/resource_cloudflare_load_balancer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ func TestAccCloudflareLoadBalancer_SessionAffinity(t *testing.T) {
// explicitly verify that our session_affinity has been set
resource.TestCheckResourceAttr(name, "session_affinity", "cookie"),
resource.TestCheckResourceAttr(name, "session_affinity_ttl", "1800"),
resource.TestCheckResourceAttr(name, "session_affinity_attributes.samesite", "Auto"),
resource.TestCheckResourceAttr(name, "session_affinity_attributes.secure", "Auto"),
resource.TestCheckResourceAttr(name, "session_affinity_attributes.drain_duration", "60"),
// dont check that other specified values are set, this will be evident by lack
// of plan diff some values will get empty values
resource.TestCheckResourceAttr(name, "pop_pools.#", "0"),
Expand All @@ -94,6 +97,7 @@ func TestAccCloudflareLoadBalancer_SessionAffinity(t *testing.T) {
resource.TestCheckResourceAttr(name, "session_affinity", "ip_cookie"),
// session_affinity_ttl should not be present as it isn't set
resource.TestCheckNoResourceAttr(name, "session_affinity_ttl"),
resource.TestCheckNoResourceAttr(name, "session_affinity_attributes"),
// dont check that other specified values are set, this will be evident by lack
// of plan diff some values will get empty values
resource.TestCheckResourceAttr(name, "pop_pools.#", "0"),
Expand Down Expand Up @@ -366,6 +370,11 @@ resource "cloudflare_load_balancer" "%[3]s" {
default_pool_ids = ["${cloudflare_load_balancer_pool.%[3]s.id}"]
session_affinity = "cookie"
session_affinity_ttl = 1800
session_affinity_attributes = {
samesite = "Auto"
secure = "Auto"
drain_duration = 60
}
}`, zoneID, zone, id)
}

Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/load_balancer.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ The following arguments are supported:
* `pop_pools` - (Optional) A set containing mappings of Cloudflare Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers. Fields documented below.
* `session_affinity` - (Optional) Associates all requests coming from an end-user with a single origin. Cloudflare will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, so long as it is available. Valid values are: `""`, `"none"`, `"cookie"`, and `"ip_cookie"`. Default is `""`.
* `session_affinity_ttl` - (Optional) Time, in seconds, until this load balancers session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless `session_affinity_ttl` is explicitly set. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. Valid values are between 1800 and 604800.
* `session_affinity_attributes` - (Optional) Configure cookie attributes for session affinity cookie. See the field documentation below.

**region_pools** requires the following:

Expand All @@ -72,6 +73,12 @@ The following arguments are supported:
* `pop` - (Required) A 3-letter code for the Point-of-Presence. Allowed values can be found in the list of datacenters on the [status page](https://www.cloudflarestatus.com/). Multiple entries should not be specified with the same PoP.
* `pool_ids` - (Required) A list of pool IDs in failover priority to use for traffic reaching the given PoP.

**session_affinity_attributes** optionally as the following:

* `samesite` - (Optional) Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Valid values: `"Auto"`, `"Lax"`, `"None"` or `"Strict"`.
* `secure` - (Optional) Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Valid values: `"Auto"`, `"Always"` or `"Never"`.
* `drain_duration` - (Optional) Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

## Attributes Reference

The following attributes are exported:
Expand Down

0 comments on commit 1216305

Please sign in to comment.