volcano

README

---

Volcano is a batch system built on Kubernetes. It provides a suite of mechanisms that are commonly required by many classes of batch & elastic workload including: machine learning/deep learning, bioinformatics/genomics and other "big data" applications. These types of applications typically run on generalized domain frameworks like TensorFlow, Spark, Ray, PyTorch, MPI, etc, which Volcano integrates with.

Volcano builds upon a decade and a half of experience running a wide variety of high performance workloads at scale using several systems and platforms, combined with best-of-breed ideas and practices from the open source community.

Until June 2021, Volcano has been widely used around the world at a variety of industries such as Internet/Cloud/Finance/ Manufacturing/Medical. More than 20 companies or institutions are not only end users but also active contributors. Hundreds of contributors are taking active part in the code commit/PR review/issue discussion/docs update and design provision. We are looking forward to your participation.

NOTE: the scheduler is built based on kube-batch; refer to #241 and #288 for more detail.

Volcano is an incubating project of the Cloud Native Computing Foundation (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.

Overall Architecture

Talks

• Intro: Kubernetes Batch Scheduling @ KubeCon 2019 EU
• Volcano 在 Kubernetes 中运行高性能作业实践 @ ArchSummit 2019
• Volcano：基于云原生的高密计算解决方案 @ Huawei Connection 2019
• Improving Performance of Deep Learning Workloads With Volcano @ KubeCon 2019 NA
• Batch Capability of Kubernetes Intro @ KubeCon 2019 NA
• Intro: Kubernetes Batch Scheduling @ KubeCon 2019 EU

Ecosystem

• spark-operator
• kubeflow/tf-operator
• kubeflow/arena
• Horovod/MPI
• paddlepaddle
• cromwell
• KubeRay

Quick Start Guide

Prerequisites

• Kubernetes 1.12+ with CRD support

You can try Volcano by one of the following two ways.

Note:

• For Kubernetes v1.17+ use CRDs under config/crd/bases (recommended)
• For Kubernetes versions < v1.16 use CRDs under config/crd/v1beta1 (deprecated)

Install with YAML files

Install Volcano on an existing Kubernetes cluster. This way is both available for x86_64 and arm64 architecture.

kubectl apply -f https://raw.githubusercontent.com/volcano-sh/volcano/release-1.10/installer/volcano-development.yaml

Enjoy! Volcano will create the following resources in volcano-system namespace.

NAME                                       READY   STATUS      RESTARTS   AGE
pod/volcano-admission-5bd5756f79-dnr4l     1/1     Running     0          96s
pod/volcano-admission-init-4hjpx           0/1     Completed   0          96s
pod/volcano-controllers-687948d9c8-nw4b4   1/1     Running     0          96s
pod/volcano-scheduler-94998fc64-4z8kh      1/1     Running     0          96s

NAME                                TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
service/volcano-admission-service   ClusterIP   10.98.152.108   <none>        443/TCP   96s

NAME                                  READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/volcano-admission     1/1     1            1           96s
deployment.apps/volcano-controllers   1/1     1            1           96s
deployment.apps/volcano-scheduler     1/1     1            1           96s

NAME                                             DESIRED   CURRENT   READY   AGE
replicaset.apps/volcano-admission-5bd5756f79     1         1         1       96s
replicaset.apps/volcano-controllers-687948d9c8   1         1         1       96s
replicaset.apps/volcano-scheduler-94998fc64      1         1         1       96s

NAME                               COMPLETIONS   DURATION   AGE
job.batch/volcano-admission-init   1/1           48s        96s

Install via helm

To install official release, please visit to helm-charts for details.

helm repo add volcano-sh https://volcano-sh.github.io/helm-charts
helm install volcano volcano-sh/volcano -n volcano-system --create-namespace

Install from source code for developers:

helm install volcano installer/helm/chart/volcano --namespace volcano-system --create-namespace

# list helm release
helm list -n volcano-system

Install from code

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

./hack/local-up-volcano.sh

This way is only available for x86_64 temporarily.

Install monitoring system

If you want to get prometheus and grafana volcano dashboard after volcano installed, try following commands:

make TAG=v1.10.0 generate-yaml
kubectl create -f _output/release/volcano-monitoring-v1.10.0.yaml

Kubernetes compatibility

	Kubernetes 1.17	Kubernetes 1.18	Kubernetes 1.19	Kubernetes 1.20	Kubernetes 1.21	Kubernetes 1.22	Kubernetes 1.23	Kubernetes 1.24	Kubernetes 1.25	Kubernetes 1.26	Kubernetes 1.27	Kubernetes 1.28	Kubernetes 1.29	Kubernetes 1.30
Volcano v1.6	✓	✓	✓	✓	✓	✓	✓	-	-	-	-	-	-	-
Volcano v1.7	-	-	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	-	_
Volcano v1.8	-	-	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	-	-
Volcano v1.9	-	-	-	-	✓	✓	✓	✓	✓	✓	✓	✓	✓	-
Volcano v1.10	-	-	-	-	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Volcano HEAD (master)	-	-	-	-	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓

Key:

• ✓ Volcano and the Kubernetes version are exactly compatible.
• + Volcano has features or API objects that may not be present in the Kubernetes version.
• - The Kubernetes version has features or API objects that Volcano can't use.

Meeting

Community weekly meeting for Asia: 15:00 - 16:00 (UTC+8) Friday. (Convert to your timezone.)

Community biweekly meeting for America: 08:30 - 09:30 (UTC-8) Thursday. (Convert to your timezone.)

Community meeting for Europe is ongoing on demand now. If you have some ideas or topics to discuss, please leave message in the slack. Maintainers will contact with you and book an open meeting for that.

Resources:

• Meeting notes and agenda
• Meeting link
• Meeting Calendar | Subscribe

Contact

If you have any question, feel free to reach out to us in the following ways:

Volcano Slack Channel | Join

Mailing List

Wechat: Add WeChat account k8s2222 (华为云小助手2号) to let her pull you into the group.