Skip to content

Commit

Permalink
fix README.md comments to make clearly, add example/jobflow/README.md;
Browse files Browse the repository at this point in the history
  • Loading branch information
waiterQ committed Aug 11, 2022
1 parent 76dac4c commit 9b4531d
Show file tree
Hide file tree
Showing 3 changed files with 416 additions and 359 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ are looking forward to your participation.
**NOTE**: the scheduler is built based on [kube-batch](https://github.com/kubernetes-sigs/kube-batch);
refer to [#241](https://github.com/volcano-sh/volcano/issues/241) and [#288](https://github.com/volcano-sh/volcano/pull/288) for more detail.

[JobFlow](./docs/design/jobflow/jobflow.md) 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.

![cncf_logo](docs/images/cncf-logo.png)

Volcano is an incubating project of the [Cloud Native Computing Foundation](https://cncf.io/) (CNCF). Please consider joining the CNCF if you are an organization that wants to take an active role in supporting the growth and evolution of the cloud native ecosystem.
Expand All @@ -40,8 +38,6 @@ Volcano is an incubating project of the [Cloud Native Computing Foundation](http

![volcano](docs/images/volcano-architecture.png)

![jobflow-1.png](./docs/design/images/jobflow-1.png)

## Talks

- [Intro: Kubernetes Batch Scheduling @ KubeCon 2019 EU](https://sched.co/MPi7)
Expand Down Expand Up @@ -114,10 +110,6 @@ job.batch/volcano-admission-init 1/1 48s 96s
```

### Disable JobFlow

Disable JobFlow related components if necessary. You need to add --forbid-jobflow=true to the startup parameters of the controller and admission respectively. The default is false to enable the state.

### Install from code

If you don't have a kubernetes cluster, try one-click install from code base:
Expand Down
Loading

0 comments on commit 9b4531d

Please sign in to comment.