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.

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 configurable retry when reading PrivateLink information #246

Merged
merged 5 commits into from
Dec 18, 2023

Conversation

tbroden84
Copy link
Contributor

WHY are these changes introduced?

Reported issues about "Timeout talking to backend" and lack of retries when reading PrivateLink information.

Reference: #243
Requires: 84codes/go-api#44

WHAT is this pull request doing?

  • Make retries configurable through sleep and timeout
  • Add sleep/timeout when reading PrivateLink information

HOW can this pull request be tested?

Manual enable PrivateLink and read out information.

Comment on lines 200 to 205
## Changelog

List of changes made to this resource for different versions.

[v1.29.0](https://github.com/cloudamqp/terraform-provider-cloudamqp/releases/tag/v1.29.0) added
configurable retries when reading PrivateLink information.
Copy link
Member

Choose a reason for hiding this comment

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

This is a nice touch but I think it can be hard to maintain properly. I think it is better to mention it in and concentrate our effort on keeping https://github.com/cloudamqp/terraform-provider-cloudamqp/blob/main/CHANGELOG.md as good as possible. WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True, tried it out here and liked it: a661e09#diff-6575c05c10a8f7d9c1d7cec73bd49538df9c9ace86edd8c659a7365aa79bd799
Just to get rid of all version input in the page as much as possible and keep it listed last. But could also become a hassle to keep track on.

Copy link
Member

Choose a reason for hiding this comment

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

Oh yeah I saw https://github.com/cloudamqp/terraform-provider-cloudamqp/pull/247/files#diff-9efdf0ce35a9a79cd4ff4aad80f648515a179242612ffa732cba9066aeb61c37R283 now

I think the information serves a purpose, like we add new capabilities to a resource, someone reading it may not use the latest version, so it is good for them to see what version they need to be using to take advantage of a certain thing.

I think we should specify that directly in the documentation next to the thing it applies to. "Available since v1.2.9". Would it be possible?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here are previous examples:
As note boxes (looks better at registry and their markdown):
https://github.com/cloudamqp/terraform-provider-cloudamqp/blob/v1.28.0/docs/resources/plugin.md#cloudamqp_plugin

For each argument:
https://github.com/cloudamqp/terraform-provider-cloudamqp/blob/gcp-peering-retries/docs/resources/vpc_gcp_peering.md#argument-reference

Then perhaps due the latter part, but with Available since v1.2.9 for each argument/attribute and skip the note part.

Copy link
Member

Choose a reason for hiding this comment

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

Sounds good, will be lots of boxes otherwise.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wrong PR but just a concept. Example base on the discussion.
8def353

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good, will be lots of boxes otherwise.

heh yeah, hence why I tried to put them in the changelog section instead.

Copy link
Member

Choose a reason for hiding this comment

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

Wrong PR but just a concept. Example base on the discussion. 8def353

Looks good but still think we should concentrate on only one changelog

Comment on lines 199 to 204
## Changelog

List of changes made to this resource for different versions.

[v1.29.0](https://github.com/cloudamqp/terraform-provider-cloudamqp/releases/tag/v1.29.0) added
configurable retries when reading PrivateLink information.
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

@dentarg dentarg left a comment

Choose a reason for hiding this comment

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

LGTM, just a thought about the changelog(s) :)

@tbroden84 tbroden84 merged commit f4c76b3 into main Dec 18, 2023
1 check passed
@tbroden84 tbroden84 deleted the privatelink-retries branch December 18, 2023 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants