You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by ke...@apache.org on 2022/08/03 13:55:53 UTC
[dolphinscheduler-operator] 01/02: Polish readme
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch readme
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-operator.git
commit 55f52f76f693c4952b56d64e9738506c8ef7b034
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Tue Aug 2 13:57:59 2022 +0800
Polish readme
---
README.md | 62 +++++++++++++++++++++++++-------------------------------------
1 file changed, 25 insertions(+), 37 deletions(-)
diff --git a/README.md b/README.md
index 7b5983b..4a181ff 100644
--- a/README.md
+++ b/README.md
@@ -19,59 +19,51 @@
# dolphinscheduler-operator
-## feature
+## Features
-1. deployment the master ,worker moudle
-2. scale the pods numbers with one commond
-3. update the master,worker version quickly (not include the sql)
+- Deploy and manage the master, worker, alert, api components.
+- Scale the Pod numbers with one commond.
+- Update the component's version (not include the database schema).
## Project Status
-**Project status:** *'alpha1'*
+Project status: `alpha1`
-**Current API version:** *`v1alpha1`*
-
-## Prerequisites
-
-**go version :** *go1.17.6*
-
-**minikube version:** *v1.25.1*
-
-**kubebuilder version:** *3.3.0*
-
-**kubectl version:** *1.23.1*
+Current API version: `v1alpha1`
## Get Started
-1. **create namespace ds**
+- Create a namespace `ds`
- kubectl create namespace ds
+```shell
+kubectl create namespace ds
+```
-2. **install postgres (not required)**
+- Install PostgreSQL database (Optional)
- if had no postgressql ,you can turn into config/ds/ and run *"kubectl apply -f postgreSQL/"* ,but you need to replace your local document to hostPath.path in postgres-pv.yaml first
+If you don't have a running database, you can run `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`.
- connect to postgressql and run the sql script in dolphinscheduler/dolphinscheduler-dao/resources/sql
+Connect to PostgreSQL and initialize the database schema by executing
+[`dolphinscheduler/dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_postgresql.sql`](https://github.com/apache/dolphinscheduler/blob/dev/dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_postgresql.sql).
- record the deployment ip eg: 172.17.0.3
-
+- 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`.
-3. **install zookeeper(not required)**
+- Create pv and pvc (Optional)
- if had no zookeeper ,the doployment file is in config/ds/zookeeper ,run *"kubectl apply -f zookeeper/"* and record the ip ,eg :172.17.0.4
+If you have pv and pvc, you can config it in `config/sameples`.
+Or you can create it with `config/ds/ds-pv.yaml` and `config/configmap/ds-pvc.yaml`.
+Notice to replace the `hostPath.path` in `ds-pv.yaml`.
-4. **create pv and pvc (not required)**
+And you can mount the lib in dolphinscheduler `/opt/soft` in config/samples/ds_v1alpha1_dsworker.yaml with paramter named lib_pvc_name
- if you had pv and pvc ,you can config it in config/sameples
-
- or you can create it with config/ds/ds-pv.yaml and config/configmap/ds-pvc.yaml .notice to replace your local document address in hostPath.path in ds-pv.yaml
-
- and you can mount the lib in dolphinscheduler /opt/soft in config/samples/ds_v1alpha1_dsworker.yaml with paramter named lib_pvc_name
-
- mount the logs in /opt/dolphinscheduler/logs with the paramters named log_pvc_name with pvcname
+Mount the logs in `/opt/dolphinscheduler/logs` with the pvcname named `log_pvc_name`.
## how to test
@@ -86,7 +78,3 @@
* first run *"kubectl apply -f ds_v1alpha1_dsalert.yaml "*
* then run *"kubectl apply -f ds_v1alpha1_api.yaml -f ds_v1alpha1_dsmaster.yaml -f ds_v1alpha1_dsworker.yaml "*
-
- ## the result
-
- 