Add GKE Multicloud #5522

nat-henderson · 2021-12-07T00:46:33Z

This PR adds GKE Multicloud to Terraform, via the DCL.

A few notes of complexity here:

This resource caused a separation in the DCL of struct name and resource name, which required some changes to name manipulation in TPGTools. A follow-on PR is coming to address that.
This resource has the first DCL-bridge regional endpoint, so we needed to use replaceVars to get the location out before sending it to the DCL.
Some of the samples are hand-edited, because Terraform can't easily perform the necessary operations to update and replace a Client. Those updates are tested in the DCL but can't be easily tested here.
These resources require a ton of novel variables because they are designed to use things set up in other clouds.

If this PR is for Terraform, I acknowledge that I have:

Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

google_container_azure_client

google_container_azure_cluster

google_container_azure_node_pool

google_container_aws_cluster

google_container_aws_node_pool

google_container_aws_versions

google_container_azure_versions

modular-magician · 2021-12-07T00:58:48Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 38 files changed, 8038 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 41 files changed, 8104 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 27 insertions(+), 1 deletion(-))

nat-henderson · 2021-12-07T20:19:11Z

/gcbrun

modular-magician · 2021-12-07T20:32:56Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 38 files changed, 8038 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 41 files changed, 8104 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 27 insertions(+), 1 deletion(-))

modular-magician · 2021-12-07T22:28:47Z

I have triggered VCR tests in RECORDING mode for the following tests that failed during VCR: TestAccDatasourceGoogleServiceNetworkingPeeredDnsDomain_basic|TestAccApigeeEnvironmentIamBindingGenerated|TestAccApigeeEnvironmentIamMemberGenerated|TestAccApigeeEnvironmentIamPolicyGenerated|TestAccCloudFunctionsFunction_vpcConnector|TestAccComputeRegionNetworkEndpointGroup_regionNetworkEndpointGroupAppengineExample|TestAccContainerAwsCluster_BasicCluster|TestAccContainerAwsCluster_MinimalCluster|TestAccContainerAwsNodePool_BasicNodePool|TestAccContainerAwsNodePool_MinimalNodePool|TestAccContainerAzureCluster_BasicCluster|TestAccContainerAzureCluster_MinimalCluster|TestAccContainerAzureNodePool_BasicNodePool|TestAccContainerAzureNodePool_MinimalNodePool|TestAccContainerCluster_errorAutopilotLocation|TestAccContainerNodePool_withInvalidUpgradeSettings You can view the result here: https://ci-oss.hashicorp.engineering/viewQueued.html?itemId=228882

modular-magician · 2021-12-07T22:49:07Z

Tests failed during RECORDING mode: TestAccContainerAzureCluster_MinimalCluster|TestAccContainerAzureCluster_BasicCluster|TestAccContainerAwsNodePool_MinimalNodePool|TestAccContainerAwsNodePool_BasicNodePool|TestAccContainerAwsCluster_BasicCluster|TestAccContainerAwsCluster_MinimalCluster|TestAccContainerAzureNodePool_MinimalNodePool|TestAccContainerAzureNodePool_BasicNodePool|TestAccContainerCluster_errorAutopilotLocation|TestAccCloudFunctionsFunction_vpcConnector|TestAccComputeRegionNetworkEndpointGroup_regionNetworkEndpointGroupAppengineExample|TestAccContainerNodePool_withInvalidUpgradeSettings Please fix these to complete your PR

nat-henderson · 2021-12-08T03:45:25Z

Needed to enable the service - https://ci-oss.hashicorp.engineering/buildConfiguration/GoogleCloudBeta_ProviderGoogleCloudBetaMmUpstreamVcr/228997 contains the next test run.

modular-magician · 2021-12-10T00:30:51Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 45 files changed, 7984 insertions(+), 20 deletions(-))
Terraform Beta: Diff ( 47 files changed, 8032 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 27 insertions(+), 1 deletion(-))

modular-magician · 2021-12-10T00:47:18Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 44 files changed, 7954 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 47 files changed, 8020 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 27 insertions(+), 1 deletion(-))

slevenick

Kicked off tests at: https://ci-oss.hashicorp.engineering/buildConfiguration/GoogleCloudBeta_ProviderGoogleCloudBetaMmUpstreamVcr/230432

Looks like TestAccContainerAwsNodePool_BasicHandWritten failed due to invalid GKE versions

There seem to be some problems with fields not getting docs generated: https://github.com/modular-magician/terraform-provider-google-beta/compare/auto-pr-5522-old..auto-pr-5522#diff-23ae12e759b02f32bb44a3051c475caaa877980c393a288714647c43bbee06d5R134

Maybe the OpenAPI spec doesn't have descriptions for these fields? The sub-fields also have empty descriptions

I'm also noticing a pattern on name fields having incorrect formats in their description. It includes the output format projects/{project}/locations/{location}/... rather than the expected input format which is just the name of the resource. This is a fairly common problem across auto-generated DCL descriptions

slevenick · 2021-12-10T17:55:52Z

mmv1/third_party/terraform/website/docs/d/container_aws_versions.html.markdown

+
+The following arguments are supported:
+
+* `location` (Optional) - The location (region or zone) to list versions for.


Is location going to be a GCP location or a AWS location?

This is GCP location e.g. us-west1, us-east4 etc.

nit: Could we remove "zone"? I don't think we support GCP zones.

nat-henderson · 2021-12-13T22:15:09Z

Fixed those things - the docs were missing in the openapi spec, yep.

modular-magician · 2021-12-13T22:27:29Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 45 files changed, 7974 insertions(+), 20 deletions(-))
Terraform Beta: Diff ( 47 files changed, 8022 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 27 insertions(+), 1 deletion(-))

modular-magician · 2021-12-14T00:15:19Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 44 files changed, 7964 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 47 files changed, 8030 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 27 insertions(+), 1 deletion(-))

nat-henderson · 2021-12-14T22:31:59Z

FWIW that test passes now, https://ci-oss.hashicorp.engineering/buildConfiguration/GoogleCloudBeta_ProviderGoogleCloudBetaMmUpstreamVcr/231691

slevenick · 2021-12-15T00:23:41Z

Looks like fleet has a similar missing description: https://github.com/modular-magician/terraform-provider-google/compare/auto-pr-5522-old..auto-pr-5522#diff-23ae12e759b02f32bb44a3051c475caaa877980c393a288714647c43bbee06d5R134

This is the same field that previously didn't have descriptions, do we need a DCL update to pull the new field descriptions?

slevenick · 2021-12-15T00:28:13Z

Annotations and tags are listed as empty objects in the docs, which seems strange. Should these have values present in the samples? https://github.com/modular-magician/terraform-provider-google/compare/auto-pr-5522-old..auto-pr-5522?short_path=addc80c#diff-2a61e3e0e41cd564d2112d73c99bea55867cdabf41ad9bbb572b82047648272eR94

nat-henderson · 2021-12-15T00:33:18Z

This is the same field that previously didn't have descriptions, do we need a DCL update to pull the new field descriptions?

Yeah ... it's weird, it generates correctly on my machine.

e: I see, there was a merge conflict. Let me resolve that.

Annotations and tags are listed as empty objects in the docs, which seems strange. Should these have values present in the samples? https://github.com/modular-magician/terraform-provider-google/compare/auto-pr-5522-old..auto-pr-5522?short_path=addc80c#diff-2a61e3e0e41cd564d2112d73c99bea55867cdabf41ad9bbb572b82047648272eR94

Those are handwritten - I can remove them or add values, if you have a preference.

… divergence in naming between this and OSPolicy.

…ible regions.

nat-henderson · 2021-12-15T00:37:02Z

Okay, fixed the merge conflict, so the docs will show up now... Anything other than the docs?

slevenick

Nothing major once the docs are fixed. Either way on the tags/annotations fields. Removing them in most cases probably makes sense as they seem to be nearly identical across resources

I think bringing up the requirement on project number rather than ID with the API team would be useful, as ID is much easier for most users to work with. But that's not blocking for this

