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

Clarify actuator security documentation #30065

Closed
wants to merge 3 commits into from
Closed

Clarify actuator security documentation #30065

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fdbfb5
Clarify actuator security documentation
cmabdullah Mar 3, 2022
25a12a9
Clarify actuator security documentation
cmabdullah Mar 4, 2022
0028138
Clarify actuator security documentation, 2. Resolved feedbacks
cmabdullah Mar 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 12 additions & 2 deletions spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

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

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 /health endpoint is exposed over HTTP by default.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated according to your suggestions, thanks for your concern.

You can use the configprop:management.endpoints.web.exposure.include[] property to expose the actuator's endpoint.

The following configuration expose `/info` and `/metrics` endpoint from the example.com domain:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
----
management:
endpoints:
web:
exposure:
include: ["info", "metrics"]
----
cmabdullah marked this conversation as resolved.
Show resolved Hide resolved

NOTE: Before setting the `management.endpoints.web.exposure.include`, ensure that the exposed actuators do not contain sensitive information, are secured by placing them behind a firewall, or are secured by something like Spring Security.

Expand Down