LB: Datasources for BackendHealth, BackendSetHealth, LoadBalancerHealth

Author: alexng-canuck

docs/load_balancer/backend_healths.md

@@ -0,0 +1,37 @@
+# oci_load_balancer_backend_health
+
+## BackendHealth Singular DataSource
+
+### BackendHealth Reference
+
+The following attributes are exported:
+
+* `health_check_results` - A list of the most recent health check results returned for the specified backend server. 
+	* `health_check_status` - The result of the most recent health check. 
+	* `source_ip_address` - The IP address of the health check status report provider. This identifier helps you differentiate same-subnet (private) load balancers that report health check status.  Example: `10.0.0.7` 
+	* `subnet_id` - The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the subnet hosting the load balancer that reported this health check status. 
+	* `timestamp` - The date and time the data was retrieved, in the format defined by RFC3339.  Example: `2017-06-02T18:28:11+00:00` 
+* `status` - The general health status of the specified backend server as reported by the primary and standby load balancers.  *   **OK:** Both health checks returned `OK`.  *   **WARNING:** One health check returned `OK` and one did not.  *   **CRITICAL:** Neither health check returned `OK`.  *   **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system was unable to retrieve metrics at this time. 
+
+
+
+### Get Operation
+Gets the current health status of the specified backend server.
+
+The following arguments are supported:
+
+* `backend_name` - (Required) The IP address and port of the backend server to retrieve the health status for.  Example: `10.0.0.3:8080` 
+* `backend_set_name` - (Required) The name of the backend set associated with the backend server to retrieve the health status for.  Example: `example_backend_set` 
+* `load_balancer_id` - (Required) The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend server health status to be retrieved.
+
+
+### Example Usage
+
+```hcl
+data "oci_load_balancer_backend_health" "test_backend_health" {
+	#Required
+	backend_name = "${var.backend_health_backend_name}"
+	backend_set_name = "${var.backend_health_backend_set_name}"
+	load_balancer_id = "${oci_load_balancer_load_balancer.test_load_balancer.id}"
+}
+```

docs/load_balancer/backend_set_healths.md

@@ -0,0 +1,34 @@
+# oci_load_balancer_backend_set_health
+
+## BackendSetHealth Singular DataSource
+
+### BackendSetHealth Reference
+
+The following attributes are exported:
+
+* `critical_state_backend_names` - A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by IP address and port.  Example: `10.0.0.4:8080` 
+* `status` - Overall health status of the backend set.  *  **OK:** All backend servers in the backend set return a status of `OK`.  *  **WARNING:** Half or more of the backend set's backend servers return a status of `OK` and at least one backend server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`.  *  **CRITICAL:** Fewer than half of the backend set's backend servers return a status of `OK`.  *  **UNKNOWN:** More than half of the backend set's backend servers return a status of `UNKNOWN`, the system was unable to retrieve metrics, or the backend set does not have a listener attached. 
+* `total_backend_count` - The total number of backend servers in this backend set.  Example: `7` 
+* `unknown_state_backend_names` - A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by IP address and port.  Example: `10.0.0.5:8080` 
+* `warning_state_backend_names` - A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by IP address and port.  Example: `10.0.0.3:8080` 
+
+
+
+### Get Operation
+Gets the health status for the specified backend set.
+
+The following arguments are supported:
+
+* `backend_set_name` - (Required) The name of the backend set to retrieve the health status for.  Example: `example_backend_set` 
+* `load_balancer_id` - (Required) The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set health status to be retrieved.
+
+
+### Example Usage
+
+```hcl
+data "oci_load_balancer_backend_set_health" "test_backend_set_health" {
+	#Required
+	backend_set_name = "${var.backend_set_health_backend_set_name}"
+	load_balancer_id = "${oci_load_balancer_load_balancer.test_load_balancer.id}"
+}
+```

docs/load_balancer/load_balancer_healths.md

