[Doc] ACL documentation is missing required 5.x configuration properties
- Dominant language
- Java
- Stars
- 22.6k
- Forks
- 12k
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 27
Description
### Search before creation
- [x] I had searched in the [issues](https://github.com/apache/rocketmq/issues) and found no similar issues.
### Documentation Related
The ACL documentation (both English and Chinese) only mentions
`aclEnable=true` as the required broker configuration. However, in
RocketMQ 5.x, the following additional properties are required:
- authenticationEnabled=true
- authorizationEnabled=true
- migrateAuthFromV1Enabled=true
- authenticationMetadataProvider=org.apache.rocketmq.auth.authentication.provider.LocalAuthenticationMetadataProvider
- authorizationMetadataProvider=org.apache.rocketmq.auth.authorization.provider.LocalAuthorizationMetadataProvider
Evidence from source code:
- AbstractAuthenticationStrategy.java:54 — returns immediately if
authenticationEnabled is false
- AbstractAuthorizationStrategy.java:54 — same for authorizationEnabled
- AuthMigrator.java:72 — plain_acl.yml is not loaded without
migrateAuthFromV1Enabled
- AuthenticationFactory.java:80-81 — returns null if
authenticationMetadataProvider is blank, causing
"authenticationMetadataProvider is not configured" error
Without these properties, ACL either silently allows all traffic or
throws configuration errors.
### Are you willing to submit PR?
- [x] Yes I am willing to submit a PR!
Contributor guide
Research direction
Start by locating the English and Chinese ACL documentation, then compare their configuration guidance with AbstractAuthenticationStrategy.java, AbstractAuthorizationStrategy.java, AuthMigrator.java, and AuthenticationFactory.java at the cited lines. Update both documents to include the required 5.x properties and confirm that the documented configuration covers authentication, authorization, migration, and metadata providers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- authentication, authorization, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 70/100