Document how to connect to a publicly accessible HCP Consul instance better.

[techdragon]

Terraform Version

Terraform v1.2.6
on darwin_amd64
+ provider registry.terraform.io/hashicorp/consul v2.15.1
+ provider registry.terraform.io/hashicorp/hcp v0.37.0

Affected Resource(s)

Multiple

Terraform Configuration Files

NA

Debug Output

NA

Panic Output

NA

Expected Behavior

Terraform should be able to manage the configured Consul when setup following the documentation and provided config values.

Actual Behavior

Lots of errors

Steps to Reproduce

Please list the steps required to reproduce the issue, for example:

1. terraform HCP hosted Consul
2. set the new HCP Consul instance as publicly accessible
3. use the copied admin token and copied public address to connect the provider as documented.
4. try to create things

Important Factoids

The outcomes of various possible configurations of address and schema including the only two combinations that work for publicly accessible HCP Consul instances seems to be as follows.

• With port at the end of the address (which is how the value is copied from the HCP web UI):
  • schema must be set to "http" in order for it to work.
  • Setting schema to "https" will produce http: server gave HTTP response to HTTPS client errors for each resource it attempts to investigate.
  • Omitting a value for schema (which marking it as optional implies you can do) will produce various errors such as Unexpected response code: 404 () trying to create a new consul_key resource, and Unexpected response code: 405 (method GET not allowed) trying to create a new consul_acl_policy resource, trying to modify a resource will "succeed" but the write doesn't actually happen if you go and check the web console. (This probably warrants a separate bug report for the false positive Modification complete response.)
• With no port at the end of the address:
  • schema must be set to "https" in order for it to work.
  • Setting schema to "http" or omitting a value for schema (which marking it as optional implies you can do) will produce various errors such as Unexpected response code: 404 () trying to create a new consul_key resource, and Unexpected response code: 405 (method GET not allowed) trying to create a new consul_acl_policy resource, trying to modify a resource will "succeed" but the write doesn't actually happen if you go and check the web console. (This probably warrants a separate bug report for the false positive Modification complete response.)

In summary, if you're using the public address endpoint of a HCP Consul instance, then schema is required, and the specifics of removing the port from the end of the address to get HTTPS support should be documented.

References

NA

[remilapeyre]

Hello @techdragon, I have been unable to reproduce this issue. Can you please give an example that does not work?

Are you sure you had no environment variable set when you were doing the tests?