@@ -0,0 +1,32 @@
+# oci_load_balancer_health
+
+## LoadBalancerHealth Singular DataSource
+
+### LoadBalancerHealth Reference
+
+The following attributes are exported:
+
+* `critical_state_backend_set_names` - A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the friendly name you assigned when you created it.  Example: `example_backend_set` 
+* `status` - The overall health status of the load balancer.  *  **OK:** All backend sets associated with the load balancer return a status of `OK`.  *  **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`, no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.  *  **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.  *  **UNKNOWN:** If any one of the following conditions is true:      *  The load balancer life cycle state is not `ACTIVE`.      *  No backend sets are defined for the load balancer.      *  More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend        sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.      *  The system could not retrieve metrics for any reason. 
+* `total_backend_set_count` - The total number of backend sets associated with this load balancer.  Example: `4` 
+* `unknown_state_backend_set_names` - A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the friendly name you assigned when you created it.  Example: `example_backend_set2` 
+* `warning_state_backend_set_names` - A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the friendly name you assigned when you created it.  Example: `example_backend_set3` 
+
+
+
+### Get Operation
+Gets the health status for the specified load balancer.
+
+The following arguments are supported:
+
+* `load_balancer_id` - (Required) The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer to return health status for.
+
+
+### Example Usage
+
+```hcl
+data "oci_load_balancer_health" "test_load_balancer_health" {
+	#Required
+	load_balancer_id = "${oci_load_balancer_load_balancer.test_load_balancer.id}"
+}
+```

provider/load_balancer_backend_health_data_source.go

@@ -0,0 +1,151 @@
+// Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+
+package provider
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform/helper/schema"
+	oci_load_balancer "github.com/oracle/oci-go-sdk/loadbalancer"
+
+	"github.com/oracle/terraform-provider-oci/crud"
+)
+
+func BackendHealthDataSource() *schema.Resource {
+	return &schema.Resource{
+		Read: readSingularBackendHealth,
+		Schema: map[string]*schema.Schema{
+			"backend_name": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"backend_set_name": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"load_balancer_id": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			// Computed
+			"health_check_results": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						// Required
+
+						// Optional
+
+						// Computed
+						"health_check_status": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"source_ip_address": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"subnet_id": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"timestamp": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+					},
+				},
+			},
+			"status": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+		},
+	}
+}
+
+func readSingularBackendHealth(d *schema.ResourceData, m interface{}) error {
+	sync := &BackendHealthDataSourceCrud{}
+	sync.D = d
+	sync.Client = m.(*OracleClients).loadBalancerClient
+
+	return crud.ReadResource(sync)
+}
+
+type BackendHealthDataSourceCrud struct {
+	D      *schema.ResourceData
+	Client *oci_load_balancer.LoadBalancerClient
+	Res    *oci_load_balancer.GetBackendHealthResponse
+}
+
+func (s *BackendHealthDataSourceCrud) VoidState() {
+	s.D.SetId("")
+}
+
+func (s *BackendHealthDataSourceCrud) Get() error {
+	request := oci_load_balancer.GetBackendHealthRequest{}
+
+	if backendName, ok := s.D.GetOkExists("backend_name"); ok {
+		tmp := backendName.(string)
+		request.BackendName = &tmp
+	}
+
+	if backendSetName, ok := s.D.GetOkExists("backend_set_name"); ok {
+		tmp := backendSetName.(string)
+		request.BackendSetName = &tmp
+	}
+
+	if loadBalancerId, ok := s.D.GetOkExists("load_balancer_id"); ok {
+		tmp := loadBalancerId.(string)
+		request.LoadBalancerId = &tmp
+	}
+
+	request.RequestMetadata.RetryPolicy = getRetryPolicy(false, "load_balancer")
+
+	response, err := s.Client.GetBackendHealth(context.Background(), request)
+	if err != nil {
+		return err
+	}
+
+	s.Res = &response
+	return nil
+}
+
+func (s *BackendHealthDataSourceCrud) SetData() {
+	if s.Res == nil {
+		return
+	}
+
+	s.D.SetId(crud.GenerateDataSourceID())
+
+	healthCheckResults := []interface{}{}
+	for _, item := range s.Res.HealthCheckResults {
+		healthCheckResults = append(healthCheckResults, HealthCheckResultToMap(item))
+	}
+	s.D.Set("health_check_results", healthCheckResults)
+
+	s.D.Set("status", s.Res.Status)
+
+	return
+}
+
+func HealthCheckResultToMap(obj oci_load_balancer.HealthCheckResult) map[string]interface{} {
+	result := map[string]interface{}{}
+
+	result["health_check_status"] = string(obj.HealthCheckStatus)
+
+	if obj.SourceIpAddress != nil {
+		result["source_ip_address"] = string(*obj.SourceIpAddress)
+	}
+
+	if obj.SubnetId != nil {
+		result["subnet_id"] = string(*obj.SubnetId)
+	}
+
+	if obj.Timestamp != nil {
+		result["timestamp"] = obj.Timestamp.String()
+	}
+
+	return result
+}

provider/load_balancer_backend_health_test.go

@@ -0,0 +1,65 @@
+// Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+
+package provider
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform/helper/resource"
+	"github.com/hashicorp/terraform/terraform"
+)
+
+const (
+	BackendHealthResourceConfig = BackendHealthResourceDependencies + `
+
+`
+	BackendHealthPropertyVariables = `
+variable "backend_health_backend_name" { default = "backendName" }
+variable "backend_health_backend_set_name" { default = "backendSetName" }
+variable "backend_health_load_balancer_id" { default = "loadBalancerId" }
+
+`
+	BackendHealthResourceDependencies = BackendRequiredOnlyResource + BackendPropertyVariables
+)
+
+func TestLoadBalancerBackendHealthResource_basic(t *testing.T) {
+	provider := testAccProvider
+	config := testProviderConfig()
+
+	compartmentId := getRequiredEnvSetting("compartment_ocid")
+	compartmentIdVariableStr := fmt.Sprintf("variable \"compartment_id\" { default = \"%s\" }\n", compartmentId)
+
+	singularDatasourceName := "data.oci_load_balancer_backend_health.test_backend_health"
+
+	resource.Test(t, resource.TestCase{
+		Providers: map[string]terraform.ResourceProvider{
+			"oci": provider,
+		},
+		Steps: []resource.TestStep{
+			// verify singular datasource
+			{
+				Config: config + `
+variable "backend_health_backend_name" { default = "backendName" }
+variable "backend_health_backend_set_name" { default = "backendSetName" }
+variable "backend_health_load_balancer_id" { default = "loadBalancerId" }
+
+data "oci_load_balancer_backend_health" "test_backend_health" {
+	#Required
+	backend_name = "${oci_load_balancer_backend.test_backend.name}"
+	backend_set_name = "${oci_load_balancer_backend_set.test_backend_set.name}"
+	load_balancer_id = "${oci_load_balancer_load_balancer.test_load_balancer.id}"
+}
+                ` + compartmentIdVariableStr + BackendHealthResourceConfig,
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr(singularDatasourceName, "backend_name", "10.0.0.3:10"),
+					resource.TestCheckResourceAttr(singularDatasourceName, "backend_set_name", "backendSet1"),
+					resource.TestCheckResourceAttrSet(singularDatasourceName, "load_balancer_id"),
+
+					resource.TestCheckResourceAttr(singularDatasourceName, "health_check_results.#", "0"),
+					resource.TestCheckResourceAttrSet(singularDatasourceName, "status"),
+				),
+			},
+		},
+	})
+}