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.

Sign up for GitHub

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

Update README #327

Closed
wants to merge 1 commit into from
Closed

Update README #327

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 29 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,33 @@ You can watch industry experts talking about Volcano in different International

The easiest way to deploy Volcano is to use the Helm chart. Volcano can be deployed by cloning code and also by adding helm repo.

## Using Volcano Helm Repo
## Install Helm
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about make this under quick start guide and change it to Install Volcano?

Copy link
Contributor

@TommyLike TommyLike Jul 11, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not we provide the helm document link here and note about the RBAC issues.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TommyLike Sure, will change that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TommyLike Done

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's better to highlight chart version/branch if using volcano/chart. We're going to update master when releasing.


### Download Helm

Install helm by following official guide - https://github.com/helm/helm/blob/master/docs/install.md
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is too complicated, as a newer, he would not want to install A, and then B, before actually install volcano, i would prefer moving this to a simple scripts.

No one like complicated thing. If possible, can we remove dependency on helm totally？ @k82cn @TommyLike

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hzxuzhonghu maybe you can bring the practice from istio?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm ok with that. IMO, it's complex because of security, e.g. RBAC; maybe we can provide a quick guidance which ignore security to make it simpler.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI:
istio provides a generated istio-demo.yaml, which allows users to install easily(https://istio.io/docs/setup/kubernetes/install/kubernetes/). And also provides helm install https://istio.io/docs/setup/kubernetes/install/helm/.

And when it comes to kubernetes, we can run ./hack/local-ip-cluster.sh to start a cluster for developing and testing.


### Setup Helm

Since Tiller needs cluster-admin RBAC access, create `ServiceAccount` and `ClusterRoleBinding` by following the offical guide - https://github.com/helm/helm/blob/master/docs/rbac.md

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's give an example here; I don-t think a new user will go through the whole doc of rbac for volcano installation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! Will add step to add serviceaccount creation and such

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@k82cn Have added steps to create serviceaccount and clusterrolebinding for tiller in README

Copy link
Member

@k82cn k82cn Jul 16, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm... if the following steps about serviceaccount is the correct final solution, why do we need helm rbac installation guidance? If it's only an example, please highlight that.


Create `ServiceAccount` and `ClusterRoleBinding` for tiller
```bash
kubectl create serviceaccount --namespace kube-system tiller
kubectl create clusterrolebinding tiller-cluster-rule --clusterrole=cluster-admin --serviceaccount=kube-system:tiller
```

Then `helm init` using created `ServiceAccount`

```bash
helm init --service-account <ServiceAccountName> --kubeconfig ${KUBECONFIG} --wait

e.g :
helm init --service-account tiller --kubeconfig ${KUBECONFIG} --wait
```

## 1. Using Volcano Helm Repo

Add helm repo using following command,

Expand All @@ -80,15 +106,15 @@ e.g :
helm install volcano/volcano --namespace volcano-trial --name volcano-trial
```

## Cloning Code
## 2. Cloning Code
### 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 --recursive https://github.com/volcano-sh/volcano.git
# git clone https://github.com/volcano-sh/volcano.git
```

### 1. Volcano Image
Expand Down