This is an automated email from the ASF dual-hosted git repository.
RexXiong pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/celeborn.git
The following commit(s) were added to refs/heads/main by this push:
new 054af9d999 [CELEBORN-2475] Fix stale HA configuration documentation
that breaks CI
054af9d999 is described below
commit 054af9d9990a280199b5532b988829389a0aed16
Author: zhengtao <[email protected]>
AuthorDate: Mon Oct 12 22:16:17 2026 +0800
[CELEBORN-2475] Fix stale HA configuration documentation that breaks CI
### What changes were proposed in this pull request?
Align the generated HA configuration documentation with
`ConfigurationSuite` output by restoring the missing trailing space after the
final table delimiter for `celeborn.master.ha.ratis.unexpected.close.action`.
### Why are the changes needed?
`ConfigurationSuite` compares generated configuration rows with
`docs/configuration/ha.md` exactly. The checked-in row differs by one trailing
space, causing six service jobs in the [main SBT CI
run](https://github.com/apache/celeborn/actions/runs/38038252682) to fail
across Scala 2.12 and 2.13. The change only fixes the documentation golden file.
### Does this PR introduce _any_ user-facing change?
- [ ] Yes
No runtime behavior or rendered documentation changes.
### How was this patch tested?
- Verified that the complete file differs only by the trailing space
required by `ConfigurationSuite`'s table-row generator.
- Attempted `build/mvn test -pl common -am -Dtest=none
-DwildcardSuites=org.apache.celeborn.ConfigurationSuite`; it could not reach
the tests because this local environment does not have `javac`. The PR CI will
run the suite.
Closes #3866 from zaynt4606/CELEBORN-2475-fix-ha-config-doc.
Authored-by: zhengtao <[email protected]>
Signed-off-by: Shuang <[email protected]>
---
docs/configuration/ha.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/configuration/ha.md b/docs/configuration/ha.md
index 21fd19ca63..51007ed055 100644
--- a/docs/configuration/ha.md
+++ b/docs/configuration/ha.md
@@ -30,5 +30,5 @@ license: |
| celeborn.master.ha.ratis.raft.server.close.threshold | 60s | false |
Threshold for the Ratis JvmPauseMonitor to close the local raft server after a
JVM/host pause, e.g. long GC, VM live migration or jmap -F. Maps to Ratis
raft.server.close.threshold. Once exceeded, the master leaves the raft group
until the process is restarted. Takes precedence over the
celeborn.ratis.raft.server.close.threshold passthrough when both are set. |
1.0.0 | |
| celeborn.master.ha.ratis.raft.server.storage.dir | /tmp/ratis | false | Root
storage directory to hold RaftServer data. | 0.3.0 |
celeborn.ha.master.ratis.raft.server.storage.dir |
| celeborn.master.ha.ratis.raft.server.storage.startup.option | RECOVER |
false | Startup option of RaftServer storage. Available options: RECOVER,
FORMAT. | 0.5.0 | |
-| celeborn.master.ha.ratis.unexpected.close.action | exit | false | Action
when the local raft server is closed unexpectedly, i.e. not via the master stop
flow, e.g. closed by the Ratis JvmPauseMonitor after a JVM pause longer than
raft.server.close.threshold. 'exit' logs a fatal message and exits the master
process so that supervisors (systemd/K8s) can restart it and the node rejoins
the raft group; 'none' only logs. | 1.0.0 | |
+| celeborn.master.ha.ratis.unexpected.close.action | exit | false | Action
when the local raft server is closed unexpectedly, i.e. not via the master stop
flow, e.g. closed by the Ratis JvmPauseMonitor after a JVM pause longer than
raft.server.close.threshold. 'exit' logs a fatal message and exits the master
process so that supervisors (systemd/K8s) can restart it and the node rejoins
the raft group; 'none' only logs. | 1.0.0 | |
<!--end-include-->
