Compare commits

...
Author SHA1 Message Date
ToddandJeff Mitchell 442d2f3640 Apply suggestions from code review
Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
2021-11-18 09:56:53 -07:00
Todd Knight 3abeb75ca5 Update Readme with details around credential rotation needing to be disabled. 2021-11-18 08:57:54 -07:00
+12 -14
View File
@@ -19,24 +19,22 @@ Current limitations of this plugin:
compute resource compute resource
- A client secret must be generated against a registered application with any - A client secret must be generated against a registered application with any
necessary permissions necessary permissions
- For now, credential rotation must be disabled using the `disable_credential_rotation`
attribute. There is some additional work that the Boundary team identified
that is necessary to make this a seamless experience.
## Credential Rotation ## Credential Rotation
Although credentials are stored encrypted within Boundary, by default this *NOTE*: For now credential rotation must be explicitly disabled by setting
plugin will attempt to rotate credentials when they are supplied through the `disable_credential_rotation` to true on the host catalog. When we lift this
`secrets` object on a create or update call to the host catalog resource. The restriction Boundary will manage the rotation of credentials for you.
given credentials will be used to create a new credential, and then the given
credential will be revoked. In this way, after rotation, only Boundary knows the
client secret in use by this plugin.
*NOTE*: Azure's credentials are eventually consistent and there may be Although credentials are stored encrypted within Boundary, when credential
significant delay (up to ten minutes or more) between when a credential is rotation isn't explicitly disabled, this plugin will attempt to rotate
created and is available for use, or when a credential is deleted and credentials when they are supplied through the `secrets` object on a create or
unavailable for use. At the API level, this can be true even if the Azure Portal update call to the host catalog resource. The given credentials will be used to
indicates that the credential is (or isn't) there. This delay will manifest as create a new credential, and then the given credential will be revoked. In this
authentication failures when performing actions using this plugin. If secrets way, after rotation, only Boundary knows the client secret in use by this plugin.
have just been supplied and `disable_credential_rotation` is not specified,
please be patient and try again later.
## Attributes and Secrets ## Attributes and Secrets