docs(scaleway_lb): clean up doc

[Codelax]

trafficstars

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

Terraform Version

v2.9.0

Affected Resource(s)

• scaleway_lb

About

The terraform documentation of the scaleway_lb resource contains multiple Attributes Reference categories. The second one contains arguments reference, this documentation should be cleared up.

References

• #0000

[rbarrois]

Until the documentation is fixed, can you provide at least in this issue a clarification as to which arguments are actually supported?

• There are currently two "Attributes" section
• The set of HCL examples use an invalid syntax
• Many HCL examples use undocumented arguments, especially around private networks
• The documentation refers to ip_id, yet that item is marked as "deprecated" in the API docs

As is, the scaleway_lb resource's documentation is unusable — hence, we can't use the product.

[Codelax]

Arguments are:

• name
• description
• type
• tags
• ip_id (marked as deprecated in API doc because it is replaced by ip_ids #2123 )
• private_network
  • private_network_id
  • static_config
  • dhcp_config
• ssl_compatibility_level
• zone
• project_id

Exported attributes are:

• ip_address
• private_network
  • status
  • zone
• region

The documentation is somewhat complete but confusing. The second "Attributes Reference" at the bottom refers to the arguments contained in private_network object

For the invalid syntax it seems I miss it as examples seem right for me.

[rbarrois]

Thanks for the quick feedback! The syntax looks correct indeed, I was surprised to see unquoted components in resource scaleway_lb lb { — most example I saw before used resource "resource_type" "resource_name" { with quotes!