Add wait_for_load_balancer field to kubernetes_ingress (#830)

* Add wait_for_load_balancer field to kubernetes_ingress

Co-authored-by: Alex Somesan <[email protected]>

Author: jrhouston

kubernetes/resource_kubernetes_ingress.go

@@ -4,10 +4,11 @@ import (
 	"fmt"
 	"log"
 
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
 	"k8s.io/api/extensions/v1beta1"
 	"k8s.io/apimachinery/pkg/api/errors"
-	meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 func resourceKubernetesIngress() *schema.Resource {
@@ -109,6 +110,12 @@ func resourceKubernetesIngress() *schema.Resource {
 					},
 				},
 			},
+			"wait_for_load_balancer": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Description: "Terraform will wait for the load balancer to have at least 1 endpoint before considering the resource created.",
+			},
 		},
 	}
 }
@@ -132,7 +139,29 @@ func resourceKubernetesIngressCreate(d *schema.ResourceData, meta interface{}) e
 	log.Printf("[INFO] Submitted new ingress: %#v", out)
 	d.SetId(buildId(out.ObjectMeta))
 
-	return resourceKubernetesIngressRead(d, meta)
+	if !d.Get("wait_for_load_balancer").(bool) {
+		return resourceKubernetesIngressRead(d, meta)
+	}
+
+	log.Printf("[INFO] Waiting for load balancer to become ready: %#v", out)
+	return resource.Retry(d.Timeout(schema.TimeoutCreate), func() *resource.RetryError {
+		res, err := conn.ExtensionsV1beta1().Ingresses(metadata.Namespace).Get(metadata.Name, metav1.GetOptions{})
+		if err != nil {
+			// NOTE it is possible in some HA apiserver setups that are eventually consistent
+			// that we could get a 404 when doing a Get immediately after a Create
+			if errors.IsNotFound(err) {
+				return resource.RetryableError(err)
+			}
+			return resource.NonRetryableError(err)
+		}
+
+		if len(res.Status.LoadBalancer.Ingress) > 0 {
+			return resource.NonRetryableError(resourceKubernetesIngressRead(d, meta))
+		}
+
+		log.Printf("[INFO] Load Balancer not ready yet...")
+		return resource.RetryableError(fmt.Errorf("Load Balancer is not ready yet"))
+	})
 }
 
 func resourceKubernetesIngressRead(d *schema.ResourceData, meta interface{}) error {
@@ -147,7 +176,7 @@ func resourceKubernetesIngressRead(d *schema.ResourceData, meta interface{}) err
 	}
 
 	log.Printf("[INFO] Reading ingress %s", name)
-	ing, err := conn.ExtensionsV1beta1().Ingresses(namespace).Get(name, meta_v1.GetOptions{})
+	ing, err := conn.ExtensionsV1beta1().Ingresses(namespace).Get(name, metav1.GetOptions{})
 	if err != nil {
 		log.Printf("[DEBUG] Received error: %#v", err)
 		return fmt.Errorf("Failed to read Ingress '%s' because: %s", buildId(ing.ObjectMeta), err)
@@ -217,7 +246,7 @@ func resourceKubernetesIngressDelete(d *schema.ResourceData, meta interface{}) e
 	}
 
 	log.Printf("[INFO] Deleting ingress: %#v", name)
-	err = conn.ExtensionsV1beta1().Ingresses(namespace).Delete(name, &meta_v1.DeleteOptions{})
+	err = conn.ExtensionsV1beta1().Ingresses(namespace).Delete(name, &metav1.DeleteOptions{})
 	if err != nil {
 		return fmt.Errorf("Failed to delete Ingress %s because: %s", d.Id(), err)
 	}
@@ -240,7 +269,7 @@ func resourceKubernetesIngressExists(d *schema.ResourceData, meta interface{}) (
 	}
 
 	log.Printf("[INFO] Checking ingress %s", name)
-	_, err = conn.ExtensionsV1beta1().Ingresses(namespace).Get(name, meta_v1.GetOptions{})
+	_, err = conn.ExtensionsV1beta1().Ingresses(namespace).Get(name, metav1.GetOptions{})
 	if err != nil {
 		if statusErr, ok := err.(*errors.StatusError); ok && statusErr.ErrStatus.Code == 404 {
 			return false, nil

kubernetes/resource_kubernetes_ingress_test.go

@@ -106,6 +106,7 @@ func TestAccKubernetesIngress_TLS(t *testing.T) {
 		},
 	})
 }
+
 func TestAccKubernetesIngress_InternalKey(t *testing.T) {
 	var conf api.Ingress
 	name := fmt.Sprintf("tf-acc-test-%s", acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum))
@@ -147,6 +148,27 @@ func TestAccKubernetesIngress_InternalKey(t *testing.T) {
 	})
 }
 
+func TestAccKubernetesIngress_WaitForLoadBalancerGoogleCloud(t *testing.T) {
+	var conf api.Ingress
+	name := fmt.Sprintf("tf-acc-test-%s", acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum))
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:      func() { testAccPreCheck(t); skipIfNoGoogleCloudSettingsFound(t) },
+		IDRefreshName: "kubernetes_ingress.test",
+		Providers:     testAccProviders,
+		CheckDestroy:  testAccCheckKubernetesIngressDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccKubernetesIngressConfig_waitForLoadBalancer(name),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckKubernetesIngressExists("kubernetes_ingress.test", &conf),
+					resource.TestCheckResourceAttrSet("kubernetes_ingress.test", "load_balancer_ingress.0.ip"),
+				),
+			},
+		},
+	})
+}
+
 func testAccCheckKubernetesIngressDestroy(s *terraform.State) error {
 	conn, err := testAccProvider.Meta().(KubeClientsets).MainClientset()
 	if err != nil {
@@ -334,3 +356,70 @@ resource "kubernetes_ingress" "test" {
 	}
 }`, name)
 }
+
+func testAccKubernetesIngressConfig_waitForLoadBalancer(name string) string {
+	return fmt.Sprintf(`
+resource "kubernetes_service" "test" {
+	metadata {
+		name = %q
+	}
+	spec {
+		type = "NodePort"
+		selector = {
+			app = %q
+		}
+		port {
+			port = 8000
+			target_port = 80
+			protocol = "TCP"
+		}
+	}
+}
+
+resource "kubernetes_deployment" "test" {
+	metadata {
+		name = %q
+	}
+	spec {
+		selector {
+			match_labels = {
+				app = %q
+			}
+		}
+		template {
+			metadata {
+				labels = {
+					app = %q
+				}
+			}
+			spec {
+				container {
+					name = "test"
+					image = "gcr.io/google-samples/hello-app:2.0"
+					env {
+						name = "PORT"
+						value = "80"
+					}	
+				}
+			}
+		}
+	}
+}
+
+resource "kubernetes_ingress" "test" {
+	depends_on = [
+		kubernetes_service.test, 
+		kubernetes_deployment.test
+	]
+	metadata {
+		name = %q
+	}
+	spec {
+		backend {
+			service_name = %q
+			service_port = 8000
+		}
+	}
+	wait_for_load_balancer = true
+}`, name, name, name, name, name, name, name)
+}

website/docs/r/ingress.html.markdown

@@ -100,6 +100,7 @@ The following arguments are supported:
 
 * `metadata` - (Required) Standard ingress's metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata
 * `spec` - (Required) Spec defines the behavior of a ingress. https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+* `wait_for_load_balancer` - (Optional) Terraform will wait for the load balancer to have at least 1 endpoint before considering the resource created.
 
 ## Nested Blocks