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

docs(scaleway_lb): clean up doc #1695

Open
Codelax opened this issue Jan 16, 2023 · 3 comments · May be fixed by #2421
Open

docs(scaleway_lb): clean up doc #1695

Codelax opened this issue Jan 16, 2023 · 3 comments · May be fixed by #2421
Assignees
Labels
documentation load-balancer Load-balancer issues, bugs and feature requests priority:high New features

Comments

@Codelax
Copy link
Member

Codelax commented Jan 16, 2023

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
@Codelax Codelax added documentation load-balancer Load-balancer issues, bugs and feature requests labels Jan 16, 2023
@yfodil yfodil self-assigned this Jan 23, 2023
@remyleone remyleone added the priority:high New features label Jan 25, 2023
@rbarrois
Copy link

rbarrois commented Sep 6, 2023

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
Copy link
Member Author

Codelax commented Sep 6, 2023

Arguments are:

  • name
  • description
  • type
  • tags
  • ip_id (marked as deprecated in API doc because it is replaced by ip_ids scaleway_lb: ip_id deprecated for 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
Copy link

rbarrois commented Sep 6, 2023

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!

@Laure-di Laure-di linked a pull request Feb 26, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation load-balancer Load-balancer issues, bugs and feature requests priority:high New features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants