-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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.
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
[Docs] Update documentation with information about v1.10 licensing changes. #10336
Conversation
🤔 This PR has changes in the |
f53474f
to
8e3701b
Compare
5b7036c
to
80126e5
Compare
80126e5
to
109fbad
Compare
109fbad
to
ba9eb17
Compare
ba9eb17
to
0bc62db
Compare
0bc62db
to
a699d88
Compare
a699d88
to
354d54a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with one typo
354d54a
to
8cb094f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, really comprehensive. I added a couple minor suggestions, but they're not blockers.
…icensing that are going away. Co-authored-by: Freddy <freddygv@users.noreply.github.com>
1dd3ef4
to
ca423c8
Compare
🍒 If backport labels were added before merging, cherry-picking will start automatically. To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/379907. |
🍒✅ Cherry pick of commit 7f47603 onto |
[Docs] Update documentation with information about v1.10 licensing changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
small suggestions
@@ -12,7 +12,10 @@ Command: `consul license` | |||
|
|||
<EnterpriseAlert /> | |||
|
|||
The `license` command provides datacenter-level management of the Consul Enterprise license. This was added in Consul 1.1.0. | |||
The `license` command provides datacenter-level view of the Consul Enterprise license. This was added |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor grammar correction - should be "provides a data-center level view"
@@ -1636,6 +1636,8 @@ bind_addr = "{{ GetPrivateInterfaces | include \"network\" \"10.0.0.0/8\" | attr | |||
|
|||
- `leave_on_terminate` If enabled, when the agent receives a TERM signal, it will send a `Leave` message to the rest of the cluster and gracefully leave. The default behavior for this feature varies based on whether or not the agent is running as a client or a server (prior to Consul 0.7 the default value was unconditionally set to `false`). On agents in client-mode, this defaults to `true` and for agents in server-mode, this defaults to `false`. | |||
|
|||
- `license_path` <EnterpriseAlert inline /> This specifies the path to a file that contains the Consul Enterprise license. See the [licensing documentation](/docs/enterprise#licensing) for more information about Consul Enterprise license management. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add a sentence that either this or the env vars are required to start Consul enterprise agents after 1.10.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem here is that for client agents in some circumstances neither this nor the env is required. That is why I preferred a link out to the other licensing documentation which goes over all those details rather than duplicating them here.
So maybe I should add something like.
Alternatively, the license may also be specified by the `CONSUL_LICENSE` or `CONSUL_LICENSE_PATH` environment variables.
Its a little less strong than saying one of the 3 is required but still gives the extra information. What do you think?
This PR is a culmination of the various changes to our documentation to account for the v1.10 licensing changes to consul enterprise. The PR contains 5 commits that can be viewed independently if desired. When viewing the telemetry docs I would recommend turning off whitespace diffs because I did fixup the giant metrics table to align all the column delimiters and it makes the diff look much more extensive than it otherwise would be.