Add Fault Domains data source and integrate with Instance resource

Author: ccushing

CHANGELOG.md

@@ -3,6 +3,12 @@ All notable changes to this project are documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## 2.2.2 (Unreleased)
+
+### Added
+- Support listing Fault Domains in an AD and specifying them when launching an Instance
+
+
 ## 2.2.1 - 2018-08-23
 
 ### Added

docs/Table of Contents.md

@@ -79,6 +79,7 @@ This lists all of the available OCI resources and/or data sources.
     * [Compartments](identity/compartments.md)
     * [Customer Secret Keys](identity/customer_secret_keys.md)
     * [Dynamic Groups](identity/dynamic_groups.md)
+    * [Fault Domains](identity/fault_domains.md)
     * [Groups](identity/groups.md)
     * [Identity Providers](identity/identity_providers.md)
     * [IdpGroupMappings](identity/idp_group_mappings.md)

docs/core/instances.md

@@ -11,11 +11,20 @@ The following attributes are exported:
 * `compartment_id` - The OCID of the compartment that contains the instance.
 * `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).  Example: `{"Operations.CostCenter": "42"}` 
 * `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.  Example: `My bare metal instance` 
-* `extended_metadata` - Additional metadata key/value pairs that you provide.  They serve a similar purpose and functionality from fields in the 'metadata' object.
+* `extended_metadata` - Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object.
 
 	They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only).
+    
+    If you don't need nested metadata values, it is strongly advised to avoid using this object and use the Metadata object instead.
+    
+    Input in terraform is the same as metadata but allows nested metadata if you pass a valid JSON string as a value. See the example below. 
+* `fault_domain` - The name of the fault domain the instance is running in.
 
-	If you don't need nested metadata values, it is strongly advised to avoid using this object and use the Metadata object instead. 
+	A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your  instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect  instances in other fault domains.
+
+	If you do not specify the fault domain, the system selects one for you. To change the fault domain for an instance, terminate it and launch a new instance in the preferred fault domain.
+
+	Example: `FAULT-DOMAIN-1` 
 * `freeform_tags` - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).  Example: `{"Department": "Finance"}` 
 * `id` - The OCID of the instance.
 * `image` - Deprecated. Use `sourceDetails` instead. 
@@ -134,6 +143,7 @@ The following arguments are supported:
 	If you don't need nested metadata values, it is strongly advised to avoid using this object and use the Metadata object instead. 
 
 	Input in terraform is the same as metadata but allows nested metadata if you pass a valid JSON string as a value. See the example below.
+* `fault_domain` - (Optional) A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your  instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect  instances in other fault domains.  If you do not specify the fault domain, the system selects one for you. To change the fault domain for an instance, terminate it and launch a new instance in the preferred fault domain.  To get a list of fault domains, use the [ListFaultDomains](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/faultDomains/ListFaultDomains) operation in the Identity and Access Management Service API.  Example: `FAULT-DOMAIN-1`
 * `freeform_tags` - (Optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).  Example: `{"Department": "Finance"}` 
 * `hostname_label` - (Optional) Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/CreateVnicDetails/). If you provide both, the values must match. 
 * `image` - (Optional) Deprecated. Use `sourceDetails` with [InstanceSourceViaImageDetails](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/latest/requests/InstanceSourceViaImageDetails) source type instead. If you specify values for both, the values must match. 
@@ -220,6 +230,7 @@ resource "oci_core_instance" "test_instance" {
 		some_string = "stringA"
 		nested_object = "{\"some_string\": \"stringB\", \"object\": {\"some_string\": \"stringC\"}}"
 	}
+	fault_domain = "${var.instance_fault_domain}"
 	freeform_tags = {"Department"= "Finance"}
 	hostname_label = "${var.instance_hostname_label}"
 	ipxe_script = "${var.instance_ipxe_script}"

docs/identity/fault_domains.md

@@ -0,0 +1,39 @@
+
+# oci_identity_fault_domains
+
+## FaultDomain DataSource
+
+Gets a list of fault_domains.
+
+### List Operation
+Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another
+of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).
+See [Where to Get the Tenancy's OCID and User's OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five).
+
+The following arguments are supported:
+
+* `availability_domain` - (Required) The name of the availibilityDomain. 
+* `compartment_id` - (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment). 
+
+
+The following attributes are exported:
+
+* `fault_domains` - The list of fault_domains.
+
+### Example Usage
+
+```hcl
+data "oci_identity_fault_domains" "test_fault_domains" {
+	#Required
+	availability_domain = "${var.fault_domain_availability_domain}"
+	compartment_id = "${var.compartment_id}"
+}
+```
+### FaultDomain Reference
+
+The following attributes are exported:
+
+* `availability_domain` - The name of the availabilityDomain where the Fault Domain belongs.
+* `compartment_id` - The OCID of the compartment. Currently only tenancy (root) compartment can be provided.
+* `id` - The OCID of the Fault Domain.
+* `name` - The name of the Fault Domain.

