Skip to content
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.

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

[improve][doc] Improve TLS encryption #17808

Merged
merged 7 commits into from
Sep 30, 2022
Merged

Conversation

momo-jun
Copy link
Contributor

@momo-jun momo-jun commented Sep 23, 2022

Motivation

Improve the doc set of the Security chapter to provide Pulsar users with a more accurate, easy-to-understand, and comprehensive information experience.

This is a follow-up PR related to #17615 and #17666.

Modifications

  1. Improve the IA and task flow of TLS encryption to provide a clear map.
  2. Refresh the content through a thorough review done by @nodece
  3. Move the content from the encryption cookbook to the get started section of end-to-end encryption

Preview

image

image

Documentation

  • doc

@momo-jun momo-jun changed the title [improve][doc]improve TLS encryption [improve][doc] Improve TLS encryption Sep 23, 2022
@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 Sep 23, 2022
@momo-jun momo-jun self-assigned this Sep 23, 2022
@momo-jun momo-jun marked this pull request as ready for review September 27, 2022 02:36
@momo-jun
Copy link
Contributor Author

@nodece can you pls review the two screenshots I attached in the PR? The content has addressed the points we covered in the discussion.

site2/docs/security-encryption.md Outdated Show resolved Hide resolved

It is important to restrict access to the store files via filesystem permissions.
Optional settings:
1. `tlsRequireTrustedClientCertOnConnect=true`: Enable TLS authentication on both brokers and clients for mutual TLS. When enabled, it authenticates the other end of the communication channel.
Copy link
Member

@nodece nodece Sep 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a new section to introduce this, it is important.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nodece can you pls take another look?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants