Skip to content

[improve][doc] Improve the authentication enablement workflow across multiple providers #18035

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.

Sign up for GitHub

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

Jump to bottom
Merged
momo-jun merged 7 commits into from
Oct 27, 2022
Merged

[improve][doc] Improve the authentication enablement workflow across multiple providers #18035

momo-jun merged 7 commits into from
Oct 27, 2022

Conversation

@momo-jun
Copy link
Contributor

@momo-jun momo-jun commented Oct 13, 2022 •
edited
Loading

Motivation

Improve the doc set of the Security chapter to provide Pulsar users with an easy-to-use and easy-to-understand information experience.

This PR attempts to align the workflow to enable Athenz/JWT/OAuth2/Keberos authentication with TLS/Basic Auth. Currently, the described workflow lacks clear logic and seems to be very different with each other. Outdated information will be refreshed as well.

Previously related work: #17615, #17666 and #17808.

Modifications

  1. Add How it works in Pulsar for authentication.
  2. Align the workflow to enable authentication across multiple providers.
    • Athenz
    • JWT
    • OAuth2
    • Kerberos
  3. Add code snippets to show the supportability of clients.

Many thanks to @nodece for providing technical inputs.

Preview

Overview
image

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Oct 13, 2022
nodece
nodece reviewed Oct 17, 2022
View reviewed changes
@momo-jun momo-jun self-assigned this Oct 18, 2022
@momo-jun momo-jun requested a review from nodece October 18, 2022 08:19
@momo-jun momo-jun marked this pull request as ready for review October 18, 2022 08:19
@momo-jun
Copy link
Contributor Author

momo-jun commented Oct 18, 2022

@nodece @futeng can you pls review these improvements from a tech perspective?

@momo-jun momo-jun changed the title [Improve][doc] Improve the authentication enablement workflow across multiple providers [improve][doc] Improve the authentication enablement workflow across multiple providers Oct 19, 2022
@momo-jun momo-jun requested a review from RobertIndie October 19, 2022 01:26
RobertIndie
RobertIndie reviewed Oct 19, 2022
View reviewed changes
@momo-jun momo-jun requested a review from Anonymitaet October 20, 2022 07:16
@momo-jun momo-jun mentioned this pull request Oct 21, 2022
Closed
3 tasks
@sijie sijie mentioned this pull request Oct 21, 2022
Open
2 tasks
@momo-jun momo-jun merged commit a48bc8b into apache:master Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@RobertIndie RobertIndie RobertIndie left review comments

@nodece nodece nodece approved these changes

@Anonymitaet Anonymitaet Anonymitaet approved these changes

Assignees

@momo-jun momo-jun

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@momo-jun @nodece @RobertIndie @Anonymitaet