Add readme & fix namespace issue

Author: TommyLike

README.md

@@ -12,6 +12,45 @@ using several systems, combined with best-of-breed ideas and practices from the
 
 ![volcano](docs/images/volcano-intro.png)
 
+## Installation
+
+The easiest way to use Volcano is to use the Helm [chart](https://github.com/helm/charts/tree/master/incubator/sparkoperator).
+
+
+### 1. Volcano Image
+Official images now are not available on DockerHub, however you can build them locally with command:
+```
+make docker
+``` 
+**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 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
+```
+Volcano introduces a helm plugin **gen-admission-secret** to generate valid cert (stored in k8s secret) for
+admission service, therefore you are required to install & execute the plugin before installing the chart.
+```
+#1. Install helm plugin
+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>
+
+#3. Install helm chart
+helm install installer/chart/volcano --namespace <namespace> --name <specified-name>
+```
+The **<specified-name>** used in the two commands above should be identical.
+
+
+
+
+
 ## Community, discussion, contribution, and support
 
 You can reach the maintainers of this project at:

installer/chart/volcano/plugins/gen-admission-secret/gen-admission-secret.sh

@@ -41,7 +41,12 @@ while [[ $# -gt 0 ]]; do
     shift
 done
 
-[ -z ${service} ] && service=volcano-admission-service
+if [ -z ${service} ]; then
+    echo "'--service' must be specified"
+    exit 1
+fi
+
+
 [ -z ${secret} ] && secret=volcano-admission-secret
 [ -z ${namespace} ] && namespace=default
 

installer/chart/volcano/templates/admission-config.yaml

@@ -9,7 +9,6 @@ webhooks:
       caBundle: ""
       service:
         name: {{ .Release.Name }}-admission-service
-        namespace: {{.Values.basic.namespace}}
         path: /jobs
     failurePolicy: Ignore
     name: validatejob.volcano.sh
@@ -36,7 +35,6 @@ webhooks:
       caBundle: ""
       service:
         name: {{ .Release.Name }}-admission-service
-        namespace: {{.Values.basic.namespace}}
         path: /mutating-jobs
     failurePolicy: Ignore
     name: mutatejob.volcano.sh

installer/chart/volcano/templates/admission.yaml

@@ -2,14 +2,12 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: {{ .Release.Name }}-admission
-  namespace: {{.Values.basic.namespace}}
 
 ---
 kind: ClusterRole
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: {{ .Release.Name }}-admission
-  namespace: {{.Values.basic.namespace}}
 rules:
   - apiGroups: [""]
     resources: ["configmaps"]
@@ -26,11 +24,9 @@ kind: ClusterRoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: {{ .Release.Name }}-admission-role
-  namespace: {{.Values.basic.namespace}}
 subjects:
   - kind: ServiceAccount
     name: {{ .Release.Name }}-admission
-    namespace: {{.Values.basic.namespace}}
 roleRef:
   kind: ClusterRole
   name: {{ .Release.Name }}-admission
@@ -44,7 +40,6 @@ metadata:
     app: admission
     admission: "true"
   name: {{ .Release.Name }}-admission
-  namespace: {{.Values.basic.namespace}}
 spec:
   replicas: 1
   selector:
@@ -89,7 +84,6 @@ metadata:
   labels:
     test: admission
   name: {{ .Release.Name }}-admission-service
-  namespace: {{.Values.basic.namespace}}
 spec:
   ports:
     - port: 443

installer/chart/volcano/templates/controllers.yaml

@@ -2,14 +2,12 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: {{ .Release.Name }}-controllers
-  namespace: {{.Values.basic.namespace}}
 
 ---
 kind: ClusterRole
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: {{ .Release.Name }}-controllers
-  namespace: {{.Values.basic.namespace}}
 rules:
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
@@ -47,12 +45,9 @@ kind: ClusterRoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: {{ .Release.Name }}-controllers-role
-  namespace: {{.Values.basic.namespace}}
 subjects:
   - kind: ServiceAccount
     name: {{ .Release.Name }}-controllers
-    # replace with non-default namespace name
-    namespace: default
 roleRef:
   kind: ClusterRole
   name: {{ .Release.Name }}-controllers
@@ -63,7 +58,6 @@ kind: Deployment
 apiVersion: apps/v1
 metadata:
   name: {{ .Release.Name }}-controllers
-  namespace: {{.Values.basic.namespace}}
 spec:
   replicas: 1
   selector:

installer/chart/volcano/templates/scheduler.yaml

@@ -2,14 +2,12 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: {{ .Release.Name }}-scheduler
-  namespace: {{.Values.basic.namespace}}
 
 ---
 kind: ClusterRole
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: {{ .Release.Name }}-scheduler
-  namespace: {{.Values.basic.namespace}}
 rules:
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
@@ -56,12 +54,9 @@ kind: ClusterRoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: {{ .Release.Name }}-scheduler-role
-  namespace: {{.Values.basic.namespace}}
 subjects:
   - kind: ServiceAccount
     name: {{ .Release.Name }}-scheduler
-    # replace with non-default namespace name
-    namespace: default
 roleRef:
   kind: ClusterRole
   name: {{ .Release.Name }}-scheduler
@@ -72,7 +67,6 @@ kind: Deployment
 apiVersion: apps/v1
 metadata:
   name: {{ .Release.Name }}-scheduler
-  namespace: {{.Values.basic.namespace}}
 spec:
   replicas: 1
   selector:

installer/chart/volcano/values.yaml

@@ -1,6 +1,5 @@
 basic:
   image_tag_version: "1.0"
-  namespace: default
   controller_image_name: "volcano-controllers"
   scheduler_image_name: "volcano-scheduler"
   admission_image_name: "volcano-admission"