Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[release/1.15.3] Add cloud stanza documentation #17311

Merged
merged 3 commits into from
May 15, 2023
Merged

[release/1.15.3] Add cloud stanza documentation #17311

merged 3 commits into from
May 15, 2023

Conversation

jjacobson93
Copy link
Contributor

Description

This PR adds documentation for the HCP cloud stanza.

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@jjacobson93 jjacobson93 requested a review from a team as a code owner May 11, 2023 18:42
@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label May 11, 2023
hanshasselberg
hanshasselberg reviewed May 11, 2023
View reviewed changes
Copy link
Member

@hanshasselberg hanshasselberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left two comments.

website/content/docs/agent/config/config-files.mdx Outdated

- `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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

website/content/docs/agent/config/config-files.mdx Outdated

- `resource_id` The HCP resource identifier

- `hostname` (optional) The HCP hostname
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonder if we should document hostname, auth_url and scada_address because they are only for internal use.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would vote for removing these as distracting. I would wait until someone asks "why aren't these documented?"

@jmurret jmurret added backport/1.14 backport/1.15 This release series is no longer active on CE. Use backport/ent/1.15. labels May 11, 2023
jmurret
jmurret reviewed May 11, 2023
View reviewed changes
Copy link
Member

@jmurret jmurret left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we clarify the title and description of this section that this is for connecting HCP Consul self-managed clusters (and possibly a sentence about it) vs "HCP"?

hanshasselberg
hanshasselberg approved these changes May 12, 2023
View reviewed changes
Copy link
Member

@hanshasselberg hanshasselberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jjacobson93 jjacobson93 added the pr/no-changelog PR does not need a corresponding .changelog entry label May 12, 2023
@hanshasselberg hanshasselberg merged commit f334fcc into main May 15, 2023
@hanshasselberg hanshasselberg deleted the jer/cloud-docs branch May 15, 2023 10:52
This was referenced May 15, 2023
Closed
Closed
This was referenced May 15, 2023
Merged
Merged
hanshasselberg added a commit that referenced this pull request May 15, 2023
@hanshasselberg @jjacobson93
Manual backport 1.14.x of #17311 (#17355)
64c2aa7 
* [CC-4856] Add cloud stanza documentation

* Add environment variables to cloud descriptions

---------

Co-authored-by: Jeremy Jacobson <jeremy.jacobson@hashicorp.com>
hanshasselberg added a commit that referenced this pull request May 15, 2023
@hanshasselberg @jjacobson93
Manual backport 1.15.x of #17311 (#17356)
3967e33 
* [CC-4856] Add cloud stanza documentation

* Add environment variables to cloud descriptions

* reorder

---------

Co-authored-by: Jeremy Jacobson <jeremy.jacobson@hashicorp.com>
@jjti jjti mentioned this pull request Aug 28, 2023
Closed
@dlaguerta dlaguerta mentioned this pull request Dec 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmurret jmurret jmurret left review comments

@hanshasselberg hanshasselberg hanshasselberg approved these changes

Assignees
No one assigned
Labels
backport/1.15 This release series is no longer active on CE. Use backport/ent/1.15. pr/no-changelog PR does not need a corresponding .changelog entry type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jjacobson93 @hanshasselberg @jmurret