scylladb / terraform-provider-scylladbcloud

Terraform provider for ScyllaDB Cloud.
https://registry.terraform.io/providers/scylladb/scylladbcloud/latest
Apache License 2.0
11 stars 10 forks source link

internal/provider: add optional metadata param #161

Closed rjeczalik closed 3 months ago

rjeczalik commented 4 months ago

This PR adds a new, optional metadata parameter, which controls whether ScyllaDB Cloud client should fetch deployment metadata prior to issuing API calls.

The deployment metadata is used to map various region, instance etc. identifier to human-readable text strings.

By default metadata is always on and true.

It is safe to turn off the metadata retrieval, when it's known to be not needed - e.g. for Stacks API integration.

For regular use of terraform providers user will not need to control this behavior. The main use-case for this new param are automation flows.

ksinica commented 3 months ago

@rjeczalik: Maybe it is also worth mentioning this newly added SCYLLADB_CLOUD_IGNORE_META environment variable in the docs/index.md? I understand that most users will not be interested in this addition, but for the sake of completeness.

rjeczalik commented 3 months ago

SCYLLADB_CLOUD_IGNORE_META

It's removed, thus it's not mentioned.

Completeness depends on the perspective, from the perspective of the user it is already complete.

ksinica commented 3 months ago

You're right, I was thinking about the added metadata field, but somehow written about the environment variable. I'm not insisting on adding the information about it.

rjeczalik commented 3 months ago

I prefer having this behavior declared explicitly in the configuration rather than the environment variable.

👍

Thanks!

mykaul commented 3 months ago

Where's the documentation for this?