apache/celeborn
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[MINOR] Add documentation for CELEBORN_NO_DAEMONIZE

Browse Source 
### What changes were proposed in this pull request?

Add documentation for `CELEBORN_NO_DAEMONIZE`

### Why are the changes needed?

Currently the celeborn processes starts in background and it was difficult to figure out how to change that behaviour. Setting this flag to true, will allow Celeborn processes to run in foreground.

### Does this PR introduce _any_ user-facing change?
NA

### How was this patch tested?
NA

Closes #3020 from s0nskar/no-daemonize-docs.

Authored-by: Sanskar Modi <sanskarmodi97@gmail.com>
Signed-off-by: mingji <fengmingxiao.fmx@alibaba-inc.com>
This commit is contained in:
Sanskar Modi 2024-12-23 10:31:37 +08:00 committed by mingji
parent a357df94f1
commit 80523214e4
3 changed files with 23 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
charts/celeborn/values.yaml
View File

@ -128,7 +128,7 @@ environments:
CELEBORN_WORKER_MEMORY: 2g
CELEBORN_WORKER_OFFHEAP_MEMORY: 12g
CELEBORN_WORKER_JAVA_OPTS: "-XX:-PrintGC -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCDateStamps -Xloggc:gc-worker.out -Dio.netty.leakDetectionLevel=advanced"
CELEBORN_NO_DAEMONIZE: 1
CELEBORN_NO_DAEMONIZE: true
TZ: "Asia/Shanghai"
# -- Specifies the DNS policy for Celeborn pods to use

6
conf/celeborn-env.sh.template
View File

@ -23,8 +23,11 @@
# - CELEBORN_WORKER_JAVA_OPTS
# - CELEBORN_PID_DIR
# - CELEBORN_LOG_DIR
# - CELEBORN_SSH_OPTS, ssh opts for `start-all` and `stop-all` operations
# - CELEBORN_SLEEP, Waiting time for `start-all` and `stop-all` operations (e.g. 5, 5s, 5m)
# - CELEBORN_PREFER_JEMALLOC, to enable jemalloc memory allocator
# - CELEBORN_JEMALLOC_PATH, to set jemalloc library path
# - CELEBORN_NO_DAEMONIZE, set `true` to run the proposed command in the foreground
# Example:
# CELEBORN_MASTER_MEMORY=2g
@ -34,5 +37,8 @@
# CELEBORN_MASTER_JAVA_OPTS="-XX:-PrintGC -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCDateStamps -Xloggc:gc-master.out -Dio.netty.leakDetectionLevel=advanced"
# CELEBORN_PID_DIR="$CELEBORN_HOME/pids"
# CELEBORN_LOG_DIR="$CELEBORN_HOME/logs"
# CELEBORN_SLEEP="5s"
# CELEBORN_SSH_OPTS="-o StrictHostKeyChecking=no"
# CELEBORN_PREFER_JEMALLOC="true"
# CELEBORN_JEMALLOC_PATH="/path/to/libjemalloc.so"
# CELEBORN_NO_DAEMONIZE="true"

31
docs/configuration/index.md
View File

@ -138,21 +138,22 @@ end="<!--end-include-->"
Recommend configuring in `conf/celeborn-env.sh`.
| Key | Default | Description |
|----------------------------------|-------------------------------------------------|--------------------------------------------------------|
| `CELEBORN_HOME` | ``$(cd "`dirname "$0"`"/..; pwd)`` | |
| `CELEBORN_CONF_DIR` | `${CELEBORN_CONF_DIR:-"${CELEBORN_HOME}/conf"}` | |
| `CELEBORN_MASTER_MEMORY` | 1 GB | |
| `CELEBORN_WORKER_MEMORY` | 1 GB | |
| `CELEBORN_WORKER_OFFHEAP_MEMORY` | 1 GB | |
| `CELEBORN_MASTER_JAVA_OPTS` | | |
| `CELEBORN_WORKER_JAVA_OPTS` | | |
| `CELEBORN_PID_DIR` | `${CELEBORN_HOME}/pids` | |
| `CELEBORN_LOG_DIR` | `${CELEBORN_HOME}/logs` | |
| `CELEBORN_SSH_OPTS` | `-o StrictHostKeyChecking=no` | |
| `CELEBORN_SLEEP` | | Waiting time for `start-all` and `stop-all` operations |
| `CELEBORN_PREFER_JEMALLOC` | | set `true` to enable jemalloc memory allocator |
| `CELEBORN_JEMALLOC_PATH` | | jemalloc library path |
| Key | Default | Description |
|----------------------------------|-------------------------------------------------|----------------------------------------------------------|
| `CELEBORN_HOME` | ``$(cd "`dirname "$0"`"/..; pwd)`` | |
| `CELEBORN_CONF_DIR` | `${CELEBORN_CONF_DIR:-"${CELEBORN_HOME}/conf"}` | |
| `CELEBORN_MASTER_MEMORY` | 1 GB | |
| `CELEBORN_WORKER_MEMORY` | 1 GB | |
| `CELEBORN_WORKER_OFFHEAP_MEMORY` | 1 GB | |
| `CELEBORN_MASTER_JAVA_OPTS` | | |
| `CELEBORN_WORKER_JAVA_OPTS` | | |
| `CELEBORN_PID_DIR` | `${CELEBORN_HOME}/pids` | |
| `CELEBORN_LOG_DIR` | `${CELEBORN_HOME}/logs` | |
| `CELEBORN_SSH_OPTS` | `-o StrictHostKeyChecking=no` | ssh opts for `start-all` and `stop-all` operations |
| `CELEBORN_SLEEP` | | Waiting time for `start-all` and `stop-all` operations |
| `CELEBORN_PREFER_JEMALLOC` | | set `true` to enable jemalloc memory allocator |
| `CELEBORN_JEMALLOC_PATH` | | jemalloc library path |
| `CELEBORN_NO_DAEMONIZE` | | set `true` to run the proposed command in the foreground |
## Tuning