terraform-provider-ibm icon indicating copy to clipboard operation
terraform-provider-ibm copied to clipboard

ibm_dns_glb docs to not specify the enabled argument

Open powellquiring opened this issue 2 years ago • 8 comments

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

New or Affected Resource(s) or Datasource(s)

  • ibm_dns_glb

Description

https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/dns_glb

There is no description for the enabled argument. The default is false. So without this argument the resource does not work.

image

example:

resource "ibm_dns_glb" "cloud" {
  depends_on    = [ibm_dns_glb_pool.cloud]
  name          = "backend"
  enabled       = true
  instance_id   = ibm_resource_instance.dns.guid
  zone_id       = ibm_dns_zone.widgets_com.zone_id
...

References

  • #0000

powellquiring avatar Jun 02 '22 14:06 powellquiring

@gahlaut-rahul can you please look into it

hkantare avatar Jun 07 '22 08:06 hkantare

@powellquiring it is in review.

gahlaut-rahul avatar Jun 10 '22 09:06 gahlaut-rahul

Is the default documented?

powellquiring avatar Jun 14 '22 15:06 powellquiring

@powellquiring It is like enabled is treated as optional (it is not mandatory each optional will have some default, right ? ) and if you do not mention enabled in tf file, we do not enable the glb [check is based on key exists or not]. There is no change in that behavior. Still if you have any concern around this , we'll address.

gahlaut-rahul avatar Jun 14 '22 23:06 gahlaut-rahul

Document the default value.

powellquiring avatar Jun 17 '22 18:06 powellquiring

Alright @powellquiring. We'll document the default value as well.

gahlaut-rahul avatar Jun 18 '22 11:06 gahlaut-rahul

@powellquiring , There is no default value mentioned in the resource schema.. I believe API is taking the default value we are not explicitly setting any default value in schema..

kavya498 avatar Sep 14 '22 06:09 kavya498

Since a default is accepted by the provider it's behavior should be documented.

powellquiring avatar Sep 23 '22 20:09 powellquiring