doc/metrics: mention that metrics authentication can be disabled #12021
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
… recommended) Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
tomponline
reviewed
Jul 17, 2023
| @@ -95,6 +95,13 @@ Then add this certificate to the list of trusted clients, specifying the type as | |||
|
|
|||
| lxc config trust add metrics.crt --type=metrics | |||
|
|
|||
| If requiring TLS client authentication isn't possible in your environment, the `/1.0/metrics` API endpoint can be made available to unauthenticated clients. While not recommended, this might be acceptable if you have other controls in place to restrict who can reach that API endpoint. To disable the authentication on the metrics API: | |||
There was a problem hiding this comment.
Can you add a line break before the word "While".
This won't result in any change of generated output in the docs itself, but makes review easier.
There was a problem hiding this comment.
@ru-fu would you say that we should add a line break after each full stop?
There was a problem hiding this comment.
Yes, I always do it and I think it's very helpful.
There's no requirement for that, but as you're saying, it makes reviewing a lot easier. When we're updating the docs, changes are usually on a sentence level, so this gives a much nicer diff than having random line breaks at 80 characters.
|
Merging for now @simondeziel im sure will fix the newlines when he gets back. |
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.
No description provided.