slevenick · 2021-12-15T00:34:40Z

tpgtools/overrides/containeraws/samples/cluster/basic_update.tf.tmpl

+  }
+
+  fleet {
+    project = "{{project_number}}"


Do these values accept project ID as well? I believe they should based on AIP 2510, so it may be worth raising w/ the API team if they do not

Do these values accept project ID as well?

No, they currently don't accept project ID. For more context, AIP 2510 used to advocate always returning project number and the gkemulticloud API followed the old guidance. Accepting project ID could cause terraform to incorrectly detect a diff.
For our launch, we wanted to avoid making breaking API changes so we limited these values to only accept project numbers. This is something we're aware of and would consider supporting project ID post GA.

Yeah, we talked about this extensively and they're aware it's not ideal for cleanliness of user configs, but it's the best we could do.

slevenick · 2021-12-15T00:35:25Z

tpgtools/overrides/containerazure/samples/cluster/basic.tf.tmpl

+  }
+
+  azure_region = "westus2"
+  client       = "projects/{{project_number}}/locations/us-west1/azureClients/${google_container_azure_client.basic.name}"


Similarly this should accept a project ID to make user's lives easier

modular-magician · 2021-12-15T00:50:21Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 44 files changed, 7995 insertions(+), 19 deletions(-))
Terraform Beta: Diff ( 46 files changed, 8043 insertions(+), 1 deletion(-))
TF Validator: Diff ( 2 files changed, 27 insertions(+), 1 deletion(-))

slevenick · 2021-12-15T00:52:31Z

One note: The description for fleet.project indicates that the name of the project should be used, but because we specifically have added the project_number to the tests I'm guessing it only allows the # to be used? The description should probably reflect that if it is the case

nat-henderson · 2021-12-15T02:14:02Z

Okay, I'll run those tests again and check the docs before merging.

modular-magician · 2021-12-15T02:26:17Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 45 files changed, 7996 insertions(+), 20 deletions(-))
Terraform Beta: Diff ( 47 files changed, 8044 insertions(+), 2 deletions(-))
TF Validator: Diff ( 2 files changed, 27 insertions(+), 1 deletion(-))

nat-henderson · 2021-12-15T02:30:29Z

Great. All the tests pass and the docs look right.

* Release GKE Multicloud in terraform at GA. * Updates to samples as we go GA. * Some additional complexities in moving to GA - regional endpoints and divergence in naming between this and OSPolicy. * Move to handwritten samples, add data source for versions and permissible regions. * Add handwritten docs for Azure and AWS container versions. * Get data sources under same header as resources. * Fix documentation + update node pool test to use the version everywhere. * fix lints - do error checking. * Update DCL version again.

nat-henderson force-pushed the multicloud branch from b95e68a to 2e552e9 Compare December 10, 2021 00:08

nat-henderson marked this pull request as ready for review December 10, 2021 00:34

nat-henderson requested a review from slevenick December 10, 2021 00:34

slevenick reviewed Dec 10, 2021

View reviewed changes

slevenick self-requested a review December 15, 2021 00:20

nat-henderson added 8 commits December 14, 2021 16:34

Release GKE Multicloud in terraform at GA.

adef730

Updates to samples as we go GA.

e0cdc68

Some additional complexities in moving to GA - regional endpoints and…

11152e9

… divergence in naming between this and OSPolicy.

Move to handwritten samples, add data source for versions and permiss…

bb03fae

…ible regions.

Add handwritten docs for Azure and AWS container versions.

f2d1958

Get data sources under same header as resources.

d81ee00

Fix documentation + update node pool test to use the version everywhere.

d654be6

fix lints - do error checking.

ee34e13

nat-henderson force-pushed the multicloud branch from 7adc071 to ee34e13 Compare December 15, 2021 00:36

slevenick approved these changes Dec 15, 2021

View reviewed changes

Update DCL version again.

54308df

nat-henderson merged commit 58d3194 into master Dec 15, 2021

nat-henderson deleted the multicloud branch December 15, 2021 02:30

