Skip to content

Commit

Permalink
Merge pull request #342 from kevin-wangzefeng/readme
Browse files Browse the repository at this point in the history
add slack invitation to project readme
  • Loading branch information
volcano-sh-bot authored Jul 15, 2019
2 parents fd3cf10 + 9598337 commit 48c6021
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Volcano is a batch system built on Kubernetes. It provides a suite of mechanisms
Kubernetes that are commonly required by many classes of batch & elastic workload including:

1. machine learning/deep learning,
2. bioinformatics/genomics
2. bioinformatics/genomics
3. other "big data" applications.

These types of applications typically run on generalized domain
frameworks like Tensorflow, Spark, PyTorch, MPI, etc, which Volcano integrates with.
frameworks like TensorFlow, Spark, PyTorch, MPI, etc, which Volcano integrates with.

Some examples of the mechanisms and features that Volcano adds to Kubernetes are:

Expand All @@ -37,7 +37,7 @@ Some examples of the mechanisms and features that Volcano adds to Kubernetes are
5. Reservations and backfills
6. Topology-based scheduling
3. Runtime extensions, e.g:
1. Support for specialized continer runtimes like Singularity,
1. Support for specialized container runtimes like Singularity,
with GPU accelerator extensions and enhanced security features.
4. Other
1. Data locality awareness and intelligent scheduling
Expand Down Expand Up @@ -79,7 +79,7 @@ helm install volcano/volcano --namespace <namespace> --name <specified-name>
e.g :
helm install volcano/volcano --namespace volcano-trial --name volcano-trial
```

## Cloning Code
### Pre-requisites

Expand All @@ -103,15 +103,15 @@ make images
## Verify your images
# docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
volcanosh/vc-admission latest a83338506638 8 seconds ago 41.4MB
volcanosh/vc-scheduler latest faa3c2a25ac3 9 seconds ago 49.6MB
volcanosh/vc-controllers latest 7b11606ebfb8 10 seconds ago 44.2MB
volcanosh/vc-admission latest a83338506638 8 seconds ago 41.4MB
volcanosh/vc-scheduler latest faa3c2a25ac3 9 seconds ago 49.6MB
volcanosh/vc-controllers latest 7b11606ebfb8 10 seconds ago 44.2MB
```
```

**NOTE**:
1. You need ensure the images are correctly loaded in your kubernetes cluster, for
example, if you are using [kind cluster](https://github.com/kubernetes-sigs/kind),
example, if you are using [kind cluster](https://github.com/kubernetes-sigs/kind),
try command ```kind load docker-image <image-name>:<tag> ``` for each of the images.
2. When reinstall the volcano charts, since tiller server will not manage CRD resource,
you need to delete them manually eg: `kubectl delete crds xxxx` before reinstalling or try command with `--no-crd-hook` option.
Expand All @@ -132,15 +132,15 @@ To verify your installation run the following commands:

```
#1. Verify the Running Pods
# kubectl get pods --namespace <namespace>
NAME READY STATUS RESTARTS AGE
# kubectl get pods --namespace <namespace>
NAME READY STATUS RESTARTS AGE
<specified-name>-admission-84fd9b9dd8-9trxn 1/1 Running 0 43s
<specified-name>-controllers-75dcc8ff89-42v6r 1/1 Running 0 43s
<specified-name>-scheduler-b94cdb867-89pm2 1/1 Running 0 43s
<specified-name>--admission-init-qbtmb 0/1 Completed 0 43s
#2. Verify the Services
# kubectl get services --namespace <namespace>
# kubectl get services --namespace <namespace>
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
<specified-name>-admission-service ClusterIP 10.105.78.53 <none> 443/TCP 91s
Expand All @@ -151,7 +151,9 @@ NAME TYPE CLUSTER-IP EXTERNAL-IP

You can reach the maintainers of this project at:

Slack: [#volcano-sh](http://t.cn/Efa7LKx)
Slack: [#volcano-sh](volcano-slack). (Signup [here](slack-invitation)).

Mailing List: https://groups.google.com/forum/#!forum/volcano-sh

[volcano-slack]: https://volcano-sh.slack.com
[slack-invitation]: https://join.slack.com/t/volcano-sh/shared_invite/enQtNTU5NTU3NDU0MTc4LTgzZTQ2MzViNTFmNDg1ZGUyMzcwNjgxZGQ1ZDdhOGE3Mzg1Y2NkZjk1MDJlZTZhZWU5MDg2MWJhMzI3Mjg3ZTk

0 comments on commit 48c6021

Please sign in to comment.