terraform-google-lb-internal icon indicating copy to clipboard operation
terraform-google-lb-internal copied to clipboard

feat!: Simplify use of the all_ports argument

Open thatcoleyouknow opened this issue 1 year ago • 4 comments

Today, the ports argument is required and no mention of exclusivity between the ports and all_ports argument is mentioned in the variable description or Terraform Registry docs for this module. If someone wants to use the all_ports argument, they have to go through a process of trial and error to figure out what value to pass to the ports argument in order to successfully deploy the forwarding rule. I'm proposing to make the ports argument optional and set the default value to null, which is the only value the backend API will accept to deploy the forwarding rule when all_ports is set to true.

I can't find where to update the Terraform Registry docs for this module. Adding more detail around the mutual exclusivity of the ports and all_ports arguments[1] would help users understand that only one of the two should be used, if someone could make time to create an issue for that, please.

[1] https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_forwarding_rule.html#all_ports

thatcoleyouknow avatar Feb 15 '24 17:02 thatcoleyouknow

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

google-cla[bot] avatar Feb 15 '24 17:02 google-cla[bot]

/gcbrun

imrannayer avatar Mar 12 '24 23:03 imrannayer

/gcbrun

imrannayer avatar Mar 29 '24 21:03 imrannayer

@colereynolds since we are changing default behavior it has to be a breaking change. Can you plz add a document mentioning this behavior change in doc folder? use this doc as example. Create one for version 6.0.

imrannayer avatar Apr 05 '24 04:04 imrannayer

@colereynolds r u still working on this?

imrannayer avatar Apr 29 '24 14:04 imrannayer

@imrannayer Yes, I haven't forgotten about this. I have been in a very busy season but things are getting back to normal. I will make time to do this sometime this week.

thatcoleyouknow avatar Apr 29 '24 16:04 thatcoleyouknow

@imrannayer - Give this another look when you get a few. I made a few tweaks to update the README too.

thatcoleyouknow avatar May 02 '24 02:05 thatcoleyouknow

/gcbrun

imrannayer avatar May 02 '24 06:05 imrannayer

/gcbrun

imrannayer avatar May 02 '24 07:05 imrannayer