-
Notifications
You must be signed in to change notification settings - Fork 993
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
Update README #327
Update README #327
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: thandayuthapani The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@@ -63,7 +63,30 @@ 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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@TommyLike Done
There was a problem hiding this comment.
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.
Can you also remove the |
/cc @TommyLike |
Since volcano-sh/charts is added as submodule, we will have to clone using --recursive tag, then only we can find those files under installer/helm directory |
It's a submodule |
906c935
to
a17c3a0
Compare
|
||
### Download Helm | ||
|
||
Install helm by following official guide - https://github.com/helm/helm/blob/master/docs/install.md |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Travis tests have failedHey @thandayuthapani, TravisBuddy Request Identifier: 0deba470-a3d1-11e9-8928-81693ac37660 |
/retest |
Travis tests have failedHey @thandayuthapani, TravisBuddy Request Identifier: 31b89a80-a3e9-11e9-8928-81693ac37660 |
/lgtm Since this is a bug fix, should be in ASAP. But we should make a install improvement later @thandayuthapani . |
Fixed finding preemptee jobs issue.
Please update README according to #334 :) |
According to the latest response from end user, I guess we need to add some prerequisites for installing volcano in order to reduce confusion. For example, from what I have tested on my environments, we have this requirement at least:
Why: Since we enabled subresource in our CRDs, end user will have this issue when using elder version: Free feel to add more prerequisites |
@TommyLike CRD status could be enabled manually since v1.10(https://blog.openshift.com/kubernetes-custom-resources-grow-up-in-v1-10/). |
Also golang version, should be at least 1.11+, because we use go module. |
@hex108 Hmm, so that is another requirement since we need the feature on? |
New changes are detected. LGTM label has been removed. |
Updated |
### 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 | ||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
I think with #344, the install guide in this readme can be removed, and just add a link to |
so where's the yaml file? |
The yaml generate should be a step, it is with default options and new images built. |
Since we have different concerns on this section, I drafted the install section with the latest process of installing. @k82cn @thandayuthapani @hzxuzhonghu please take a look and share your idea. =============================================================== Quick Start GuidePrerequisites
Install release from githubThe easiest way to install volcano is to use release yaml, please refer to the README file inside release folder after Install release from helm repoWe also support helm chart, install with the command below
NOTE: Install from source code
Install verifyTo verify your installation run the following commands:
|
As install guide is very long, i suggest moving it to docs repo and link it here. |
@TommyLike @hzxuzhonghu , can you summary current status about installation? I'm lost in your PR and discussion, and I don-t know when it'll be finished :( |
@thandayuthapani: PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Add steps to download helm and setup helm with appropriate serviceaccount
For Issue: #310
#310 (comment)