[dolphinscheduler-operator] branch master updated: Polish readme

[ke...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kezhenxu94 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-operator.git


The following commit(s) were added to refs/heads/master by this push:
     new 1f3e53e  Polish readme
1f3e53e is described below

commit 1f3e53ea8b21fe9c9302c8f6eb02c8202eb9103e
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Fri Aug 5 10:52:17 2022 +0800

    Polish readme
---
 README.md | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b4deb9c..f673d3c 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,11 @@ kubectl create namespace ds
 
 - Install PostgreSQL database (Optional)
 
-If you don't have a running database, you can run `kubectl apply -f config/ds/postgreSQL`
+If you don't have a running database, you can run 
+```shell
+kubectl apply -f config/ds/postgreSQL
+```
+
 to create a demo database, note that this is only for demonstration, DO NOT use it in production environment.
 You need to replace the `hostPath.path` in `postgres-pv.yaml` if you don't have a directory `/var/lib/data`.
 
@@ -51,7 +55,11 @@ Connect to PostgreSQL and initialize the database schema by executing
 - Install zookeeper (Optional)
 
 If you don't have a running zookeeper, the demo doployment file is in `config/ds/zookeeper`,
-run `kubectl apply -f config/ds/zookeeper`.
+
+```shell
+kubectl apply -f config/ds/zookeeper
+```
+
 
 - Create pv and pvc (Optional)
 
@@ -64,6 +72,20 @@ And you can mount the lib in dolphinscheduler `/opt/soft`  in config/samples/ds_
 
 Mount the logs in `/opt/dolphinscheduler/logs` with the pvcname named `log_pvc_name`.
 
+
+## query the status of worker
+
+```shell
+kubectl get dsworkers.ds.apache.dolphinscheduler.dev -n ds
+```
+
+
+## api explain
+
+```shell
+kubectl explain dsmaster
+```
+
 ## how to test
 
 * Replace the database config and zookeeper config paramters in [`config/samples/`](./config/samples/).
@@ -72,6 +94,9 @@ Mount the logs in `/opt/dolphinscheduler/logs` with the pvcname named `log_pvc_n
 
 * Install CRDs and controller
 
+
+## how to deploy
+
 ```shell
 export IMG=ghcr.io/apache/dolphinscheduler-operator:latest
 make build && make manifests && make install && make deploy