Skip to content

[feature][doc] Add docs for system topic and update for topic policy #14795

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
Anonymitaet merged 7 commits into from
Jun 9, 2022
Merged

[feature][doc] Add docs for system topic and update for topic policy #14795

Anonymitaet merged 7 commits into from
Jun 9, 2022

Conversation

@momo-jun
Copy link
Contributor

@momo-jun momo-jun commented Mar 22, 2022 •
edited
Loading

Add docs for #15619 and also fix issue #13856.

Modifications

  1. Add docs for system topic.
  2. Improve topic-level policies section: add notes for required configs and add an illustration.

The preview looks good, and pls note that there is a slight difference between the latest (master) and earlier versions.

Latest
Since 2.11, system topic defaults to enabled and support listings with a new flag.
image
image
image

2.10 and earlier versions

  1. Add a note for manual configs to enable system topic.

image

2. The note has slight difference with that of master.

image

Documentation

  • doc

@momo-jun
Copy link
Contributor Author

momo-jun commented Mar 22, 2022

Hi @RobertIndie @codelipenghui @MarvinCai @Anonymitaet can you pls review this doc PR? Thanks.

@github-actions
Copy link

github-actions bot commented Mar 22, 2022

@momo-jun:Thanks for your contribution. For this PR, do we need to update docs?
(The PR template contains info about doc, which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)

@github-actions
Copy link

github-actions bot commented Mar 22, 2022

@momo-jun:Thanks for providing doc info!

@github-actions github-actions bot added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. and removed doc-label-missing labels Mar 22, 2022
Anonymitaet
Anonymitaet reviewed Mar 23, 2022
View reviewed changes
Copy link
Member

@Anonymitaet Anonymitaet left a comment

Choose a reason for hiding this comment

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

Is it better to reverse the arrow?
image

Why broker1 does not have steps 1,2,5?

@momo-jun
Copy link
Contributor Author

momo-jun commented Mar 23, 2022

Is it better to reverse the arrow? image

Why broker1 does not have steps 1,2,5?

  1. This is an emphasis that brokers subscribe to the system topic proactively to receive change events.
  2. Only broker0 gets the request from pulsar-admin to implement the change, but the change applies to all brokers in a single namespace.

codelipenghui
codelipenghui reviewed Apr 18, 2022
View reviewed changes
Copy link
Contributor

@codelipenghui codelipenghui left a comment

Choose a reason for hiding this comment

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

I think we'd better add a new page/section for pulsar system topics, system topics are just a topic name internally in Pulsar, __change_events is one of them.

  1. What is the system topic in Pulsar
  2. Why are we using system topic
  3. How many system topics that Pulsar have
  4. How to enable system topic
  5. System topic limitations

@momo-jun
Copy link
Contributor Author

momo-jun commented Apr 18, 2022

I think we'd better add a new page/section for pulsar system topics, system topics are just a topic name internally in Pulsar, __change_events is one of them.

  1. What is the system topic in Pulsar
  2. Why are we using system topic
  3. How many system topics that Pulsar have
  4. How to enable system topic
  5. System topic limitations

@codelipenghui Makes sense. Who can provide the draft?

@github-actions
Copy link

github-actions bot commented May 19, 2022

The pr had no activity for 30 days, mark with Stale label.

@momo-jun
Copy link
Contributor Author

momo-jun commented May 19, 2022

I think we'd better add a new page/section for pulsar system topics, system topics are just a topic name internally in Pulsar, __change_events is one of them.

  1. What is the system topic in Pulsar
  2. Why are we using system topic
  3. How many system topics that Pulsar have
  4. How to enable system topic
  5. System topic limitations

@codelipenghui Makes sense. Who can provide the draft?

@Technoboy- will provide more inputs soon.

@momo-jun momo-jun changed the title [improve][doc] Add doc for system topic and topic policy [feature][doc] Add docs for system topic and update for topic policy Jun 9, 2022
@momo-jun
Copy link
Contributor Author

momo-jun commented Jun 9, 2022

Ping @Technoboy- @mattisonchao for review.

@Technoboy- Technoboy- added this to the 2.11.0 milestone Jun 9, 2022
@momo-jun
Copy link
Contributor Author

momo-jun commented Jun 9, 2022

Ping @Anonymitaet for review.

@Anonymitaet Anonymitaet merged commit 8f40dc9 into apache:master Jun 9, 2022
michaeljmarshall
michaeljmarshall reviewed Jun 9, 2022
View reviewed changes
site2/docs/concepts-messaging.md
| Namespace | TopicName | Domain | Count | Usage |
|-----------|-----------|--------|-------|-------|
| pulsar/system | `transaction_coordinator_assign_${id}` | Persistent | Default 16 | Transaction coordinator |
| pulsar/system | `_transaction_log${tc_id}` | Persistent | Default 16 | Transaction log |
Copy link
Member

@michaeljmarshall michaeljmarshall Jun 9, 2022

Choose a reason for hiding this comment

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

This should have been __transaction_log_.

Copy link
Contributor

@Technoboy- Technoboy- Jun 10, 2022

Choose a reason for hiding this comment

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

yes, right.

Copy link
Contributor Author

@momo-jun momo-jun Jun 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I will update it to __transaction_log_${tc_id} in a follow-up PR. Thank you both.

Copy link
Member

@michaeljmarshall michaeljmarshall Jun 10, 2022

Choose a reason for hiding this comment

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

Thank you for updating it and for adding the documentation!

@momo-jun momo-jun mentioned this pull request Jun 14, 2022
Merged
1 task
@momo-jun momo-jun mentioned this pull request Aug 17, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Technoboy- Technoboy- Technoboy- approved these changes

@codelipenghui codelipenghui codelipenghui left review comments

@michaeljmarshall michaeljmarshall michaeljmarshall left review comments

@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

2.11.0

Development

Successfully merging this pull request may close these issues.

5 participants

@momo-jun @Technoboy- @codelipenghui @michaeljmarshall @Anonymitaet