Doc updates #102
Doc updates #102
Conversation
| @@ -20,6 +20,8 @@ data "hcp_aws_transit_gateway_attachment" "test" { | |||
| } | |||
| ``` | |||
|
|
|||
| ~> **Security Notice** This resource contains sensitive input. Please see this [list of recommendations](https://www.terraform.io/docs/language/state/sensitive-data.html) for storing sensitive information in Terraform. | |||
|
|
|||
There was a problem hiding this comment.
I don't believe the data source actually contains any sensitive inputs, so this message might be confusing
There was a problem hiding this comment.
Oops you're right, thought the ARN might be an output
| @@ -9,12 +9,18 @@ description: |- | |||
|
|
|||
| The HCP provider provides resources to manage [HashiCorp Cloud Platform](https://cloud.hashicorp.com/) (HCP) resources. | |||
|
|
|||
| ~> **Known Issue** There is an issue with v0.4.0 of the HCP Provider in which existing Consul clusters that do not specify size will be force-recreated on the next Apply. Please upgrade to the patch v0.4.1 to avoid this issue. | |||
|
|
|||
There was a problem hiding this comment.
I think I understand the intent of this message, but from the user's perspective it may be a little weird. What we will end up with is a v0.4.2 when this gets released, which will mention that the user should use v0.4.1, because v0.4.0 has an issue. But then when the user selects v0.4.0 or v0.4.1 from the version selector, they will not see any messages related to known issues. I'm wondering if we will instead need to rely on a more generic message if we really need something like this, eg. Please refer our [CHANGELOG]() for critical fixes
There was a problem hiding this comment.
I like the idea of adding the generic message, I can do that. @xargs-P wants to keep the specific 0.4.0 warning in for 30 days, then we'll remove it. We're adding the same 30-day warning to the CLI (which will show up when the provider initializes). We want to be extra noisy about that issue, since it could result in data loss.
docs/index.md
Outdated
| ## Authenticating with HCP | ||
|
|
||
| The HCP provider supports authentication via a Client ID and a Client Secret. The [authentication guide](guides/auth.md) describes how to obtain client credentials. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| Most HCP resources have a dependency on the Hashicorp Virtual Network (HVN) resource. |
There was a problem hiding this comment.
Nit: IMO this is so fundamental to Terraform usage that it would be extraneous information for the average user (I'm not aware of any other providers that include a note like this), and for Terraform beginners, we probably need to be directing them to more comprehensive guides to be brought up to speed
|
|
||
| {{ .Description | trimspace }} | ||
|
|
||
| The cluster root token resource is the token used to bootstrap the cluster's ACL system. Using this resource to create a new root token for a cluster will invalidate the consul root token accessor id and Consul root token secret id properties of the cluster. |
There was a problem hiding this comment.
This line seems like a duplicate of the Description above?
|
|
||
| ## Example Usage | ||
|
|
||
| {{ tffile "examples/resources/hcp_vault_cluster_admin_token/resource.tf" }} |
There was a problem hiding this comment.
I think this one needs to be hcp_consul_cluster_root_token instead of hcp_vault_cluster_admin_token
🛠️ Description
This PR updates the warning messages on resources with sensitive input/output. It also adds a warning about the bug released in v0.4.0 and patched in v0.4.1.