Skip to content

Fluss Documentation add CoordinatorServer High Availability (HA) Setup - #4111

Open
striver619 wants to merge 1 commit into
apache:mainfrom
striver619:main
Open

Fluss Documentation add CoordinatorServer High Availability (HA) Setup#4111
striver619 wants to merge 1 commit into
apache:mainfrom
striver619:main

Conversation

@striver619

Copy link
Copy Markdown

Contribution Checklist

  • Make sure that the pull request corresponds to a GitHub issue.
  • Name the pull request in the format "[component] Title of the pull request".
  • Fill out the template below to describe the changes.
  • Make sure that the change passes the automated tests, i.e., mvn clean verify passes.
  • Each pull request should address only one issue.
  • No generative AI tools used

(The sections below can be removed for hotfixes or typos)
-->

Purpose

This PR adds support for CoordinatorServer High Availability (HA) by providing deployment
documentation. It covers how to deploy a distributed Fluss cluster with multiple CoordinatorServers
using ZooKeeper-based leader election, ensuring failover when the primary CoordinatorServer fails.

Linked issue: close #3989

Brief change log

  • Added deploying-distributed-cluster.md — guide for deploying a distributed Fluss cluster
    on bare machines, including multi-CoordinatorServer HA configuration
  • Added deploying-with-docker.md — guide for deploying Fluss with Docker and Docker Compose,
    including multi-CoordinatorServer HA and multi-TabletServer setups

Tests

N/A — this is a documentation-only change.

API and Format

N/A — no code changes, only new documentation files.

Documentation

This PR introduces two new documentation pages:

  • Deploying Distributed Cluster (bare metal deployment guide with CoordinatorServer HA)
  • Deploying with Docker (Docker and Docker Compose guide with CoordinatorServer HA)

@striver619

Copy link
Copy Markdown
Author

@wuchong @luoyuxia Appreciate a review here.

@leekeiabstraction leekeiabstraction left a comment

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.

TY for the PR. Left some comments. PTAL.


After that, you have successfully deployed a distributed Fluss cluster.

## Fluss CoordinatorServer High Availability (HA) Setup

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.

Can you also update upgrading.md where it says the below?

2. Currently, the Fluss `CoordinatorServer` does not yet support high availability (HA). During the `CoordinatorServer` upgrade stage, the `CoordinatorServer` will be in an unavailable state, which will affect admin operations such as table creation.


:::note
During failover, admin operations (e.g., creating/dropping tables) are temporarily unavailable,
but data reads and writes on existing tables are **not** affected. The time to elect a new

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.

Data reads and writes are not affected if no tablet server fails.


```yaml
services:
coordinator-server:

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.

nit, rename this to coordinator-server-0

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.

[doc] HA Coordinator Documentation

2 participants