[release/1.15.3] Add cloud stanza documentation #17311
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
type/docs
|
|
||
| - `cloud` This object specifies settings for connecting to HCP. This was added in Consul 1.14 | ||
|
|
||
| - `client_id` The OAuth2 client ID for authentication with HCP |
There was a problem hiding this comment.
Should we note that there is an env variable for client_id that can be used instead. Same goes for secret, hostname, auth_url and scada_address.
|
|
||
| - `resource_id` The HCP resource identifier | ||
|
|
||
| - `hostname` (optional) The HCP hostname |
There was a problem hiding this comment.
Wonder if we should document hostname, auth_url and scada_address because they are only for internal use.
There was a problem hiding this comment.
I would vote for removing these as distracting. I would wait until someone asks "why aren't these documented?"
jmurret
added
backport/1.14
backport/1.15
jmurret
reviewed
May 11, 2023
jjacobson93
added
the
pr/no-changelog
This was referenced May 15, 2023
This was referenced May 15, 2023
hanshasselberg
added a commit
that referenced
this pull request
May 15, 2023
* [CC-4856] Add cloud stanza documentation * Add environment variables to cloud descriptions --------- Co-authored-by: Jeremy Jacobson <[email protected]>
hanshasselberg
added a commit
that referenced
this pull request
May 15, 2023
* [CC-4856] Add cloud stanza documentation * Add environment variables to cloud descriptions * reorder --------- Co-authored-by: Jeremy Jacobson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation for the HCP cloud stanza.
PR Checklist