Skip to content

[docs] Add Fluss Gateway deployment guide - #4210

Open
beryllw wants to merge 1 commit into
apache:mainfrom
beryllw:gateway/gateway-deployment-docs
Open

[docs] Add Fluss Gateway deployment guide#4210
beryllw wants to merge 1 commit into
apache:mainfrom
beryllw:gateway/gateway-deployment-docs

Conversation

@beryllw

@beryllw beryllw commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Add deployment guidance for the Gateway binary, systemd, Docker, Docker Compose, and Kubernetes. Document configuration, health checks, graceful shutdown, scaling, observability, security, and troubleshooting. Link the guide from the Gateway and installation overview pages.

Validate the Kubernetes manifests with server-side dry-run and an end-to-end deployment against a running Fluss cluster.

Purpose

Linked issue: close #4202

Brief change log

Tests

API and Format

Documentation

@beryllw
beryllw marked this pull request as draft September 3, 2026 04:12
@beryllw
beryllw force-pushed the gateway/gateway-deployment-docs branch 4 times, most recently from 9638e47 to 8c25204 Compare September 3, 2026 09:57
@beryllw
beryllw marked this pull request as ready for review September 3, 2026 11:32
@beryllw

beryllw commented Sep 3, 2026

Copy link
Copy Markdown
Contributor Author

On Kubernetes, the manifests above add `prometheus.io/scrape` annotations;
adjust them to your collector's discovery model.

**Logs.** The Gateway logs to standard output, which the container runtime and

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The documentation says that the Gateway logs to standard output, but the current logger writes through eprintln!, so logs are emitted to standard error. Could we update this to say “standard error”? Container runtimes and systemd will still capture it normally.

@beryllw
beryllw force-pushed the gateway/gateway-deployment-docs branch from 8c25204 to f308f18 Compare September 4, 2026 14:51
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 Fluss Gateway deployment documentation

2 participants