apache/pulsar

broker.conf documentation : wrong tokenSecretKey base64 inline description

Open

#10,584 opened on May 14, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (3,485 forks)batch import
help wantedtype/bug

Repository metrics

Stars
 (13,697 stars)
PR merge metrics
 (Avg merge 3d 10h) (146 merged PRs in 30d)

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

Research direction
Determine the correct inline format for tokenSecretKey in broker.conf and update the documentation accordingly.
Tech stack
java
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80