From a67c73ce54a7ca8ad7f955f901249389ab7441ac Mon Sep 17 00:00:00 2001
From: Yao Qing <Qing.Yao@intel.com>
Date: Tue, 22 Mar 2022 09:41:35 +0800
Subject: [PATCH] Add some command descriptions to the documentation (#217)

* Add some command descriptions to the documentation

* Add a document for Cloudtik Commands

* Remove document for Cloudtik Commands
---
 README.md | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index ad3313ebf..40359a087 100644
--- a/README.md
+++ b/README.md
@@ -55,19 +55,43 @@ Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable as described in [t
 If you do not already have a GCS bucket, create one and configure its permission for your service account.
 More details, please refer to configure [gcs bucket guide](./doc/Configure-GCS-Bucket.md).
 
-### 5. Use CloudTik to manage Spark clusters
+### 5. CloudTik Commands
 ```
+# commands running on working node for handling a cluster
 cloudtik up ./example/cluster/aws/example-minimal.yaml -y   # Create or up a  cluster.
-cloudtik get-head-ip ./example/cluster/aws/example-minimal.yaml    # Get the ip of head node.
-cloudtik get-worker-ips ./example/cluster/aws/example-minimal.yaml    # Get the ips of worker nodes.
+cloudtik down ./example/cluster/aws/example-minimal.yaml -y # Tear down the cluster.
+
+cloudtik attach ./example/cluster/aws/example-minimal.yaml    # Create or attach to a SSH session to the cluster.
 cloudtik exec ./example/cluster/aws/example-minimal.yaml [command]   # Exec a command via SSH on a cloudtik cluster.
-cloudtik rsync-down ./example/cluster/aws/example-minimal.yaml [source] [target]   # Download file from head node.
+cloudtik submit ./example/cluster/aws/example-minimal.yaml  experiment.py  #  Uploads and runs a script on the specified cluster.
+
 cloudtik rsync-up ./example/cluster/aws/example-minimal.yaml [source] [target]   # Upload file to head node.
-cloudtik attach ./example/cluster/aws/example-minimal.yaml    # Create or attach to a SSH session to the cluster.
-cloudtik down ./example/cluster/aws/example-minimal.yaml -y # Tear down the cluster.
-```
+cloudtik rsync-down ./example/cluster/aws/example-minimal.yaml [source] [target]   # Download file from head node.
+
+cloudtik enable-local-access ./example/cluster/aws/example-minimal.yaml # Enable local SOCKS5 proxy to the cluster through SSH
+cloudtik disable-local-access ./example/cluster/aws/example-minimal.yaml # Disable local SOCKS5 proxy to the cluster through SSH
+
+
+# commands running on working node for information and status
+cloudtik get-head-ip ./example/cluster/aws/example-minimal.yaml    # Get the ip of head node.
+cloudtik get-worker-ips ./example/cluster/aws/example-minimal.yaml    # Get the ips of worker nodes.
+cloudtik info ./example/cluster/aws/example-minimal.yaml # Show cluster summary information and useful links to use the cluster.
+cloudtik status ./example/cluster/aws/example-minimal.yaml # Show cluster summary status.
+cloudtik process-status ./example/cluster/aws/example-minimal.yaml # Show process status of cluster nodes.
+cloudtik monitor ./example/cluster/aws/example-minimal.yaml # Tails the monitor logs of a cluster.
+
+
+# commands running on working node for debug
+cloudtik health-check ./example/cluster/aws/example-minimal.yaml   # Do cluster health check.
+cloudtik debug-status ./example/cluster/aws/example-minimal.yaml   # Show debug status of cluster scaling.
+cloudtik cluster-dump ./example/cluster/aws/example-minimal.yaml   # Get log data from one or more nodes.
+cloudtik kill-random-node ./example/cluster/aws/example-minimal.yaml   # Kills a random node. For testing purposes only.
 
-## Building CloudTik
+
+# workspace commands
+cloudtik workspace   $workspace_config_file      # Create a Workspace on Cloud based on the workspace configuration file.
+```
+You can use the command `cloudtik --help` or `cloudtik up --help` to get detailed instructions.
 
 Usually you can install CloudTik package directly through pip as above and don't need to build it from source code. If you are contributing to CloudTik, you can follow the instrucitons in [Building CloudTik](./doc/Building.md) for building.