Added support for google_vertex_ai_tensorboard resource #6759

AlfatahB · 2022-11-01T05:14:54Z

Added support for google_vertex_ai_tensorboard resource.
fixes hashicorp/terraform-provider-google#12711

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_vertex_ai_tensorboard`

modular-magician · 2022-11-01T05:15:57Z

Hello! I am a robot who works on Magic Modules PRs.

I've detected that you're a community contributor. @melinath, a repository maintainer, has been assigned to assist you and help review your changes.

❓ First time contributing? Click here for more details

Your assigned reviewer will help review your code by:

Ensuring it's backwards compatible, covers common error cases, etc.
Summarizing the change into a user-facing changelog note.
Passes tests, either our "VCR" suite, a set of presubmit tests, or with manual test runs.

You can help make sure that review is quick by running local tests and ensuring they're passing in between each push you make to your PR's branch. Also, try to leave a comment with each push you make, as pushes generally don't generate emails.

If your reviewer doesn't get back to you within a week after your most recent change, please feel free to leave a comment on the issue asking them to take a look! In the absence of a dedicated review dashboard most maintainers manage their pending reviews through email, and those will sometimes get lost in their inbox.

modular-magician · 2022-11-01T05:30:04Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 4 files changed, 718 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 4 files changed, 718 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 122 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 4 files changed, 110 insertions(+))

modular-magician · 2022-11-01T06:15:34Z

Tests analytics

Total tests: 2211
Passed tests 1970
Skipped tests: 239
Failed tests: 2

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccFirebaserulesRelease_BasicRelease|TestAccVertexAITensorboard_vertexAiTensorboardExample

modular-magician · 2022-11-01T06:16:22Z

Tests passed during RECORDING mode:
TestAccFirebaserulesRelease_BasicRelease[Debug log]
TestAccVertexAITensorboard_vertexAiTensorboardExample[Debug log]

All tests passed
View the build log or the debug log for each test

mitj04 · 2022-11-02T10:56:01Z

LGTM

AlfatahB · 2022-11-08T13:41:03Z

@melinath Could you please review this PR?

melinath

This looks pretty good; however, it needs to have:

a "full" test that exercises as many settable fields as possible - in particular it should definitely set the encrypionSpec field, which probably means it will need to be handwritten.
an "update" test that exercises the update behavior; this will need to be handwritten.

I also have one question below.

mmv1/products/vertexai/terraform.yaml

…odules into vertexai-add-tensorboard-resource

modular-magician · 2022-11-11T07:05:54Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 5 files changed, 795 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 5 files changed, 795 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 122 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 4 files changed, 110 insertions(+))

modular-magician · 2022-11-11T07:55:11Z

Tests analytics

Total tests: 2244
Passed tests 2002
Skipped tests: 241
Failed tests: 1

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccVertexAITensorboard_Full

modular-magician · 2022-11-11T08:16:14Z

Tests failed during RECORDING mode:
TestAccVertexAITensorboard_Full[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

modular-magician · 2022-11-11T12:17:48Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 5 files changed, 907 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 5 files changed, 907 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 122 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 4 files changed, 110 insertions(+))

modular-magician · 2022-11-11T13:05:33Z

Tests analytics

Total tests: 2245
Passed tests 2002
Skipped tests: 241
Failed tests: 2

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccVertexAITensorboard_Update|TestAccVertexAITensorboard_Full

modular-magician · 2022-11-11T13:26:36Z

Tests passed during RECORDING mode:
TestAccVertexAITensorboard_Update[Debug log]

Tests failed during RECORDING mode:
TestAccVertexAITensorboard_Full[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

melinath · 2022-11-11T16:29:18Z

It looks like the "timeout" error is a misleading error; the reason there's a timeout is:

{
  "error": {
    "code": 429,
    "message": "The following quota metrics exceed quota limits: aiplatform.googleapis.com/in_use_customer_managed_encryption_keys",
    "status": "RESOURCE_EXHAUSTED"
  }
}

melinath · 2022-11-11T23:02:57Z

/gcbrun

modular-magician · 2022-11-11T23:18:49Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 5 files changed, 907 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 5 files changed, 907 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 122 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 4 files changed, 110 insertions(+))

modular-magician · 2022-11-12T00:01:05Z

Tests analytics

Total tests: 2250
Passed tests 2007
Skipped tests: 241
Failed tests: 2

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccFirebaserulesRelease_BasicRelease|TestAccVertexAITensorboard_Full

modular-magician · 2022-11-12T00:13:04Z

Tests passed during RECORDING mode:
TestAccFirebaserulesRelease_BasicRelease[Debug log]
TestAccVertexAITensorboard_Full[Debug log]

All tests passed
View the build log or the debug log for each test

melinath

this is looking really good - I realized there's a better way to handle the kms crypto key

melinath · 2022-11-15T21:16:14Z

mmv1/third_party/terraform/tests/resource_vertex_ai_tensorboard_test.go

+  name     = "keyring-%s"
+  location = "us-central1"
+}
+resource "google_kms_crypto_key" "example-key" {


Please switch this test to use BootstrapKMSKeyInLocation - it looks like this might even let you switch to generating the test using an example. For example:

magic-modules/mmv1/products/vertexai/terraform.yaml

Line 35 in 2fecbdf

- !ruby/object:Provider::Terraform::Examples

(I forgot this was an option previously :-) )

Using the bootstrapped crypto keys lets us limit the number of crypto keys created, which is important since they can't be deleted.

I've updated the test to use BootstrapKMSKeyInLocation.

…odules into vertexai-add-tensorboard-resource

modular-magician · 2022-11-16T06:09:56Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 5 files changed, 921 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 5 files changed, 921 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 122 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 8 files changed, 232 insertions(+))

modular-magician · 2022-11-16T07:00:41Z

Tests analytics

Total tests: 2267
Passed tests 2025
Skipped tests: 241
Failed tests: 1

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccVertexAITensorboard_vertexAiTensorboardFullExample

modular-magician · 2022-11-16T07:01:16Z

Tests passed during RECORDING mode:
TestAccVertexAITensorboard_vertexAiTensorboardFullExample[Debug log]

All tests passed
View the build log or the debug log for each test

melinath · 2022-11-16T16:11:24Z

mmv1/products/vertexai/terraform.yaml

+          display_name: "terraform"
+      - !ruby/object:Provider::Terraform::Examples
+        name: "vertex_ai_tensorboard_full"
+        skip_import_test: true


Why do these tests use skip_import_test?

It's because we need to use ImportStateVerifyIgnore: []string{"region", "project"} instead of ImportStateVerifyIgnore: []string{"region"}. There is a difference in the name field (projects/{project}/locations/{location}/tensorboards/{tensorboard}) of imported resources where instead of project_id we are getting project_number. Hence, I've used skip_import_test

I think that should be fine, since name is an output-only field.

You can use ignore_read_extra here & above instead of skip_import_test to just ignore the one additional field:

Suggested change

skip_import_test: true

ignore_read_extra:

- project

If the API returns project numbers - will users get a permadiff if they try to set the project field using a project id?

No, User won't face state drift if the project field is set to project id. It's just that import is forming the name field using the replaceVars function which takes the project_id and this gets changed when the resource is successfully imported.

I've updated examples to include ignore_read_extra for the tests.

modular-magician · 2022-11-16T18:04:50Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 5 files changed, 933 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 5 files changed, 933 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 122 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 8 files changed, 232 insertions(+))

modular-magician · 2022-11-16T18:52:38Z

Tests analytics

Total tests: 2270
Passed tests 2025
Skipped tests: 241
Failed tests: 4

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccComputeForwardingRule_update|TestAccVertexAITensorboard_vertexAiTensorboardExample|TestAccVertexAITensorboard_vertexAiTensorboardFullExample|TestAccFirebaserulesRelease_BasicRelease

modular-magician · 2022-11-16T18:53:53Z

Tests passed during RECORDING mode:
TestAccComputeForwardingRule_update[Debug log]
TestAccVertexAITensorboard_vertexAiTensorboardExample[Debug log]
TestAccVertexAITensorboard_vertexAiTensorboardFullExample[Debug log]
TestAccFirebaserulesRelease_BasicRelease[Debug log]

All tests passed
View the build log or the debug log for each test

melinath

LGTM

…latform#6759) * Added support for google_vertex_ai_tensorboard resource * Added full test case for google_vertex_ai_tensorboard resource * Added import support for google_vertex_ai_tensorboard * Added Full and Update test cases for google_vertex_ai_tensorboard * Updated the full test of google_vertex_ai_tensorboard * Updated examples to include import test for vertex_ai_tensorboard

Added support for google_vertex_ai_tensorboard resource

fd1e781

modular-magician requested a review from melinath November 1, 2022 05:15

AlfatahB marked this pull request as ready for review November 2, 2022 06:08

melinath requested changes Nov 10, 2022

View reviewed changes

mmv1/products/vertexai/terraform.yaml Outdated Show resolved Hide resolved

AlfatahB added 2 commits November 11, 2022 05:08

Merge branch 'main' of https://github.com/GoogleCloudPlatform/magic-m…

f1050f6

…odules into vertexai-add-tensorboard-resource

Added full test case for google_vertex_ai_tensorboard resource

619bfc0

modular-magician requested a review from melinath November 11, 2022 06:49

AlfatahB added 2 commits November 11, 2022 11:55

Added import support for google_vertex_ai_tensorboard

2471425

Added Full and Update test cases for google_vertex_ai_tensorboard

a8f4d07

melinath requested changes Nov 15, 2022

View reviewed changes

AlfatahB added 2 commits November 16, 2022 05:34

Merge branch 'main' of https://github.com/GoogleCloudPlatform/magic-m…

ac4c6d7

…odules into vertexai-add-tensorboard-resource

Updated the full test of google_vertex_ai_tensorboard

f037336

modular-magician requested a review from melinath November 16, 2022 05:55

melinath reviewed Nov 16, 2022

View reviewed changes

Updated examples to include import test for vertex_ai_tensorboard

db5c5ad

modular-magician requested a review from melinath November 16, 2022 17:50

melinath approved these changes Nov 17, 2022

View reviewed changes

melinath merged commit 67c3250 into GoogleCloudPlatform:main Nov 17, 2022

shotarok mentioned this pull request Nov 25, 2022

Support for Vertex AI resources hashicorp/terraform-provider-google#9298

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for google_vertex_ai_tensorboard resource #6759

Added support for google_vertex_ai_tensorboard resource #6759

AlfatahB commented Nov 1, 2022

modular-magician commented Nov 1, 2022

modular-magician commented Nov 1, 2022

modular-magician commented Nov 1, 2022

modular-magician commented Nov 1, 2022

mitj04 commented Nov 2, 2022

AlfatahB commented Nov 8, 2022

melinath left a comment

modular-magician commented Nov 11, 2022

modular-magician commented Nov 11, 2022

modular-magician commented Nov 11, 2022

modular-magician commented Nov 11, 2022

modular-magician commented Nov 11, 2022

modular-magician commented Nov 11, 2022

melinath commented Nov 11, 2022

melinath commented Nov 11, 2022

modular-magician commented Nov 11, 2022

modular-magician commented Nov 12, 2022

modular-magician commented Nov 12, 2022

melinath left a comment

melinath Nov 15, 2022

AlfatahB Nov 16, 2022

modular-magician commented Nov 16, 2022

modular-magician commented Nov 16, 2022

modular-magician commented Nov 16, 2022

melinath Nov 16, 2022

AlfatahB Nov 16, 2022

melinath Nov 16, 2022

AlfatahB Nov 16, 2022

AlfatahB Nov 16, 2022

modular-magician commented Nov 16, 2022

modular-magician commented Nov 16, 2022

modular-magician commented Nov 16, 2022

melinath left a comment

Added support for google_vertex_ai_tensorboard resource #6759

Added support for google_vertex_ai_tensorboard resource #6759

Conversation

AlfatahB commented Nov 1, 2022

modular-magician commented Nov 1, 2022

modular-magician commented Nov 1, 2022

Diff report

modular-magician commented Nov 1, 2022

Tests analytics

Action taken

modular-magician commented Nov 1, 2022

mitj04 commented Nov 2, 2022

AlfatahB commented Nov 8, 2022

melinath left a comment

Choose a reason for hiding this comment

modular-magician commented Nov 11, 2022

Diff report

modular-magician commented Nov 11, 2022

Tests analytics

Action taken

modular-magician commented Nov 11, 2022

modular-magician commented Nov 11, 2022

Diff report

modular-magician commented Nov 11, 2022

Tests analytics

Action taken

modular-magician commented Nov 11, 2022

melinath commented Nov 11, 2022

melinath commented Nov 11, 2022

modular-magician commented Nov 11, 2022

Diff report

modular-magician commented Nov 12, 2022

Tests analytics

Action taken

modular-magician commented Nov 12, 2022

melinath left a comment

Choose a reason for hiding this comment

melinath Nov 15, 2022

Choose a reason for hiding this comment

AlfatahB Nov 16, 2022

Choose a reason for hiding this comment

modular-magician commented Nov 16, 2022

Diff report

modular-magician commented Nov 16, 2022

Tests analytics

Action taken

modular-magician commented Nov 16, 2022

melinath Nov 16, 2022

Choose a reason for hiding this comment

AlfatahB Nov 16, 2022

Choose a reason for hiding this comment

melinath Nov 16, 2022

Choose a reason for hiding this comment

AlfatahB Nov 16, 2022

Choose a reason for hiding this comment

AlfatahB Nov 16, 2022

Choose a reason for hiding this comment

modular-magician commented Nov 16, 2022

Diff report

modular-magician commented Nov 16, 2022

Tests analytics

Action taken

modular-magician commented Nov 16, 2022

melinath left a comment

Choose a reason for hiding this comment