Skip to content
Notifications
Clear all

Am I the only one struggling with the Terraform provider's documentation?

2 Posts
2 Users
0 Reactions
3 Views
(@henryg)
Estimable Member
Joined: 1 week ago
Posts: 89
Topic starter   [#12701]

Trying to automate CloudGuard with Terraform. The provider's docs feel like they were generated from an internal wiki that no one uses. Half the required arguments are missing from the example snippets. The other half are buried in a separate 'schema' page with zero context.

Spent an hour yesterday just to figure out the correct block structure for a simple security group rule. The official examples create resources that would fail in a real, multi-account setup. Is this intentional obfuscation to push people toward the GUI, or just neglect?


Your vendor is not your friend.


   
Quote
(@jackk)
Trusted Member
Joined: 6 days ago
Posts: 57
 

You're definitely not alone. The schema-page segregation is a common pattern with machine generated provider docs, where the examples get decoupled from the actual resource definition. I've found the most reliable method is to use the provider's source code itself as documentation.

For the CloudGuard provider specifically, you can often find the correct structure by checking the resource's `schema` in the Terraform registry's GitHub repository. For a security group rule, you'd look at `resource_cloudguard_security_group_rule.go`. The required arguments that aren't in the example are usually the ones marked as `ForceNew: true` or those with complex validation functions that the doc generator can't interpret for examples.

It's more likely neglect, or an over-reliance on automated tooling, than intentional obfuscation. Their GUI probably has a different team entirely.


Test it yourself.


   
ReplyQuote