apache / apache/pulsar

broker.conf documentation : wrong tokenSecretKey base64 inline description

Open
#10,584 2 comments 0 reactions 0 assignees View on GitHub
help wanted type/bug
Dominant language
Java
Stars
15.3k
Forks
3.8k
Avg merge
1d 22h
Merged PRs (30d)
142

Description

On the website the documentation to pass a token in base64 mention to use
`tokenSecretKey=data:;base64,******`

However I could not have it working using (without the semicolon)
`tokenSecretKey=data:base64,******`

I am using the broker version 2.6.3

Context (not sure important) :
- On openjdk 11.0.10
- I also use two authentication mechanisms
`authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderTls,org.apache.pulsar.broker.authentication.AuthenticationProviderToken`

This has been discussed here https://github.com/apache/pulsar/issues/6761 but led to the opposite observation.

Contributor guide

Open the contributing guide

Research direction

Start with the website's broker.conf documentation for tokenSecretKey and compare its inline base64 example with the behavior reported for broker version 2.6.3. Read issue #6761 for the conflicting observation and verify which syntax is supported; done means the documentation shows the correct form and explains any relevant context.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
authentication, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.