-
Notifications
You must be signed in to change notification settings - Fork 971
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix README.md clearly #2427
fix README.md clearly #2427
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
## JobFlow | ||
|
||
#### These examples shows how to run JobFlow via Volcano. | ||
|
||
[JobFlow](../../docs/design/jobflow) is a workflow engine based on volcano Job. It proposes two concepts to automate running multiple batch jobs, named JobTemplate and JobFlow, so end users can easily declare their jobs and run them using complex control primitives such as sequential or parallel execution, if-then -else statement, switch-case statement, loop execution, etc. | ||
|
||
read design at [here](../../docs/design/jobflow). | ||
|
||
### Prerequisites | ||
|
||
- docker: `18.06` | ||
- Kubernetes: >`1.17` | ||
|
||
## startup steps | ||
|
||
build image from local | ||
```bash | ||
# get volcano and jobflow source code from github | ||
git clone http://github.com/volcano-sh/volcano.git | ||
git clone https://github.com/BoCloud/JobFlow.git | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. jobflow has been donated to the volcano community to become part of the volcano project. The relevant PR is under review. /hold There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. so..., no need for example/jobflow/README.md? what about README.md, if no-need change, i will close this pr There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This pr can stay open.I think it needs some modification, after that we can merge this pr, and after jobflow is merged, it may need to be modified again. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ok. |
||
|
||
# build image beyondcent/jobflow:v0.0.1 from local | ||
cd JobFlow | ||
make | ||
make docker-build | ||
``` | ||
|
||
##### deploy JobFlow from [here](https://github.com/BoCloud/JobFlow#deploy) | ||
```bash | ||
kubectl apply -f https://raw.githubusercontent.com/BoCloud/JobFlow/main/deploy/jobflow.yaml | ||
``` | ||
|
||
##### deploy Volcano from [here](https://volcano.sh/en/docs/installation/#install-with-yaml-files) | ||
```bash | ||
kubectl apply -f https://raw.githubusercontent.com/volcano-sh/volcano/master/installer/volcano-development.yaml | ||
``` | ||
|
||
if cert of `jobflow-webhook-service.kube-system.svc` has expired, generate one to replace it. | ||
```bash | ||
# delete expired cert in secrets | ||
kubectl delete secret jobflow-webhook-server-cert -nkube-system | ||
|
||
# use gen-admission-secret.sh register new secret | ||
cd volcano | ||
./installer/dockerfile/webhook-manager/gen-admission-secret.sh --service jobflow-webhook-service --namespace kube-system --secret jobflow-webhook-server-cert | ||
|
||
# restart jobflow-controller-manager | ||
kubectl delete pod/jobflow-controller-manager-67847d59dd-j8dmc -nkube-system | ||
``` | ||
|
||
##### run jobflow example | ||
```bash | ||
# deploy jobTemplate first | ||
cd volcano | ||
kubectl apply -f example/jobflow/JobTemplate.yaml | ||
# deploy jobFlow second | ||
kubectl apply -f example/jobflow/JobFlow.yaml | ||
|
||
# check them | ||
kubectl get jt | ||
kubectl get jf | ||
kubectl get po | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is not recommended to delete all introductions related to jobflow in the readme. You can keep the brief introduction and direct it to the design doc you write.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
got it, after #2383, i will modify this pr to get to suitable