provider/core_instance_resource.go

@@ -153,6 +153,12 @@ func InstanceResource() *schema.Resource {
 				ForceNew: true,
 				Elem:     schema.TypeString,
 			},
+			"fault_domain": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Computed: true,
+				ForceNew: true,
+			},
 			"freeform_tags": {
 				Type:     schema.TypeMap,
 				Optional: true,
@@ -427,6 +433,11 @@ func (s *InstanceResourceCrud) Create() error {
 		request.ExtendedMetadata = extendedMetadata
 	}
 
+	if faultDomain, ok := s.D.GetOkExists("fault_domain"); ok {
+		tmp := faultDomain.(string)
+		request.FaultDomain = &tmp
+	}
+
 	if freeformTags, ok := s.D.GetOkExists("freeform_tags"); ok {
 		request.FreeformTags = objectMapToStringMap(freeformTags.(map[string]interface{}))
 	}
@@ -608,6 +619,10 @@ func (s *InstanceResourceCrud) SetData() error {
 	// 	s.D.Set("extended_metadata", []interface{}{objectToMap(s.Res.ExtendedMetadata)})
 	// }
 
+	if s.Res.FaultDomain != nil {
+		s.D.Set("fault_domain", *s.Res.FaultDomain)
+	}
+
 	s.D.Set("freeform_tags", s.Res.FreeformTags)
 
 	if s.Res.ImageId != nil {

provider/core_instance_test.go

@@ -65,6 +65,7 @@ resource "oci_core_instance" "test_instance" {
 	defined_tags = "${map("${oci_identity_tag_namespace.tag-namespace1.name}.${oci_identity_tag.tag1.name}", "${var.instance_defined_tags_value}")}"
 	display_name = "${var.instance_display_name}"
 	extended_metadata = "${var.instance_extended_metadata}"
+	fault_domain = "${var.instance_fault_domain}"
 	freeform_tags = "${var.instance_freeform_tags}"
 	ipxe_script = "${var.instance_ipxe_script}"
 	metadata = "${var.instance_metadata}"
@@ -104,6 +105,7 @@ variable "instance_extended_metadata" { default = {
 		some_string = "stringA"
 		nested_object = "{\"some_string\": \"stringB\", \"object\": {\"some_string\": \"stringC\"}}"
 	} }
+variable "instance_fault_domain" { default = "FAULT-DOMAIN-2" }
 variable "instance_freeform_tags" { default = {"Department"= "Finance"} }
 variable "instance_hostname_label" { default = "hostnameLabel" }
 variable "instance_image" { default = "image" }
@@ -174,6 +176,7 @@ func TestCoreInstanceResource_basic(t *testing.T) {
 					resource.TestCheckResourceAttr(resourceName, "defined_tags.%", "1"),
 					resource.TestCheckResourceAttr(resourceName, "display_name", "displayName"),
 					resource.TestCheckResourceAttr(resourceName, "extended_metadata.%", "2"),
+					resource.TestCheckResourceAttr(resourceName, "fault_domain", "FAULT-DOMAIN-2"),
 					resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
 					resource.TestCheckResourceAttrSet(resourceName, "id"),
 					resource.TestCheckResourceAttrSet(resourceName, "image"),
@@ -210,6 +213,7 @@ variable "instance_extended_metadata" { default = {
 		some_string = "stringA"
 		nested_object = "{\"some_string\": \"stringB\", \"object\": {\"some_string\": \"stringC\"}}"
 	} }
+variable "instance_fault_domain" { default = "FAULT-DOMAIN-2" }
 variable "instance_freeform_tags" { default = {"Department"= "Accounting"} }
 variable "instance_hostname_label" { default = "hostnameLabel" }
 variable "instance_image" { default = "image" }
@@ -234,6 +238,7 @@ variable "instance_state" { default = "RUNNING" }
 					resource.TestCheckResourceAttr(resourceName, "defined_tags.%", "1"),
 					resource.TestCheckResourceAttr(resourceName, "display_name", "displayName2"),
 					resource.TestCheckResourceAttr(resourceName, "extended_metadata.%", "2"),
+					resource.TestCheckResourceAttr(resourceName, "fault_domain", "FAULT-DOMAIN-2"),
 					resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
 					resource.TestCheckResourceAttrSet(resourceName, "id"),
 					resource.TestCheckResourceAttrSet(resourceName, "image"),
@@ -272,6 +277,7 @@ variable "instance_extended_metadata" { default = {
 		some_string = "stringA"
 		nested_object = "{\"some_string\": \"stringB\", \"object\": {\"some_string\": \"stringC\"}}"
 	} }
+variable "instance_fault_domain" { default = "FAULT-DOMAIN-2" }
 variable "instance_freeform_tags" { default = {"Department"= "Accounting"} }
 variable "instance_hostname_label" { default = "hostnameLabel" }
 variable "instance_image" { default = "image" }
@@ -308,6 +314,7 @@ data "oci_core_instances" "test_instances" {
 					resource.TestCheckResourceAttr(datasourceName, "instances.0.defined_tags.%", "1"),
 					resource.TestCheckResourceAttr(datasourceName, "instances.0.display_name", "displayName2"),
 					resource.TestCheckResourceAttr(datasourceName, "instances.0.extended_metadata.%", "2"),
+					resource.TestCheckResourceAttr(datasourceName, "instances.0.fault_domain", "FAULT-DOMAIN-2"),
 					resource.TestCheckResourceAttr(datasourceName, "instances.0.freeform_tags.%", "1"),
 					resource.TestCheckResourceAttrSet(datasourceName, "instances.0.id"),
 					resource.TestCheckResourceAttrSet(datasourceName, "instances.0.image"),

provider/core_instances_data_source.go

@@ -142,6 +142,10 @@ func (s *InstancesDataSourceCrud) SetData() error {
 			instance["extended_metadata"] = convertNestedMapToFlatMap(r.ExtendedMetadata)
 		}
 
+		if r.FaultDomain != nil {
+			instance["fault_domain"] = *r.FaultDomain
+		}
+
 		instance["freeform_tags"] = r.FreeformTags
 
 		if r.Id != nil {

provider/identity_fault_domain_test.go

@@ -0,0 +1,64 @@
+// Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+
+package provider
+
+import (
+	"fmt"
+	"testing"
+
+	"regexp"
+
+	"github.com/hashicorp/terraform/helper/resource"
+	"github.com/hashicorp/terraform/terraform"
+)
+
+const (
+	FaultDomainResourceConfig = FaultDomainResourceDependencies + `
+
+`
+	FaultDomainPropertyVariables = `
+
+`
+	FaultDomainResourceDependencies = AvailabilityDomainConfig
+)
+
+func TestIdentityFaultDomainResource_basic(t *testing.T) {
+	provider := testAccProvider
+	config := testProviderConfig()
+
+	compartmentId := getEnvSettingWithBlankDefault("compartment_ocid")
+	compartmentIdVariableStr := fmt.Sprintf("variable \"compartment_id\" { default = \"%s\" }\n", compartmentId)
+
+	datasourceName := "data.oci_identity_fault_domains.test_fault_domains"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() { testAccPreCheck(t) },
+		Providers: map[string]terraform.ResourceProvider{
+			"oci": provider,
+		},
+		Steps: []resource.TestStep{
+			// verify datasource
+			{
+				Config: config + `
+
+data "oci_identity_fault_domains" "test_fault_domains" {
+	#Required
+	availability_domain = "${lookup(data.oci_identity_availability_domains.test_availability_domains.availability_domains[0],"name")}"
+	compartment_id = "${var.compartment_id}"
+}
+                ` + compartmentIdVariableStr + FaultDomainResourceConfig,
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestMatchResourceAttr(datasourceName, "availability_domain", regexp.MustCompile(`\w+-AD-\d+`)),
+					resource.TestMatchResourceAttr(datasourceName, "compartment_id", regexp.MustCompile(`.*?(tenancy|compartment).*?`)),
+					resource.TestCheckResourceAttr(datasourceName, "fault_domains.#", "3"), // more could be added in the future
+					resource.TestMatchResourceAttr(datasourceName, "fault_domains.0.availability_domain", regexp.MustCompile(`\w+-AD-\d+`)),
+					resource.TestMatchResourceAttr(datasourceName, "fault_domains.0.compartment_id", regexp.MustCompile(`.*?(tenancy|compartment).*?`)),
+					resource.TestMatchResourceAttr(datasourceName, "fault_domains.0.id", regexp.MustCompile(`.*?faultdomain.*?`)),
+					resource.TestCheckResourceAttr(datasourceName, "fault_domains.0.name", "FAULT-DOMAIN-1"),
+					resource.TestCheckResourceAttr(datasourceName, "fault_domains.1.name", "FAULT-DOMAIN-2"),
+					resource.TestCheckResourceAttr(datasourceName, "fault_domains.2.name", "FAULT-DOMAIN-3"),
+				),
+			},
+		},
+	})
+}