apache/celeborn
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
41fdb8ade1
celeborn/docs/cli.md
Aravind Patnam 12f25d3d0f [CELEBORN-1678] Add Celeborn CLI User guide in README 
### What changes were proposed in this pull request?
adding user guide to README for cli

### Why are the changes needed?
better user experience when using CLI.

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

### How was this patch tested?
N/A

Closes #2862 from akpatnam25/CELEBORN-1678.

Authored-by: Aravind Patnam <akpatnam25@gmail.com>
Signed-off-by: mingji <fengmingxiao.fmx@alibaba-inc.com>
2024-10-30 19:58:34 +08:00

946 B
Raw Blame History

Celeborn CLI User Guide

Build

  • Create the distribution:
./build/make-distribution.sh
  • Inside the distribution, there should be a new directory called cli-jars. This directory contains all the jars necessary for the Celeborn CLI to work.
    • Please note that Celeborn CLI requires version 0.6+ of Celeborn to work since it depends on OpenAPI for API calls.

Setup

  • Set JAVA_HOME if not set already on your machine:
export JAVA_HOME=/path/to/java/home
  • Add the path of the sbin dir to your $PATH:
export PATH=$PATH:/path/to/CELEBORN_HOME/apache-celeborn-0.6.0-SNAPSHOT-bin/sbin
  • Verify celeborn-cli works:
[~]$ celeborn-cli --version
Celeborn CLI - Celeborn 0.6.0-SNAPSHOT
[~]$

Using Celeborn CLI

The commands available can be seen via the help command. For example, for master commands:

celeborn-cli master -h

Similarily, for worker commands:

celeborn-cli worker -h