This was referenced Dec 15, 2021

Add GKE Multicloud GoogleCloudPlatform/terraform-validator#439

Merged

Add GKE Multicloud hashicorp/terraform-provider-google-beta#3928

Merged

Add GKE Multicloud hashicorp/terraform-provider-google#10754

Merged

rileykarson mentioned this pull request Dec 21, 2021

b/183445947 hashicorp/terraform-provider-google#8751

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GKE Multicloud #5522

Add GKE Multicloud #5522

nat-henderson commented Dec 7, 2021 •

edited

Loading

modular-magician commented Dec 7, 2021

nat-henderson commented Dec 7, 2021

modular-magician commented Dec 7, 2021

modular-magician commented Dec 7, 2021

modular-magician commented Dec 7, 2021

nat-henderson commented Dec 8, 2021

modular-magician commented Dec 10, 2021

modular-magician commented Dec 10, 2021

slevenick left a comment •

edited

Loading

slevenick Dec 10, 2021

hdp617 Dec 10, 2021

nat-henderson commented Dec 13, 2021

modular-magician commented Dec 13, 2021

modular-magician commented Dec 14, 2021

nat-henderson commented Dec 14, 2021

slevenick commented Dec 15, 2021 •

edited

Loading

slevenick commented Dec 15, 2021

nat-henderson commented Dec 15, 2021 •

edited

Loading

nat-henderson commented Dec 15, 2021

slevenick left a comment

slevenick Dec 15, 2021

hdp617 Dec 15, 2021 •

edited

Loading

nat-henderson Dec 15, 2021

slevenick Dec 15, 2021

modular-magician commented Dec 15, 2021

slevenick commented Dec 15, 2021

nat-henderson commented Dec 15, 2021

modular-magician commented Dec 15, 2021

nat-henderson commented Dec 15, 2021


		The following arguments are supported:

		* `location` (Optional) - The location (region or zone) to list versions for.

Add GKE Multicloud #5522

Add GKE Multicloud #5522

Conversation

nat-henderson commented Dec 7, 2021 • edited Loading

modular-magician commented Dec 7, 2021

Diff report:

nat-henderson commented Dec 7, 2021

modular-magician commented Dec 7, 2021

Diff report:

modular-magician commented Dec 7, 2021

modular-magician commented Dec 7, 2021

nat-henderson commented Dec 8, 2021

modular-magician commented Dec 10, 2021

Diff report:

modular-magician commented Dec 10, 2021

Diff report:

slevenick left a comment • edited Loading

Choose a reason for hiding this comment

slevenick Dec 10, 2021

Choose a reason for hiding this comment

hdp617 Dec 10, 2021

Choose a reason for hiding this comment

nat-henderson commented Dec 13, 2021

modular-magician commented Dec 13, 2021

Diff report:

modular-magician commented Dec 14, 2021

Diff report:

nat-henderson commented Dec 14, 2021

slevenick commented Dec 15, 2021 • edited Loading

slevenick commented Dec 15, 2021

nat-henderson commented Dec 15, 2021 • edited Loading

nat-henderson commented Dec 15, 2021

slevenick left a comment

Choose a reason for hiding this comment

slevenick Dec 15, 2021

Choose a reason for hiding this comment

hdp617 Dec 15, 2021 • edited Loading

Choose a reason for hiding this comment

nat-henderson Dec 15, 2021

Choose a reason for hiding this comment

slevenick Dec 15, 2021

Choose a reason for hiding this comment

modular-magician commented Dec 15, 2021

Diff report:

slevenick commented Dec 15, 2021

nat-henderson commented Dec 15, 2021

modular-magician commented Dec 15, 2021

Diff report:

nat-henderson commented Dec 15, 2021

nat-henderson commented Dec 7, 2021 •

edited

Loading

slevenick left a comment •

edited

Loading

slevenick commented Dec 15, 2021 •

edited

Loading

nat-henderson commented Dec 15, 2021 •

edited

Loading

hdp617 Dec 15, 2021 •

edited

Loading