feat(lb): add support for failoverhost (#1583)

Co-authored-by: Rémy Léone <[email protected]>
Co-authored-by: Nathanael Demacon <[email protected]>
Co-authored-by: Jules Castéran <[email protected]>

Author: 4 people

.markdownlinkcheck.json

@@ -2,6 +2,9 @@
   "ignorePatterns": [
     {
       "pattern": "^https://github.com/[^/]+/[^/]+/(issues|labels|pull)"
+    },
+    {
+      "pattern": "^https://failover-website.s3-website.fr-par.scw.cloud/"
     }
   ],
   "replacementPatterns": [

docs/resources/lb_backend.md

@@ -57,6 +57,9 @@ The following arguments are supported:
 - `timeout_server`              - (Optional) Maximum server connection inactivity time. (e.g.: `1s`)
 - `timeout_connect`             - (Optional) Maximum initial server connection establishment time. (e.g.: `1s`)
 - `timeout_tunnel`              - (Optional) Maximum tunnel inactivity time. (e.g.: `1s`)
+- `failover_host`               - (Optional) Scaleway S3 bucket website to be served in case all backend servers are down.
+~> **Note:** Only the host part of the Scaleway S3 bucket website is expected:
+e.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.
 
 ### Health Check arguments
 

scaleway/resource_lb_backend.go

@@ -239,6 +239,14 @@ func resourceScalewayLbBackend() *schema.Resource {
 				Optional:    true,
 				Description: "Modify what occurs when a backend server is marked down",
 			},
+			"failover_host": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Description: `Scaleway S3 bucket website to be served in case all backend servers are down
+
+**NOTE** : Only the host part of the Scaleway S3 bucket website is expected.
+E.g. 'failover-website.s3-website.fr-par.scw.cloud' if your bucket website URL is 'https://failover-website.s3-website.fr-par.scw.cloud/'.`,
+			},
 		},
 	}
 }
@@ -312,6 +320,7 @@ func resourceScalewayLbBackendCreate(ctx context.Context, d *schema.ResourceData
 		TimeoutConnect:     timeoutConnect,
 		TimeoutTunnel:      timeoutTunnel,
 		OnMarkedDownAction: expandLbBackendMarkdownAction(d.Get("on_marked_down_action")),
+		FailoverHost:       expandStringPtr(d.Get("failover_host")),
 	}
 
 	// deprecated attribute
@@ -375,6 +384,7 @@ func resourceScalewayLbBackendRead(ctx context.Context, d *schema.ResourceData,
 	_ = d.Set("health_check_http", flattenLbHCHTTP(backend.HealthCheck.HTTPConfig))
 	_ = d.Set("health_check_https", flattenLbHCHTTPS(backend.HealthCheck.HTTPSConfig))
 	_ = d.Set("send_proxy_v2", flattenBoolPtr(backend.SendProxyV2))
+	_ = d.Set("failover_host", backend.FailoverHost)
 
 	_, err = waitForLB(ctx, lbAPI, zone, backend.LB.ID, d.Timeout(schema.TimeoutRead))
 	if err != nil {
@@ -436,6 +446,7 @@ func resourceScalewayLbBackendUpdate(ctx context.Context, d *schema.ResourceData
 		TimeoutConnect:           timeoutConnect,
 		TimeoutTunnel:            timeoutTunnel,
 		OnMarkedDownAction:       expandLbBackendMarkdownAction(d.Get("on_marked_down_action")),
+		FailoverHost:             expandStringPtr(d.Get("failover_host")),
 	}
 
 	// deprecated

scaleway/resource_lb_backend_test.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"testing"
 
+	sdkacctest "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 	lbSDK "github.com/scaleway/scaleway-sdk-go/api/lb/v1"
@@ -188,6 +189,102 @@ func TestAccScalewayLbBackend_HealthCheck(t *testing.T) {
 	})
 }
 
+func TestAccScalewayLbBackend_WithFailoverHost(t *testing.T) {
+	rName := sdkacctest.RandomWithPrefix("tf-acc-test")
+	resourceName := "scaleway_object_bucket_website_configuration.test"
+
+	tt := NewTestTools(t)
+	defer tt.Cleanup()
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy: resource.ComposeTestCheckFunc(
+			testAccCheckScalewayLbBackendDestroy(tt),
+			testAccCheckScalewayObjectDestroy(tt),
+			testAccCheckScalewayObjectBucketDestroy(tt),
+			testAccCheckBucketWebsiteConfigurationDestroy(tt),
+		),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+					resource scaleway_lb_ip ip01 {}
+					resource scaleway_lb lb01 {
+						ip_id = scaleway_lb_ip.ip01.id
+						name = "test-lb"
+						type = "lb-s"
+					}
+
+					resource scaleway_instance_ip ip01 {}
+
+					resource scaleway_lb_backend bkd01 {
+						lb_id = scaleway_lb.lb01.id
+						name = "bkd01"
+						forward_protocol = "http"
+						forward_port = 80
+						proxy_protocol = "none"
+						server_ips = [ scaleway_instance_ip.ip01.address ]
+					}
+				`,
+				Check: testAccCheckScalewayLbBackendExists(tt, "scaleway_lb_backend.bkd01"),
+			},
+			{
+				Config: fmt.Sprintf(`
+			  		resource "scaleway_object_bucket" "test" {
+						name = %[1]q
+						acl  = "public-read"
+						tags = {
+							TestName = "TestAccSCW_WebsiteConfig_basic"
+						}
+					}
+
+					resource scaleway_object "some_file" {
+						bucket = scaleway_object_bucket.test.name
+						key = "index.html"
+						file = "testfixture/index.html"
+						visibility = "public-read"
+					}
+				
+				  	resource "scaleway_object_bucket_website_configuration" "test" {
+						bucket = scaleway_object_bucket.test.name
+						index_document {
+							suffix = "index.html"
+						}
+						error_document {
+							key = "error.html"
+						}
+				  	}
+
+					resource scaleway_lb_ip ip01 {}
+					resource scaleway_lb lb01 {
+						ip_id = scaleway_lb_ip.ip01.id
+						name = "test-lb"
+						type = "lb-s"
+					}
+
+					resource scaleway_instance_ip ip01 {}
+
+					resource scaleway_lb_backend bkd01 {
+						lb_id = scaleway_lb.lb01.id
+						name = "bkd01"
+						forward_protocol = "http"
+						forward_port = 80
+						proxy_protocol = "none"
+						server_ips = [ scaleway_instance_ip.ip01.address ]
+						failover_host = scaleway_object_bucket_website_configuration.test.website_endpoint
+					}
+				`, rName),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckBucketWebsiteConfigurationExists(tt, resourceName),
+					testAccCheckScalewayLbBackendExists(tt, "scaleway_lb_backend.bkd01"),
+					resource.TestCheckResourceAttr(resourceName, "website_endpoint", rName+".s3-website.fr-par.scw.cloud"),
+					resource.TestCheckResourceAttrSet("scaleway_lb_backend.bkd01", "failover_host"),
+				),
+				ExpectNonEmptyPlan: !*UpdateCassettes,
+			},
+		},
+	})
+}
+
 func testAccCheckScalewayLbBackendExists(tt *TestTools, n string) resource.TestCheckFunc {
 	return func(state *terraform.State) error {
 		rs, ok := state.RootModule().Resources[n]