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

[feat][doc] add configurations for broker load balancing #661

Merged
merged 1 commit into from
Aug 7, 2023

Conversation

Anonymitaet
Copy link
Member

What change does this PR introduce?

This PR adds configurations for broker load balancing (topics in the red box below)

image

Doc development plan - Read before review

For the current doc of Broker Load Balancer, we want to tackle the following challenges:

  • Create new documentation to cover all aspects of the feature (especially for the new extensible load balancer).
  • Fill in any content gaps that may exist.
  • Consolidate existing documentation into the new IA, as it is currently scattered and disorganized.
  • Organize the documentation in a cohesive manner, ensuring it flows logically.

Consequently, we’ve created the following content development plans:

Ackowledgements

@Demogorgon314 thanks for your technical guidance and great support!

@Anonymitaet Anonymitaet added this to the 3.1.0 milestone Aug 2, 2023
@Anonymitaet Anonymitaet self-assigned this Aug 2, 2023
@github-actions github-actions bot added the doc Improvements or additions to documentation label Aug 2, 2023
@@ -32,3 +32,72 @@ You can set specific configurations through Java properties.
| **Property** | **Description** |
| ------------------ | ------------------------------------------------------------ |
| pulsar.enableUring | Use `io_uring` instead of `epoll` as network IO mode. `-Dpulsar.enableUring=1` means this feature is enabled. |

## Broker load balancing configurations
Copy link
Member Author

Choose a reason for hiding this comment

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

For reviewers:

The detailed descriptions of broker load balancing configurations are shown at https://pulsar.apache.org/reference/#/next/config/reference-configuration-broker. This page is generated from code files automatically. All configurations including those related to broker load balancing are listed on that page without appropriate sorting.

To give users a clear and quick understanding of broker load balancing configurations, I've added this brief summary.

@Anonymitaet
Copy link
Member Author

@Demogorgon314 @heesung-sn @D-2-Ed @momo-jun @Huanli-Meng could you please help review this PR?
Thank you all!

Copy link
Contributor

@momo-jun momo-jun left a comment

Choose a reason for hiding this comment

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

LGTM

- loadBalancerDirectMemoryResourceWeight
- loadBalancerHistoryResourcePercentage

### TopK bundle load data
Copy link
Member

Choose a reason for hiding this comment

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

I think this title is Bundle load data

@heesung-sn
Copy link
Contributor

heesung-sn commented Aug 4, 2023

I think we can move these configs when we explain each component's operation.

@Anonymitaet
Copy link
Member Author

I think we can move these configs when we explain each component's operation.

@heesung-sn I'll add the link of this conf page to https://pulsar.apache.org/docs/next/concepts-broker-load-balancing-types/

@Anonymitaet Anonymitaet merged commit 9d09f5e into apache:main Aug 7, 2023
3 checks passed
@Technoboy- Technoboy- mentioned this pull request Aug 9, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants