vnfs/DAaaS/operator/charts/sparkoperator/README.md

   1 ### Helm Chart for Spark Operator
   2
   3 This is the Helm chart for the [Spark-on-Kubernetes Operator](https://github.com/GoogleCloudPlatform/spark-on-k8s-operator).
   4
   5 #### Prerequisites
   6
   7 The Operator requires Kubernetes version 1.8 and above because it relies on garbage collection of custom resources. If customization of driver and executor pods (through mounting custom ConfigMaps and volumes) is desired, then the [Mutating Admission Webhook](https://github.com/GoogleCloudPlatform/spark-on-k8s-operator/blob/master/docs/quick-start-guide.md#using-the-mutating-admission-webhook) needs to be enabled and it only became beta in Kubernetes 1.9.
   8
   9 #### Installing the chart
  10
  11 The chart can be installed by running:
  12
  13 ```bash
  14 $ helm repo add incubator http://storage.googleapis.com/kubernetes-charts-incubator
  15 $ helm install incubator/sparkoperator --namespace spark-operator
  16 ```
  17
  18 Note that you need to use the `--namespace` flag during `helm install` to specify in which namespace you want to install the operator. The namespace can be existing or not. When it's not available, Helm would take care of creating the namespace. Note that this namespace has no relation to the namespace where you would like to deploy Spark jobs (i.e. the setting `sparkJobNamespace` shown in the table below). They can be the same namespace or different ones.
  19
  20 #### Configuration
  21
  22 The following table lists the configurable parameters of the Spark operator chart and their default values.
  23
  24 | Parameter                 | Description                                                  | Default                                |
  25 | ------------------------- | ------------------------------------------------------------ | -------------------------------------- |
  26 | `operatorImageName`       | The name of the operator image                               | `gcr.io/spark-operator/spark-operator` |
  27 | `operatorVersion`         | The version of the operator to install                       | `v2.4.0-v1beta1-latest`               |
  28 | `imagePullPolicy`         | Docker image pull policy                                     | `IfNotPresent`                         |
  29 | `sparkJobNamespace`       | K8s namespace where Spark jobs are to be deployed            | `default`                              |
  30 | `enableWebhook`           | Whether to enable mutating admission webhook                 | false                                   |
  31 | `enableMetrics`           | Whether to expose metrics to be scraped by Premetheus        | true                                   |
  32 | `controllerThreads`       | Number of worker threads used by the SparkApplication controller | 10                                     |
  33 | `ingressUrlFormat` | Ingress URL format | "" |
  34 | `installCrds`             | Whether to install CRDs                                      | true                                   |
  35 | `metricsPort`             | Port for the metrics endpoint                                | 10254                                  |
  36 | `metricsEndpoint`         | Metrics endpoint                                             | "/metrics"                             |
  37 | `metricsPrefix`           | Prefix for the metrics                                       | ""                                     |
  38 | `resyncInterval`          | Informer resync interval in seconds                          | 30                                     |
  39 | `webhookPort`             | Service port of the webhook server                           | 8080                                   |
  40
  41 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
  42