Documentation - hcp_consul_cluster

[kalenarndt]

Terraform Version and Provider Version

Terraform version: 1.1.9
HCP provider version: 0.24.1

Affected Resource(s)

• hcp_consul_cluster

Problem Statement

When attempting to configure a Consul Agent I started digging through Terraform to see if we were able to get the same configuration bundle that we publish in the portal.

In the portal it is labeled as a Client Configuration File

If we look at the provider documentation we have 2 entries 1 for consul_config_file and consul_ca_file which are object sunder the resource/datasource

These files are what are in this Client Configuration File but are labeled as cluster config file. This is confusing since at a first glance it doesn't appear that those can be used on clients and are the configurations for the consul servers.

Suggestion

Add additional detail in the provider documentation that aligns the naming closer to the HCP portal or has a note that indicates that these are to be used on clients within the consul cluster.

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

[bcmdarroch]

Thanks for contributing this issue! The Consul team will be scheduling time to update the docs.