Updated documentation
This commit is contained in:
parent
c7eee62b7b
commit
369c810072
|
@ -43,7 +43,7 @@ func genericSecretResource() *schema.Resource {
|
|||
Type: schema.TypeBool,
|
||||
Optional: true,
|
||||
Default: false,
|
||||
Description: "True if the provided token is allowed to read the secret from vault, and therefore canupdate values",
|
||||
Description: "True if the provided token is allowed to read the secret from vault",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
@ -134,16 +134,6 @@ func genericSecretResourceRead(d *schema.ResourceData, meta interface{}) error {
|
|||
}
|
||||
|
||||
d.SetId(path)
|
||||
log.Printf("[WARN] vault_generic_secret does not automatically refresh if allow_read is set to false")
|
||||
return nil
|
||||
|
||||
// We don't actually attempt to read back the secret data
|
||||
// here, so that Terraform can be configured with a token
|
||||
// that has only write access to the relevant part of the
|
||||
// store.
|
||||
//
|
||||
// This means that Terraform cannot detect drift for
|
||||
// generic secrets, but detecting drift seems less important
|
||||
// than being able to limit the effect of exposure of
|
||||
// Terraform's Vault token.
|
||||
// log.Printf("[WARN] vault_generic_secret does not automatically refresh")
|
||||
}
|
||||
|
|
|
@ -31,6 +31,7 @@ var testResourceGenericSecret_initialConfig = `
|
|||
|
||||
resource "vault_generic_secret" "test" {
|
||||
path = "secret/foo"
|
||||
allow_read = true
|
||||
data_json = <<EOT
|
||||
{
|
||||
"zip": "zap"
|
||||
|
@ -77,6 +78,7 @@ var testResourceGenericSecret_updateConfig = `
|
|||
|
||||
resource "vault_generic_secret" "test" {
|
||||
path = "secret/foo"
|
||||
allow_read = true
|
||||
data_json = <<EOT
|
||||
{
|
||||
"zip": "zoop"
|
||||
|
|
|
@ -51,6 +51,10 @@ see which endpoints support the `PUT` and `DELETE` methods.
|
|||
* `data_json` - (Required) String containing a JSON-encoded object that
|
||||
will be written as the secret data at the given path.
|
||||
|
||||
* `allow_read` - (Optional) True/false. Set this to true if your vault
|
||||
authentication is able to read the data, this allows the resource to be
|
||||
compared and updated. Defaults to false.
|
||||
|
||||
## Required Vault Capabilities
|
||||
|
||||
Use of this resource requires the `create` or `update` capability
|
||||
|
@ -59,10 +63,11 @@ along with the `delete` capbility if the resource is removed from
|
|||
configuration.
|
||||
|
||||
This resource does not *read* the secret data back from Terraform
|
||||
on refresh. This avoids the need for `read` access on the given
|
||||
on refresh by default. This avoids the need for `read` access on the given
|
||||
path, but it means that Terraform is not able to detect and repair
|
||||
"drift" on this resource should the data be updated or deleted outside
|
||||
of Terraform.
|
||||
of Terraform. This limitation can be negated by setting `allow_read` to
|
||||
true
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
|
|
Loading…
Reference in New Issue