newrelic / terraform-provider-newrelic

Terraform provider for New Relic
https://registry.terraform.io/providers/newrelic/newrelic/latest/docs
Mozilla Public License 2.0
201 stars 246 forks source link

Synthetic private minion doc(s) need to specify GUID in all places #2072

Closed npreiser closed 1 year ago

npreiser commented 1 year ago

Any place in the synthetic resource docs where private minion is used, including the examples, please add a note that the "ID" is actually the GUID of the private minion.
Every minion has multiple ids, and customers are getting confused.

kidk commented 1 year ago

Thanks @npreiser

We took a look at the documentation and we mention GUID a lot for the attributes related to private minion. Could you add some detail where exactly you feel we could clear some confusion?

ericksoen commented 1 year ago

I ran into the same issue with one of my developers today with the docs for [synthetics private location data source] (https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/data-sources/synthetics_private_location).

NSSPKrishna commented 1 year ago

We have reviewed the documentation and made changes accordingly. Please feel free to raise a new issue if you feel this is still an issue.

jayntguru commented 1 year ago

This is still extremely confusing. What's the GUID? How do I match up to what's in the New Relic UI?

Nothing in this example matches what I can get out of the UI. https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/data-sources/synthetics_private_location

Or here. https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/synthetics_monitor#additional-examples

It would be great if the documentation matched something here. Since nothing in the examples match, I don't have a clue what I'm supposed to use here.

account:blah accountId: blah key:blah locationId:foo minionCount:0 trustedAccountId: foo verifiedScriptExecution:false vse:false

Also the terraform plugin will create something that passes an init/plan but errors on apply. (Plan does not seem to be validating the location_private.)

jayntguru commented 1 year ago

Couple of other documentation things I found.

https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/data-sources/synthetics_private_location

The top example here the data name doesn't match what's in the resource example The bottom example also says location_private and it's locations_private

I think I figured out how to get the GUID/ID from using data, but I'm confused on how I use multiple locations.