Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for policy_name field in Placement Policy #8475

Merged
merged 2 commits into from
Aug 1, 2023
Merged

Add support for policy_name field in Placement Policy #8475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac799f4
Add support for policy_name field in Placement Policy
morshielt Jul 27, 2023
e9793b7
Merge branch 'GoogleCloudPlatform:main' into placement_policy_name
morshielt Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions mmv1/third_party/terraform/services/container/resource_container_node_pool.go.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,12 @@ var schemaNodePool = map[string]*schema.Schema{
Required: true,
Description: `Type defines the type of placement policy`,
},
"policy_name": {
morshielt marked this conversation as resolved.
Show resolved Hide resolved
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.`,
},
<% unless version == 'ga' -%>
"tpu_topology": {
Type: schema.TypeString,
Expand Down Expand Up @@ -937,6 +943,7 @@ func expandNodePool(d *schema.ResourceData, prefix string) (*container.NodePool,
placement_policy := v.([]interface{})[0].(map[string]interface{})
np.PlacementPolicy = &container.PlacementPolicy{
Type: placement_policy["type"].(string),
PolicyName: placement_policy["policy_name"].(string),
<% unless version == 'ga' -%>
TpuTopology: placement_policy["tpu_topology"].(string),
<% end -%>
Expand Down Expand Up @@ -1131,6 +1138,7 @@ func flattenNodePool(d *schema.ResourceData, config *transport_tpg.Config, np *c
nodePool["placement_policy"] = []map[string]interface{}{
{
"type": np.PlacementPolicy.Type,
"policy_name": np.PlacementPolicy.PolicyName,
<% unless version == 'ga' -%>
"tpu_topology": np.PlacementPolicy.TpuTopology,
<% end -%>
Expand Down
61 changes: 61 additions & 0 deletions mmv1/third_party/terraform/tests/resource_container_cluster_test.go.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7884,3 +7884,64 @@ resource "google_container_cluster" "primary" {
min_master_version = 1.27
}`, name, enabled)
}


func TestAccContainerCluster_customPlacementPolicy(t *testing.T) {
t.Parallel()

cluster := fmt.Sprintf("tf-test-cluster-%s", acctest.RandString(t, 10))
np := fmt.Sprintf("tf-test-nodepool-%s", acctest.RandString(t, 10))
policy := fmt.Sprintf("tf-test-policy-%s", acctest.RandString(t, 10))

acctest.VcrTest(t, resource.TestCase{
PreCheck: func() { acctest.AccTestPreCheck(t) },
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
CheckDestroy: testAccCheckContainerNodePoolDestroyProducer(t),
Steps: []resource.TestStep{
{
Config: testAccContainerCluster_customPlacementPolicy(cluster, np, policy),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("google_container_cluster.cluster", "node_pool.0.placement_policy.0.type", "COMPACT"),
resource.TestCheckResourceAttr("google_container_cluster.cluster", "node_pool.0.placement_policy.0.policy_name", policy),
resource.TestCheckResourceAttr("google_container_cluster.cluster", "node_pool.0.node_config.0.machine_type", "c2-standard-4"),
),
},
{
ResourceName: "google_container_cluster.cluster",
ImportState: true,
ImportStateVerify: true,
},
},
})
}

func testAccContainerCluster_customPlacementPolicy(cluster, np, policyName string) string {
return fmt.Sprintf(`

resource "google_compute_resource_policy" "policy" {
name = "%s"
region = "us-central1"
group_placement_policy {
collocation = "COLLOCATED"
}
}

resource "google_container_cluster" "cluster" {
name = "%s"
location = "us-central1-a"

node_pool {
name = "%s"
initial_node_count = 2

node_config {
machine_type = "c2-standard-4"
}

placement_policy {
type = "COMPACT"
policy_name = google_compute_resource_policy.policy.name
}
}
}`, policyName, cluster, np)
}
62 changes: 62 additions & 0 deletions mmv1/third_party/terraform/tests/resource_container_node_pool_test.go.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1556,6 +1556,68 @@ resource "google_container_node_pool" "np" {
`, cluster, np, placementType)
}

func TestAccContainerNodePool_customPlacementPolicy(t *testing.T) {
t.Parallel()

cluster := fmt.Sprintf("tf-test-cluster-%s", acctest.RandString(t, 10))
np := fmt.Sprintf("tf-test-nodepool-%s", acctest.RandString(t, 10))
policy := fmt.Sprintf("tf-test-policy-%s", acctest.RandString(t, 10))

acctest.VcrTest(t, resource.TestCase{
PreCheck: func() { acctest.AccTestPreCheck(t) },
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
CheckDestroy: testAccCheckContainerNodePoolDestroyProducer(t),
Steps: []resource.TestStep{
{
Config: testAccContainerNodePool_customPlacementPolicy(cluster, np, policy),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("google_container_node_pool.np", "node_config.0.machine_type", "c2-standard-4"),
resource.TestCheckResourceAttr("google_container_node_pool.np", "placement_policy.0.policy_name", policy),
resource.TestCheckResourceAttr("google_container_node_pool.np", "placement_policy.0.type", "COMPACT"),
),
},
{
ResourceName: "google_container_node_pool.np",
ImportState: true,
ImportStateVerify: true,
},
},
})
}

func testAccContainerNodePool_customPlacementPolicy(cluster, np, policyName string) string {
return fmt.Sprintf(`
resource "google_container_cluster" "cluster" {
name = "%s"
location = "us-central1-a"
initial_node_count = 1
}

resource "google_compute_resource_policy" "policy" {
name = "%s"
region = "us-central1"
group_placement_policy {
collocation = "COLLOCATED"
}
}

resource "google_container_node_pool" "np" {
name = "%s"
location = "us-central1-a"
cluster = google_container_cluster.cluster.name
initial_node_count = 2

node_config {
machine_type = "c2-standard-4"
}
placement_policy {
type = "COMPACT"
policy_name = google_compute_resource_policy.policy.name
}
}
`, cluster, policyName, np)
}

func TestAccContainerNodePool_threadsPerCore(t *testing.T) {
t.Parallel()

Expand Down
4 changes: 4 additions & 0 deletions mmv1/third_party/terraform/website/docs/r/container_node_pool.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,10 @@ cluster.
Specifying COMPACT placement policy type places node pool's nodes in a closer
physical proximity in order to reduce network latency between nodes.

* `policy_name` - (Optional) If set, refers to the name of a custom resource policy supplied by the user.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should also be documented in the container_cluster markdown I believe? Though I'm not seeing the whole placement_policy object in there, maybe it was missed when it was added

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The placement_policy is a node pool setting - it can be passed during cluster creation as documented here, but it only impacts the default created node pool. Should it be included in container_cluster markdown then?

The resource policy must be in the same project and region as the node pool.
If not found, InvalidArgument error is returned.

* `tpu_topology` - (Optional, Beta) The [TPU placement topology](https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies) for pod slice node pool.

## Attributes Reference
Expand Down