Merge pull request #416 from tenthirtyam/add-placement-policy

Add `placement_policy` to `vra_project`

Author: frodenas

examples/project/main.tf

@@ -66,6 +66,8 @@ resource "vra_project" "this" {
 
   machine_naming_template = "$${resource.name}-$${####}"
 
+  placement_policy = "SPREAD"
+
   constraints {
     extensibility {
       expression = "foo:bar"

vra/data_source_project.go

@@ -74,6 +74,11 @@ func dataSourceProject() *schema.Resource {
 				Optional:    true,
 				Description: "The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds.",
 			},
+			"placement_policy": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The placement policy that will be applied when selecting a cloud zone for provisioning.",
+			},
 			"id": {
 				Type:        schema.TypeString,
 				Optional:    true,
@@ -166,6 +171,7 @@ func dataSourceProjectRead(d *schema.ResourceData, meta interface{}) error {
 		d.Set("member_roles", flattenUsers(project.Members))
 		d.Set("name", project.Name)
 		d.Set("operation_timeout", project.OperationTimeout)
+		d.Set("placement_policy", project.PlacementPolicy)
 		d.Set("shared_resources", project.SharedResources)
 		d.Set("viewers", flattenUsers(project.Viewers))
 		d.Set("viewer_roles", flattenUsers(project.Viewers))

vra/resource_project.go

@@ -2,6 +2,7 @@ package vra
 
 import (
 	"context"
+	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -58,6 +59,20 @@ func resourceProject() *schema.Resource {
 				Optional:    true,
 				Description: "The naming template to be used for resources provisioned in this project.",
 			},
+			"placement_policy": {
+				Type:        schema.TypeString,
+				Default:     "DEFAULT",
+				Description: "The placement policy that will be applied when selecting a cloud zone for provisioning.",
+				Optional:    true,
+				ValidateFunc: func(v interface{}, k string) (ws []string, errors []error) {
+					value := v.(string)
+					if value != "DEFAULT" && value != "SPREAD" {
+						errors = append(errors, fmt.Errorf(
+							"%q must be one of 'DEFAULT', 'SPREAD'", k))
+					}
+					return
+				},
+			},
 			"members": {
 				Type:        schema.TypeSet,
 				Optional:    true,
@@ -149,6 +164,7 @@ func resourceProjectCreate(ctx context.Context, d *schema.ResourceData, m interf
 	members := expandUserListAndNewUserList(d.Get("members").(*schema.Set).List(), d.Get("member_roles").(*schema.Set).List())
 	name := d.Get("name").(string)
 	operationTimeout := int64(d.Get("operation_timeout").(int))
+	placementPolicy := d.Get("placement_policy").(string)
 	sharedResources := d.Get("shared_resources").(bool)
 	viewers := expandUserListAndNewUserList(d.Get("viewers").(*schema.Set).List(), d.Get("viewer_roles").(*schema.Set).List())
 	zoneAssignment := expandZoneAssignment(d.Get("zone_assignments").(*schema.Set).List())
@@ -162,6 +178,7 @@ func resourceProjectCreate(ctx context.Context, d *schema.ResourceData, m interf
 		Members:                      members,
 		Name:                         &name,
 		OperationTimeout:             &operationTimeout,
+		PlacementPolicy:              placementPolicy,
 		SharedResources:              *withBool(sharedResources),
 		Viewers:                      viewers,
 		ZoneAssignmentConfigurations: zoneAssignment,
@@ -199,6 +216,7 @@ func resourceProjectRead(ctx context.Context, d *schema.ResourceData, m interfac
 	d.Set("member_roles", flattenUsers(project.Members))
 	d.Set("name", project.Name)
 	d.Set("operation_timeout", project.OperationTimeout)
+	d.Set("placement_policy", project.PlacementPolicy)
 	d.Set("shared_resources", project.SharedResources)
 	d.Set("viewers", flattenUsers(project.Viewers))
 	d.Set("viewer_roles", flattenUsers(project.Viewers))
@@ -221,6 +239,7 @@ func resourceProjectUpdate(ctx context.Context, d *schema.ResourceData, m interf
 	viewers := expandUserListAndNewUserList(d.Get("viewers").(*schema.Set).List(), d.Get("viewer_roles").(*schema.Set).List())
 	name := d.Get("name").(string)
 	operationTimeout := int64(d.Get("operation_timeout").(int))
+	placementPolicy := d.Get("placement_policy").(string)
 	sharedResources := d.Get("shared_resources").(bool)
 	zoneAssignment := expandZoneAssignment(d.Get("zone_assignments").(*schema.Set).List())
 
@@ -233,6 +252,7 @@ func resourceProjectUpdate(ctx context.Context, d *schema.ResourceData, m interf
 		Members:                      members,
 		Name:                         &name,
 		OperationTimeout:             &operationTimeout,
+		PlacementPolicy:              placementPolicy,
 		SharedResources:              *withBool(sharedResources),
 		Viewers:                      viewers,
 		ZoneAssignmentConfigurations: zoneAssignment,

website/docs/d/vra_project.html.markdown

@@ -6,6 +6,7 @@ description: |-
 ---
 
 # Data Source: vra_project
+
 ## Example Usages
 This is an example of how to create a project data source.
 
@@ -29,12 +30,13 @@ A project data source supports the following arguments:
 
 ## Argument Reference
 
-* `administrators` - (Optional) List of administrator users associated with the project. Only administrators can manage project's configuration. 
-Deprecated, to specify the type of principal, please refer `administrator_roles`.
+* `administrators` - (Optional) A list of administrator users associated with the project. Only administrators can manage project's configuration. 
+
+  > **Note**:  Deprecated - please refer to `administrator_roles`.
 
 * `administrator_roles` - (Optional) Administrator users or groups associated with the project. Only administrators can manage project's configuration. 
 
-* `constraints` - (Optional) List of storage, network and extensibility constraints to be applied when provisioning through this project.
+* `constraints` - (Optional) A list of storage, network and extensibility constraints to be applied when provisioning through this project.
 
 * `custom_properties` - (Optional) The project custom properties which are added to all requests in this project.
 
@@ -44,20 +46,26 @@ Deprecated, to specify the type of principal, please refer `administrator_roles`
 
 * `machine_naming_template` - (Optional) The naming template to be used for resources provisioned in this project.
 
-* `members` - (Optional) List of member users associated with the project. Deprecated, to specify the type of principal, please refer `member_roles`.
+* `members` - (Optional) A list of member users associated with the project. 
+  
+  > **Note**:  Deprecated - please refer to `member_roles`.
 
 * `member_roles` - (Optional) Member users or groups associated with the project. 
 
 * `name` - (Optional) A human-friendly name used as an identifier in APIs that support this option.
 
 * `operation_timeout` - (Optional) The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds.
 
+* `placement_policy` - (Optional) The placement policy that will be applied when selecting a cloud zone for provisioning. Must be one of `DEFAULT` or `SPREAD`.
+
 * `shared_resources` - (Optional) Specifies whether the resources in this projects are shared or not. If not set default will be used.
 
-* `zone_assignments` - (Optional) List of configurations for zone assignment to a project.
+* `zone_assignments` - (Optional) A list of configurations for zone assignment to a project.
 
 * `shared_resources` - (Optional) The id of the organization this entity belongs to.
 
-* `viewers` - (Optional) List of viewer users associated with the project. Deprecated, to specify the type of principal, please refer `viewer_roles`.
+* `viewers` - (Optional) A list of viewer users associated with the project. 
+
+  > **Note**:  Deprecated - please refer to `viewer_roles`.
 
 * `viewer_roles` - (Optional) Viewer users or groups associated with the project. 

website/docs/r/vra_project.html.markdown

@@ -2,10 +2,12 @@
 layout: "vra"
 page_title: "VMware vRealize Automation: vra_project"
 description: |-
-  Provides a VMware vRA vra_project resource.
+  Provides a VMware vRealize Automation vra_project resource.
 ---
 # Resource: vra\_project
+
 ## Example Usages
+
 This is an example of how to create a project resource.
 
 ```hcl
@@ -34,51 +36,53 @@ resource "vra_project" "this" {
   
   administrator_roles {
     email = "[email protected]"
-    type = "user"
+    type  = "user"
   }
 
   administrator_roles {
     email = "[email protected]"
-    type = "group"
+    type  = "group"
   }
 
   # Deprecated, please use member_roles instead.
   members = ["[email protected]"]
 
   member_roles {
     email = "[email protected]"
-    type = "user"
+    type  = "user"
   }
 
   member_roles {
     email = "[email protected]"
-    type = "group"
+    type  = "group"
   }
 
   # Deprecated, please use viewer_roles instead
   viewers = ["[email protected]"]
 
   viewer_roles {
     email = "[email protected]"
-    type = "user"
+    type  = "user"
   }
 
   viewer_roles {
     email = "[email protected]"
-    type = "group"
+    type  = "group"
   }
 
   operation_timeout = 6000
 
   machine_naming_template = "$${resource.name}-$${####}"
 
+  placement_policy = "SPREAD"
+
   constraints {
     extensibility {
       expression = "foo:bar"
       mandatory  = false
     }
     extensibility {
-      expression = "environment:Test"
+      expression = "environment:test"
       mandatory  = true
     }
 
@@ -87,7 +91,7 @@ resource "vra_project" "this" {
       mandatory  = false
     }
     network {
-      expression = "environment:Test"
+      expression = "environment:test"
       mandatory  = true
     }
 
@@ -96,7 +100,7 @@ resource "vra_project" "this" {
       mandatory  = false
     }
     storage {
-      expression = "environment:Test"
+      expression = "environment:test"
       mandatory  = true
     }
   }
@@ -107,40 +111,48 @@ A project resource supports the following arguments:
 
 ## Argument Reference
 
-* `administrators` - (Optional) List of administrator users associated with the project. Only administrators can manage project's configuration. 
-Deprecated, specify the type of principal, please refer `administrator_roles`.
+* `administrators` - (Optional) A list of administrator users associated with the project. Only administrators can manage project's configuration. 
+
+  > **Note**:  Deprecated - please refer to `administrator_roles`.
 
 * `administrator_roles` - (Optional) Administrator users or groups associated with the project. Only administrators can manage project's configuration. 
 
-* `constraints` - (Optional) List of storage, network and extensibility constraints to be applied when provisioning through this project.
+* `constraints` - (Optional) A list of storage, network, and extensibility constraints to be applied when provisioning through this project.
 
 * `custom_properties` - (Optional) The project custom properties which are added to all requests in this project.
 
 * `description` - (Optional) A human-friendly description.
 
 * `machine_naming_template` - (Optional) The naming template to be used for resources provisioned in this project.
 
-* `members` - (Optional) List of member users associated with the project. Deprecated, specify the type of principal, please refer `member_roles`.
+* `members` - (Optional) A list of member users associated with the project. 
+  
+  > **Note**:  Deprecated - please refer to `member_roles`.
 
 * `member_roles` - (Optional) Member users or groups associated with the project. 
 
 * `name` - (Required) A human-friendly name used as an identifier in APIs that support this option.
 
-* `operation_timeout` - (Optional) The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds.
+* `operation_timeout` - (Optional) The timeout that should be used for cloud template operations and provisioning tasks. The timeout is measured in seconds.
+
+* `placement_policy` - (Optional) The placement policy that will be applied when selecting a cloud zone for provisioning. Must be one of `DEFAULT` or `SPREAD`.
 
 * `shared_resources` - (Optional) Specifies whether the resources in this projects are shared or not. If not set default will be used.
 
-* `viewers` - (Optional) List of viewer users associated with the project. Deprecated, specify the type of principal, please refer `viewer_roles`.
+* `viewers` - (Optional) A list of viewer users associated with the project. 
+
+  > **Note**:  Deprecated - please refer to `viewer_roles`.
 
 * `viewer_roles` - (Optional) Viewer users or groups associated with the project. 
 
-* `zone_assignments` - (Optional) List of configurations for zone assignment to a project.
+* `zone_assignments` - (Optional) A list of configurations for zone assignment to a project.
 
-**Due to the design of IAAS API to update a project, it's not able to add and remove user or group at the same time. Please execute `terraform apply` twice.**
+**Due to the design of the vRealize Automation IaaS API to update a project, it's not able to add and remove user or group at the same time. Please execute `terraform apply` twice.**
 
 Example:
 
-Initially, we have `jason` and `tony` configured as administrator in the config file
+Initially, we have `jason` and `tony` configured as administrator. The initial the configuration:
+
 ```hcl
   administrator_roles {
     email = "[email protected]"
@@ -153,7 +165,7 @@ Initially, we have `jason` and `tony` configured as administrator in the config
   }
 ```
 
-Now we want to add `bob` as a new administrator and remove `jason`, the modified config file will be 
+Next, we want to add `bob` as a new administrator and remove `jason`. The modified configuration:
 
 ```hcl
   administrator_roles {
@@ -167,5 +179,5 @@ Now we want to add `bob` as a new administrator and remove `jason`, the modified
   }
 ```
 
-To complete the whole operation, it requires executing `terraform apply` twice.
+To complete the whole operation, it requires running `terraform apply` twice.