apache / apache/pinot

Inconsistent BasicAuth token configuration naming across Controller, Server, and Minion (documentation issue)

Open
#17,506 3 comments 0 reactions 0 assignees View on GitHub
configuration security user-experience
Dominant language
Java
Stars
6.1k
Forks
1.5k
Avg merge
2d 55m
Merged PRs (30d)
182

Description

While setting up Basic Authentication across all Pinot components, I found that the naming convention for BasicAuth token configuration keys is inconsistent, confusing, and in some cases incorrect. The docs present several different patterns for the same purpose.

Here are concrete examples from the official documentation and examples:

Controller uses:

controller.segment.fetcher.auth.token=Basic

Minion uses (no component prefix):

segment.fetcher.auth.token=Basic
task.auth.token=Basic

Server uses a different prefix (pinot.server):

pinot.server.segment.fetcher.auth.token=Basic

Contributor guide

Open the contributing guide

Research direction

Review the BasicAuth configuration documentation and examples for Controller, Server, and Minion, focusing on the token keys listed in the issue. Trace each component's documented naming pattern and update the affected examples so equivalent settings use a consistent, correct convention; done means the three component sections no longer conflict.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.