[GitHub] [incubator-celeborn] cfmcgrady commented on a diff in pull request #1745: [CELEBORN-822][DOC] Add quick start guide

["cfmcgrady (via GitHub)" <gi...@apache.org>]

cfmcgrady commented on code in PR #1745:
URL: https://github.com/apache/incubator-celeborn/pull/1745#discussion_r1271273309


##########
docs/README.md:
##########
@@ -17,6 +16,97 @@ license: |
   See the License for the specific language governing permissions and
   limitations under the License.
 ---
+Quick Start
+===
+This documentation gives a quick start guide for running Spark with Celeborn.
 
-Apache Celeborn (Incubating)
-===
\ No newline at end of file
+### Download Celeborn
+Download the latest Celeborn binary from the [Downloading Page](https://celeborn.apache.org/download/).
+Decompress the binary into ```$CELEBORN_HOME```
+```angular2html
+tar -C <DST_DIR> -zxvf apache-celeborn-<VERSION>-bin.tgz
+```
+
+## Configure Logging and Storage
+#### Configure Logging
+```angular2html
+cd $CELEBORN_HOME/conf
+mv log4j2.xml.template log4j2.xml
+```
+#### Configure Storage
+Configure the directory to store shuffle data, for example $CELEBORN_HOME/shuffle
+```angular2html
+cd $CELEBORN_HOME/conf
+echo "celeborn.worker.storage.dirs=$CELEBORN_HOME/shuffle" > celeborn-defaults.conf
+```
+
+## Start Celeborn Service
+#### Start Master
+```angular2html
+cd $CELEBORN_HOME
+./sbin/start-master.sh
+```
+You should see ```Master```'s ip:port in the log:
+```angular2html
+INFO [main] NettyRpcEnvFactory: Starting RPC Server [MasterSys] on 192.168.2.109:9097
+```
+#### Start Worker
+Use the Master's IP and Port to start Worker:
+```angular2html
+cd $CELEBORN_HOME
+./sbin/start-worker.sh celeborn://${Master IP}:${Master Port}
+```
+You should see the following message in Worker's log:
+```angular2html
+23/07/22 11:39:23,546 INFO [main] MasterClient: connect to master 192.168.2.109:9097.
+23/07/22 11:39:23,673 INFO [main] Worker: Register worker successfully.
+```
+And also the following message in Master's log:
+```angular2html
+23/07/22 11:39:23,650 INFO [dispatcher-event-loop-9] Master: Registered worker
+Host: 192.168.2.109
+RpcPort: 57806
+PushPort: 57807
+FetchPort: 57809
+ReplicatePort: 57808
+SlotsUsed: 0
+LastHeartbeat: 0
+HeartbeatElapsedSeconds: xxx
+Disks:
+  DiskInfo0: xxx
+UserResourceConsumption: empty
+WorkerRef: null
+```
+
+## Start Spark with Celeborn
+#### Copy Celeborn Client to Spark's jars
+Celeborn release binary contains clients for Spark2.x and Spark3.x, copy the corresponding client jar into Spark's

Review Comment:
   ```suggestion
   Celeborn release binary contains clients for Spark 2.x and Spark 3.x, copy the corresponding client jar into Spark's
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@celeborn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org