Update/Add fission-core & fission-all helm charts (#239)

Improve fission helm chart; split it into "fission core" and "fission all". fission-core is the minimal install, and fission-all will have all the bells and whistles. * Update/Add fission-core & fission-all helm charts * Fix incompatible types for comparison * Add message queue trigger * Rename openshiftRBAC to openshift * Update documentation & comments * Fix logger & kubewatcher failed to access kubernetes resource due to RBAC
2017-07-31 14:10:26 -07:00
parent 85983c91cd
commit 37aa266a4d
19 changed files with 1050 additions and 20 deletions
@@ -0,0 +1,80 @@
+# Fission
+
+[Fission](http://fission.io/) is a framework for serverless functions on Kubernetes.
+
+
+## Prerequisites
+
+- Kubernetes 1.6+ with Beta APIs enabled
+
+
+## Helm charts
+
+The following table lists two helm charts for Fission.
+
+| Parameter      | Description                                                                            |
+| ---------------| ---------------------------------------------------------------------------------------|
+| `fission-core` | FaaS essentials, and triggers for HTTP, Timers and Kubernetes Watches                  |
+| `fission-all`  | Log aggregation with fluentd and InfluxDB; NATS for message queue triggers; Fission-UI |
+
+## Installing the chart
+
+To install the chart with the release name `my-release`,
+
+```bash
+$ helm install --name my-release fission-all
+```
+
+## Uninstalling the chart
+
+To uninstall/delete chart,
+
+```bash
+$ helm delete my-release
+```
+
+## Configuration
+
+The following table lists the configurable parameters of the Fission chart and their default values.
+
+| Parameter           | Description                                | Default                  |
+| ------------------- | ------------------------------------------ | ------------------------ |
+| `serviceType`       | Type of service to use                     | `LoadBalancer`.          |
+| `image`             | Fission image                              | `fission/fission-bundle` |
+| `imageTag`          | Fission image tag                          | `alpha20170124`          |
+| `controllerPort`    | Fission Controller Service Port            | `31313`                  |
+| `routerPort`        | Fission Router Service Port                | `31314`                  |
+| `functionNamespace` | Namespace for Fission functions            | `fission-function`       |
+| `openshift`         | RBAC for openshift                         | `false`                  |
+
+
+* Extra configuration for `fission-all`
+
+| Parameter              | Description                 | Default                    |
+| ---------------------- | --------------------------- | -------------------------- |
+| `logger.influxdbAdmin` | Log database admin username | `admin`.                   |
+| `logger.fluentdImage`  | Logger fluentd image        | `fission/fluentd`          |
+| `fissionUiImage`       | Fission ui image            | `fission/fission-ui:0.1.0` |
+| `nats.authToken`       | Nats streaming auth token   | `defaultFissionAuthToken`  |
+| `nats.clusterID`       | Nats streaming clusterID    | `fissionMQTrigger`         |
+
+
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
+
+```bash
+$ helm install --name my-release --set image=custom/fission-bundle,imageTag=v1 fission-all
+```
+
+If you're using minikube, set serviceType to NodePort:
+
+```bash
+$ helm install --name my-release --set serviceType=NodePort fission-all
+```
+
+You can also set parameters with a yaml file (see values.yaml for
+what it should look like):
+
+```bash
+$ helm install --name my-release -f values.yaml fission-all
+```