[docs] Complete ZooKeeper client configuration documentation

Open Beginner friendly
#4,336 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
92/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
java
Domain
documentation

Research direction

Start with website/docs/maintenance/configuration.md and compare its ZooKeeper table with the 11 zookeeper.* options in fluss-common/src/main/java/org/apache/fluss/config/ConfigOptions.java. Add the missing zookeeper.client.max-buffer-size entry with its type, default, units, and client/server limit explanation, then correct max-inflight-requests to Integer with default 100. Done means all 11 options are accurately represented.

Written by the indexing model from the issue text.

Description

Search before asking
  • I searched in the issues and found nothing similar.
Description

Follow-up to #4335.

The ZooKeeper configuration reference omits zookeeper.client.max-buffer-size, which is already defined in ConfigOptions.

Update website/docs/maintenance/configuration.md to:

  • Document zookeeper.client.max-buffer-size: Integer, default 104857600 (100 MiB), measured in bytes. Explain that it sets the ZooKeeper client's jute.maxbuffer; the ZooKeeper server limit is configured separately.
  • Correct the type of zookeeper.client.max-inflight-requests from String to Integer (default 100).

Comparing the current reference with ConfigOptions found 11 zookeeper.* options in code and 10 in the table; zookeeper.client.max-buffer-size is the only missing option.

Willingness to contribute
  • I'm willing to submit a PR!
Dominant language
Java
Stars
2.2k
Forks
628
Avg merge
1d 19h
Merged PRs (30d)
138

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/fluss

All issues in apache/fluss

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.