Skip to content

Commit

Permalink
Polish readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kezhenxu94 committed Aug 5, 2022
1 parent 6a1f18d commit 1f3e53e
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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)

Expand All @@ -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/).
Expand All @@ -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
Expand Down

0 comments on commit 1f3e53e

Please sign in to comment.