提交 317411db 编写于 作者: L liqingping

docs: update readme

上级 161baea8
......@@ -2,8 +2,8 @@
DI Orchestrator is designed to manage DI (Decision Intelligence) jobs using Kubernetes Custom Resource and Operator.
### Prerequisites
- A well prepared kubernetes cluster. Follow the [instructions](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/) to create a kubernetes cluster, or create a local kubernetes node referring to [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) or [minikube](https://minikube.sigs.k8s.io/docs/start/)
- Cert-manager. Installation on kubernetes please refer to [cert-manager docs](https://cert-manager.io/docs/installation/kubernetes/). Or you can install by the following command.
- A well-prepared kubernetes cluster. Follow the [instructions](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/) to create a kubernetes cluster, or create a local kubernetes node referring to [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) or [minikube](https://minikube.sigs.k8s.io/docs/start/)
- Cert-manager. Installation on kubernetes please refer to [cert-manager docs](https://cert-manager.io/docs/installation/kubernetes/). Or you can install it by the following command.
```bash
kubectl create -f ./config/certmanager/cert-manager.yaml
```
......@@ -16,7 +16,7 @@ kubectl create -f ./config/di-manager.yaml
`di-operator` and `di-server` will be installed in `di-system` namespace.
```bash
$ kubectl get pod -n -system
$ kubectl get pod -n di-system
NAME READY STATUS RESTARTS AGE
di-operator-57cc65d5c9-5vnvn 1/1 Running 0 59s
di-server-7b86ff8df4-jfgmp 1/1 Running 0 59s
......@@ -32,7 +32,7 @@ kubectl create -f examples/di_v1alpha1_agconfig.yaml -n di-system
$ kubectl create -f examples/di_v1alpha1_dijob.yaml
# get pod and you will see coordinator is created by di-operator
# few seconds later, you will see collectors and learners created by di-server
# a few seconds later, you will see collectors and learners created by di-server
$ kubectl get pod
# get logs of coordinator
......@@ -43,4 +43,6 @@ $ kubectl logs dijob-example-coordinator
Refers to [user-guide](./docs/architecture.md). For Chinese version, please refer to [中文手册](./docs/architecture-cn.md)
## Contributing
Refers to [developer-guide](./docs/developer-guide.md). Contact us throw <opendilab.contact@gmail.com>
\ No newline at end of file
Refers to [developer-guide](./docs/developer-guide.md).
Contact us throw <opendilab.contact@gmail.com>
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册