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

Improve Quick Start Guide & update docker image repo #70

Merged
merged 1 commit into from
Apr 7, 2019
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
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BIN_DIR=_output/bin
IMAGE=volcano
TAG = 0.1
IMAGE=volcanosh/volcano
TAG = latest

.EXPORT_ALL_VARIABLES:

Expand Down
42 changes: 31 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,33 +47,43 @@ the open source community.

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

## Installation
## Quick Start Guide

The easiest way to use Volcano is to use the Helm chart.
The easiest way to deploy Volcano is to use the Helm chart.

### Pre-requisites

First of all, clone the repo to your local path:

```
# mkdir -p $GOPATH/src/volcano.sh/
# cd $GOPATH/src/volcano.sh/
# git clone https://github.com/volcano-sh/volcano.git
```

### 1. Volcano Image

Official images are not yet available on DockerHub, however you can
Official images are available on [DockerHub](https://hub.docker.com/u/volcanosh), however you can
build them locally with the command:

```
cd $GOPATH/src/volcano.sh/volcano
make docker

## Verify your images
# docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
volcanosh/volcano-admission latest a83338506638 8 seconds ago 41.4MB
volcanosh/volcano-scheduler latest faa3c2a25ac3 9 seconds ago 49.6MB
volcanosh/volcano-controllers latest 7b11606ebfb8 10 seconds ago 44.2MB

```

**NOTE**: 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),
try command ```kind load docker-image <image-name>:<tag> ``` for each of the images.

### 2. Helm charts
First of all, clone the repo to your local path:

```
# mkdir -p $GOPATH/src/volcano.sh/
# cd $GOPATH/src/volcano.sh/
# git clone https://github.com/volcano-sh/volcano.git
```

Second, install the required helm plugin and generate valid
certificate, volcano uses a helm plugin **gen-admission-secret** to
generate certificate for admission service to communicate with
Expand All @@ -85,12 +95,22 @@ helm plugin install installer/chart/volcano/plugins/gen-admission-secret

#2. Generate secret within service name
helm gen-admission-secret --service <specified-name>-admission-service --namespace <namespace>

## For eg:
kubectl create namespace volcano-trial

helm gen-admission-secret --service volcano-trial-admission-service --namespace volcano-trial

```

Finally, install helm chart.

```
helm install installer/chart/volcano --namespace <namespace> --name <specified-name>

For eg :
helm install installer/chart/volcano --namespace volcano-trial --name volcano-trial

```

**NOTE**:The ```<specified-name>``` used in the two commands above should be identical.
Expand Down
8 changes: 4 additions & 4 deletions installer/chart/volcano/values.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
basic:
image_tag_version: "1.0"
controller_image_name: "volcano-controllers"
scheduler_image_name: "volcano-scheduler"
admission_image_name: "volcano-admission"
image_tag_version: "latest"
controller_image_name: "volcanosh/volcano-controllers"
scheduler_image_name: "volcanosh/volcano-scheduler"
admission_image_name: "volcanosh/volcano-admission"
admission_secret_name: "volcano-admission-secret"
image_pull_secret: ""