Skip to content
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

[Bug] - Fix Broken Links and List Ordering #307

Merged
merged 2 commits into from
Aug 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ type = "docs" # Do not modify.
+++

## What is Volcano
Volcano is a cloud native system for high-performance workloads, which has been accepted by [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/) as its first and only official container batch scheduling project. Volcano supports popular computing frameworks such as [Spark](https://spark.apache.org/), [TensorFlow](https://tensorflow.google.en/), [PyTorch](https://pytorch.org/), [Flink](https://flink.apache.org/), [Argo](https://argoproj.github.io/), [MindSpore](https://www.mindspore.cn/en), and [PaddlePaddle](https://www.paddlepaddle.org.cn/). Volcano also supports scheduling of computing resources on different architecture, such as x86, Arm, and Kunpeng.
Volcano is a cloud native system for high-performance workloads, which has been accepted by [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/) as its first and only official container batch scheduling project. Volcano supports popular computing frameworks such as [Spark](https://spark.apache.org/), [TensorFlow](https://www.tensorflow.org/), [PyTorch](https://pytorch.org/), [Flink](https://flink.apache.org/), [Argo](https://argoproj.github.io/), [MindSpore](https://www.mindspore.cn/en), and [PaddlePaddle](https://www.paddlepaddle.org.cn/). Volcano also supports scheduling of computing resources on different architecture, such as x86, Arm, and Kunpeng.

## Why Volcano
Job scheduling and management become increasingly complex and critical for high-performance batch computing. Common requirements are as follows:
Expand Down Expand Up @@ -63,7 +63,7 @@ Compared with existing queue schedulers, Volcano shortens the average scheduling
Volcano allows you to use mainstream computing frameworks:

* [Spark](https://spark.apache.org/)
* [TensorFlow](https://tensorflow.google.en/)
* [TensorFlow](https://www.tensorflow.org/)
* [PyTorch](https://pytorch.org/)
* [Flink](https://flink.apache.org/)
* [Argo](https://argoproj.github.io/)
Expand All @@ -73,7 +73,7 @@ Volcano allows you to use mainstream computing frameworks:
* [Horovod](https://horovod.readthedocs.io/)
* [MXNet](https://mxnet.apache.org/)
* [Kubeflow](https://www.kubeflow.org/)
* [KubeGene](https://kubegene.io/)
* [KubeGene](https://github.com/volcano-sh/kubegene)
* [Cromwell](https://cromwell.readthedocs.io/)

Volcano has been commercially used as the infrastructure scheduling engine by companies and organizations.
12 changes: 6 additions & 6 deletions content/en/docs/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ linktitle = "Volcano Contribution"

Welcome to Volcano!

- [Before You Start](#before-you-get-started)
- [Before You Start](#before-you-start)
- [Code of Conduct](#code-of-conduct)
- [Community discussions](#community-discussions)
- [Community Expectations](#community-expectations)
- [Getting Started](#getting-started)
- [Your First Contribution](#your-first-contribution)
- [Find Something to Work On](#find-something-to-work-on)
- [Find a Good Topic](#find-a-good-first-topic)
- [Find a Good Topic](#find-a-good-topic)
- [Work on an Issue](#work-on-an-issue)
- [File an Issue](#file-an-issue)
- [Contribution Workflow](#contributor-workflow)
- [Open a Pull Request](#creating-pull-requests)
- [Contribution Workflow](#contribution-workflow)
- [Open a Pull Request](#open-a-pull-request)
- [Code Review](#code-review)
- [Commit Message Format](#commit-message-format)
- [Testing](#testing)
Expand All @@ -54,12 +54,12 @@ To better communicate with the developers in the Volcano community, please subsc
Volcano is an open-source project driven by the Volcano community, which strives to promote a healthy, friendly, and productive environment.
The community is committed to developing a system that helps running high-performance workloads, such as AI, ML, and deep learning applications, on Kubernetes. Building such a system would be impossible without the support of community contributors with similar aspirations.

- For details about the community roles, see [Community Membership](https://github.com/volcano-sh/website/blob/master/content/en/docs/community-membership.md). If you make significant contributions, you will have a more advanced role in the community.
- For details about the community roles, see [Community Membership](https://github.com/volcano-sh/website/blob/master/content/en/docs/membership.md). If you make significant contributions, you will have a more advanced role in the community.


## Getting Started

- For more information on building and deployment, see [setup](https://github.com/volcano-sh/website/blob/master/content/en/docs/deployment.md).
- For more information on building and deployment, see [setup](https://github.com/volcano-sh/website/blob/master/content/en/docs/installation.md).


## Your First Contribution
Expand Down
14 changes: 7 additions & 7 deletions content/en/docs/flink_on_volcano.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Apache Flink is an open-source streaming framework developed by the Apache Softw

Make sure the deployed Kubernate, Kubectl, Volcano are installed correctly.

### Deployment process[1]
### Deployment process

##### 1.Download
##### 1. Download

To run Flink, which requires a Java 8 or 11 environment, use the following instructions to determine the Java version.

Expand All @@ -43,15 +43,15 @@ $ wget https://www.apache.org/dyn/closer.lua/flink/flink-1.12.2/flink-1.12.2-src
$ cd flink-1.12.2
```

##### 2.Start a Cluster
##### 2. Start a Cluster

Running the script completes the deployment of Flink on the cluster.

```bash
$ ./bin/start-cluster.sh
```

##### 3.Submit a job
##### 3. Submit a job

Submit the job using the following instructions.

Expand All @@ -60,9 +60,9 @@ $ ./bin/flink run examples/streaming/WordCount.jar
$ tail log/flink-*-taskexecutor-*.out
```

### Flink on Volcano[2]
### Flink on Volcano

##### 1.The deployment of the component
##### 1. The deployment of the component

Deploying a Flink Cluster requires creating two deploys, a Service, and a ConfigMap. The scheduling strategy is Volcano.The contents of `flink-configuration-configmap.yaml` are shown below.

Expand Down Expand Up @@ -269,7 +269,7 @@ kubectl get svc | grep flink
kubectl get pod -owide | grep Flink
```

##### 2.Outward publishing service[3]
##### 2. Outward publishing service

Once the Flink payload is created, you need to publish the service externally。

Expand Down
4 changes: 1 addition & 3 deletions content/en/docs/referrals.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title = "常见场景推介配置"
title = "Recommended Configurations for Common Scenarios"

date = 2021-04-07
lastmod = 2021-04-07
Expand All @@ -18,8 +18,6 @@ linktitle = "Scenario & Configuration"





### Background

{{<figure library="1" src="ai1.png" title="AI development process">}}
Expand Down
25 changes: 13 additions & 12 deletions content/en/docs/vcjob.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,18 +307,19 @@ spec:
### Supported Frameworks
Volcano supports almost all mainstream computing frameworks including:

1. TensorFlow
2. PyTorch
3. MindSpore
4. PaddlePaddle
5. Spark
6. Flink
7. Open MPI
8. Horovod
9. MXNet
10. Kubeflow
11. Argo
12. KubeGene
1. [Spark](https://spark.apache.org/)
2. [TensorFlow](https://www.tensorflow.org/)
3. [PyTorch](https://pytorch.org/)
4. [Flink](https://flink.apache.org/)
5. [Argo](https://argoproj.github.io/)
6. [MindSpore](https://www.mindspore.cn/en)
7. [PaddlePaddle](https://www.paddlepaddle.org.cn/)
8. [Open MPI](https://www.open-mpi.org/)
9. [Horovod](https://horovod.readthedocs.io/)
10. [MXNet](https://mxnet.apache.org/)
11. [Kubeflow](https://www.kubeflow.org/)
12. [KubeGene](https://github.com/volcano-sh/kubegene)
13. [Cromwell](https://cromwell.readthedocs.io/)

### volcano or default-scheduler
Volcano has been enhanced in batch computing when compared with default-scheduler. It is ideal for high performance computing scenarios such as machine learning, big data applications, and scientific computing.
2 changes: 1 addition & 1 deletion content/zh/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Volcano已经支持几乎所有的主流计算框架:
* [Horovod](https://horovod.readthedocs.io/)
* [mxnet](https://mxnet.apache.org/)
* [Kubeflow](https://www.kubeflow.org/)
* [KubeGene](https://kubegene.io/)
* [KubeGene](https://github.com/volcano-sh/kubegene)
* [Cromwell](https://cromwell.readthedocs.io/)

另外,Volcano已经被作为基础设施调度引擎被多个公司和组织采纳商用。
14 changes: 7 additions & 7 deletions content/zh/docs/flink_on_volcano.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Apache Flink是由Apache软件基金会开发的开源流处理框架,其核

需要已经部署创建好CCE集群,集群下至少有一个可用节点,集群内节点已经绑定了弹性公网IP、kubectl命令行工具。

### 部署流程[1]
### 部署流程

##### 1.Download
##### 1. Download

为了运行Flink,需要java8或11的环境,使用如下的指令确定java的版本。

Expand All @@ -43,15 +43,15 @@ $ wget https://www.apache.org/dyn/closer.lua/flink/flink-1.12.2/flink-1.12.2-src
$ cd flink-1.12.2
```

##### 2.Start a Cluster
##### 2. Start a Cluster

运行脚本完成flink在集群上的部署。

```bash
$ ./bin/start-cluster.sh
```

##### 3.Submit a job
##### 3. Submit a job

随后可以使用如下的指令提交作业。

Expand All @@ -60,9 +60,9 @@ $ ./bin/flink run examples/streaming/WordCount.jar
$ tail log/flink-*-taskexecutor-*.out
```

### Flink on Volcano[2]
### Flink on Volcano

##### 1.部署组件
##### 1. 部署组件

Flink cluster的部署需要创建两个deploy、一个service和一个configmap。调度策略采用volcano。`flink-configuration-configmap.yaml`内容如下

Expand Down Expand Up @@ -269,7 +269,7 @@ kubectl get svc | grep flink
kubectl get pod -owide | grep Flink
```

##### 2.对外发布服务[3]
##### 2. 对外发布服务

创建好flink负载之后,需要像外部发布服务。

Expand Down
25 changes: 13 additions & 12 deletions content/zh/docs/vcjob.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,18 +334,19 @@ spec:

Volcano对当前主流的计算框架均能很好的支持,具体如下:

1. TensorFlow
2. Pytorch
3. MindSpore
4. PaddlePaddle
5. Spark
6. Flink
7. OpenMPI
8. Horovod
9. MXNet
10. Kubeflow
11. Argo
12. KubeGene
1. [Spark](https://spark.apache.org/)
2. [TensorFlow](https://www.tensorflow.org/)
3. [PyTorch](https://pytorch.org/)
4. [Flink](https://flink.apache.org/)
5. [Argo](https://argoproj.github.io/)
6. [MindSpore](https://www.mindspore.cn/en)
7. [PaddlePaddle](https://www.paddlepaddle.org.cn/)
8. [Open MPI](https://www.open-mpi.org/)
9. [Horovod](https://horovod.readthedocs.io/)
10. [MXNet](https://mxnet.apache.org/)
11. [Kubeflow](https://www.kubeflow.org/)
12. [KubeGene](https://github.com/volcano-sh/kubegene)
13. [Cromwell](https://cromwell.readthedocs.io/)

#### volcano和default-scheduler的选择

Expand Down
25 changes: 13 additions & 12 deletions doc/concepts/vcjob.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,18 +268,19 @@ spec:
#### 说明事项
* Volcano支持的计算框架
Volcano对当前主流的计算框架均能很好的支持,具体如下:
1. TensorFlow
2. Pytorch
3. MindSpore
4. PaddlePaddle
5. Spark
6. Flink
7. OpenMPI
8. Horovod
9. MXNet
10. Kubeflow
11. Argo
12. KubeGene
1. [Spark](https://spark.apache.org/)
2. [TensorFlow](https://www.tensorflow.org/)
3. [PyTorch](https://pytorch.org/)
4. [Flink](https://flink.apache.org/)
5. [Argo](https://argoproj.github.io/)
6. [MindSpore](https://www.mindspore.cn/en)
7. [PaddlePaddle](https://www.paddlepaddle.org.cn/)
8. [Open MPI](https://www.open-mpi.org/)
9. [Horovod](https://horovod.readthedocs.io/)
10. [MXNet](https://mxnet.apache.org/)
11. [Kubeflow](https://www.kubeflow.org/)
12. [KubeGene](https://github.com/volcano-sh/kubegene)
13. [Cromwell](https://cromwell.readthedocs.io/)
...
* Volcano Job和Kubernetes Job的选择
Volcano Job在批处理能力方面对Kubernetes Job进行了升级,更加适合机器学习、大数据、科学计算等场景,建议在高性能计算场景下选择Volcano Job;
Expand Down