Clarify actuator security documentation #30065
Closed
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
spring-projects-issues
added
the
status: waiting-for-triage
wilkinsona
requested changes
Mar 4, 2022
There was a problem hiding this comment.
Thanks for the pull request, @cmabdullah. I've left a couple of comments for your consideration.
| @@ -316,8 +316,18 @@ TIP: If you want to implement your own strategy for when endpoints are exposed, | |||
|
|
|||
| [[actuator.endpoints.security]] | |||
| === Security | |||
| For security purposes, all actuators other than `/health` are disabled by default. | |||
| You can use the configprop:management.endpoints.web.exposure.include[] property to enable the actuators. | |||
| For security purposes, all actuator's endpoints that are exposed over HTTP are secret by default except `/health` endpoint. | |||
There was a problem hiding this comment.
The goal here is to consistently use the term "expose" but this change uses "secret". I think this sentence would be better if it was something like the following:
For security purposes, only the
/healthendpoint is exposed over HTTP by default.
There was a problem hiding this comment.
Updated according to your suggestions, thanks for your concern.
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc
Outdated
Show resolved
Hide resolved
wilkinsona
pushed a commit
that referenced
this pull request
Mar 4, 2022
wilkinsona
added a commit
that referenced
this pull request
Mar 4, 2022
wilkinsona
added
type: documentation
|
@cmabdullah Thank you for making your first contribution to Spring Boot. |
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.