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.

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

Reference documentation incorrectly uses 'disabled' rather than 'none' for access restrictions #43351

Closed
lincze opened this issue Dec 2, 2024 · 1 comment
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@lincze
Copy link

lincze commented Dec 2, 2024

i've installed spring boot 3.4.0, and tried to migrate to the new actuator configuration.

e.g. according to the docs:

management.endpoints.access.default=disabled
management.endpoint.loggers.access=read-only

(copy-pasted)

but when i use this, will get an exception:

org.springframework.beans.factory.BeanDefinitionStoreException: Failed to process import candidates for configuration class [hu.f400.lifews.api.Application]: Error processing condition on org.springframework.boot.actuate.autoconfigure.audit.AuditEventsEndpointAutoConfiguration
...
Caused by: java.lang.IllegalArgumentException: No enum constant org.springframework.boot.actuate.endpoint.Access.disabled

and indeed, at Access.java you see:

...
public enum Access {

	/**
	 * No access to the endpoint is permitted.
	 */
	NONE,

	/**
	 * Read-only access to the endpoint is permitted.
	 */
	READ_ONLY,

	/**
	 * Unrestricted access to the endpoint is permitted.
	 */
	UNRESTRICTED;
...

using these values in my config:

management.endpoints.access.default=NONE
management.endpoint.health.access=READ_ONLY
...

it just works.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Dec 2, 2024
@philwebb philwebb changed the title sprng boot 3.4.0 actuator endpoints access: docs vs code Reference documentation incorrectly uses 'disabled' rather than 'none' for access restrictions Dec 2, 2024
@philwebb
Copy link
Member

philwebb commented Dec 2, 2024

Also raised in #43302 (comment)

@philwebb philwebb added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Dec 2, 2024
@philwebb philwebb added this to the 3.4.x milestone Dec 2, 2024
@philwebb philwebb modified the milestones: 3.4.x, 3.4.1 Dec 3, 2024
@philwebb philwebb self-assigned this Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

3 participants