Skip to content

[docs] Add Production Readiness Checklist - #4349

Open
hanliu0830 wants to merge 1 commit into
apache:mainfrom
hanliu0830:codex/docs-production-readiness-4338
Open

hanliu0830 wants to merge 1 commit into
apache:mainfrom
hanliu0830:codex/docs-production-readiness-4338

Conversation

@hanliu0830

Copy link
Copy Markdown
Contributor

Purpose

Linked issue: close #4338

Add a Production Readiness Checklist under Maintenance > Operations, starting with ZooKeeper. This gives Fluss users deployment guidance and explains the server-side buffer setting needed to match Fluss's default ZooKeeper client limit.

Brief change log

  • Document ZooKeeper version, ensemble sizing, failure-domain placement, resource sizing and persistent-storage recommendations.
  • Provide separate conf/zoo.cfg and conf/java.env examples with parameter descriptions, including snapshot and transaction-log cleanup.
  • Explain the default 1 MiB limit and recommend jute.maxbuffer=104857600 (100 MiB) on ZooKeeper servers to match zookeeper.client.max-buffer-size.

Tests

  • Run build_versioned_docs.sh and setup_blog.sh, then npm run build -- --no-minify in website.
  • ./mvnw -N spotless:check validate with Java 11.
  • git diff --check and local browser review of the generated page.
  • No Java UT/IT added or run for this documentation-only change.

API and Format

No API or storage-format changes.

Documentation

Adds website/docs/maintenance/operations/production-readiness.md to the Next documentation.

Generative AI: OpenAI Codex was used to assist with authoring; the content was reviewed by the contributor.

@hanliu0830
hanliu0830 force-pushed the codex/docs-production-readiness-4338 branch from fa0883e to fe0f86a Compare September 15, 2026 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Add Production Readiness Checklist

1 participant