Nail/fission-src
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve helm charts README (#1064)

Browse Source
This commit is contained in:
Chia-Chun Tai
2019-01-26 02:05:08 +08:00
committed by Ta-Ching Chen
parent 101e188f41
commit b5b689973b
3 changed files with 70 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
charts/README.md
+48 -29
View File
@@ -5,7 +5,7 @@
## Prerequisites ## Prerequisites
- Kubernetes 1.8 or later - Kubernetes 1.6 or later
## Helm charts ## Helm charts
@@ -37,36 +37,55 @@ $ helm delete my-release
The following table lists the configurable parameters of the Fission chart and their default values. The following table lists the configurable parameters of the Fission chart and their default values.
| Parameter | Description | Default | Parameter | Description | Default
| ------------------- | ------------------------------------------ | ------------------------ | --------- | ----------- | -------
| `serviceType` | Type of service to use | `LoadBalancer` | `serviceType` | Type of Fission Controller service to use. For minikube, set this to NodePort, elsewhere use LoadBalancer or ClusterIP. | `ClusterIP`
| `image` | Fission image | `fission/fission-bundle` | `routerServiceType` | Type of Fission Router service to use. For minikube, set this to NodePort, elsewhere use LoadBalancer or ClusterIP. | `LoadBalancer`
| `imageTag` | Fission image tag | `alpha20170124` | `repository` | Image base repository | `index.docker.io`
| `fetcherImage` | Fission fetcher image | `fission/fetcher` | `image` | Fission image repository | `fission/fission-bundle`
| `fetcherImageTag` | Fission fetcher image tag | `latest` | `imageTag` | Fission image tag | `1.0-rc2`
| `controllerPort` | Fission Controller Service Port | `31313` | `pullPolicy` | Image pull policy | `IfNotPresent`
| `routerPort` | Fission Router Service Port | `31314` | `fetcherImage` | Fission fetcher repository | `fission/fetcher`
| `functionNamespace` | Namespace for Fission functions | `fission-function` | `fetcherImageTag` | Fission fetcher image tag | `1.0-rc2`
| `builderNamespace` | Namespace for Fission environment builders | `fission-builder` | `controllerPort` | Fission Controller service port | `31313`
`routerPort` | Fission Router service port | ` 31314`
`functionNamespace` | Namespace in which to run fission functions (this is different from the release namespace) | `fission-function`
`builderNamespace` | Namespace in which to run fission builders (this is different from the release namespace) | `fission-builder`
`enableIstio` | Enable istio integration | `false`
`persistence.enabled` | If true, persist data to a persistent volume | `true`
`persistence.existingClaim` | Provide an existing PersistentVolumeClaim instead of creating a new one | `nil`
`persistence.storageClass` | PersistentVolumeClaim storage class | `nil`
`persistence.accessMode` | PersistentVolumeClaim access mode | `ReadWriteOnce`
`persistence.size` | PersistentVolumeClaim size | `8Gi`
`analytics` | Analytics let us count how many people installed fission. Set to false to disable analytics | `true`
`analyticsNonHelmInstall` | Internally used for generating an analytics job for non-helm installs | `false`
`pruneInterval` | The frequency of archive pruner (in minutes) | `60`
`preUpgradeChecksImage` | Fission pre-install/pre-upgrade checks live in this image | `fission/pre-upgrade-checks`
`debugEnv` | If there are any pod specialization errors when a function is triggered and this flag is set to true, the error summary is returned as part of http response | `true`
`prometheusDeploy` | Set to true if prometheus needs to be deployed along with fission | `true` in `fission-all`, `false` in `fission-core`
`canaryDeployment.enabled` | Set to true if you need canary deployment feature | `true` in `fission-all`, `false` in `fission-core`
### Extra configuration for `fission-all` ### Extra configuration for `fission-all`
| Parameter | Description | Default | Parameter | Description | Default
| ------------------------------- | --------------------------- | ---------------------------------------------------------- | --------- | ----------- | -------
| `logger.influxdbAdmin` | Log database admin username | `admin` | `createNamespace` | If true, create `fission-function` and `fission-builder` namespaces | ` true`
| `logger.fluentdImage` | Logger fluentd image | `fission/fluentd` | `logger.influxdbAdmin` | Log database admin username | `admin`
| `fissionUiImage` | Fission ui image | `fission/fission-ui:0.1.0` | `logger.fluentdImage` | Logger fluentd image | `fission/fluentd`
| `nats.enabled` | Nats streaming enabled | `true` | `logger.fluentdImageTag` | Fission ui image tag | `1.0-rc2`
| `nats.authToken` | Nats streaming auth token | `defaultFissionAuthToken`(required if `nats.enabled` is `true`) | `nats.enabled` | Nats streaming enabled | `true`
| `nats.clusterID` | Nats streaming clusterID | `fissionMQTrigger`(required if `nats.enabled` is `true`) | `nats.authToken` | Nats streaming auth token | `defaultFissionAuthToken`
| `azureStorageQueue.enabled` * | Azure storage account name | `false` | `nats.clusterID` | Nats streaming clusterID | `fissionMQTrigger`
| `azureStorageQueue.accountName` | Azure storage account name | `None` (required if `azureStorageQueue.enabled` is `true`) | `natsStreamingPort` | Nats streaming service port | `31316`
| `azureStorageQueue.key` | Azure storage access key | `None` (required if `azureStorageQueue.enabled` is `true`) | `azureStorageQueue.enabled` | Azure storage account name | `false`
| `kafka.enabled` * | Kafka trigger enabled | `false` | `azureStorageQueue.key` | Azure storage account name | `""`
| `kafka.brokers` | Kafka brokers uri | `broker.kafka:9092` (required if `kafka.enabled` is `true`) | `azureStorageQueue.accountName` | Azure storage access key | `""`
| `kafka.version` | Kafka broker version | `None` (should be `>= 0.11.0.0` to enable Kafka record headers support) | `kafka.enabled` | Kafka trigger enabled | `false`
`kafka.brokers` | Kafka brokers uri | `broker.kafka:9092`
`kafka.version` | Kafka broker version | `nil`
`heapster` | Enable Heapster (only enable this in clusters where heapster does not exist already) | `false`
* - Please note that deploying of Azure Storage Queue or Kafka is not done by Fission chart and you will have to explicitly deploy them. Please note that deploying of Azure Storage Queue or Kafka is not done by Fission chart and you will have to explicitly deploy them.
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
@@ -74,10 +93,10 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm
$ helm install --name my-release --set image=custom/fission-bundle,imageTag=v1 fission-all $ helm install --name my-release --set image=custom/fission-bundle,imageTag=v1 fission-all
``` ```
If you're using minikube, set serviceType to NodePort: If you're using minikube, set serviceType and routerServiceType to NodePort:
```bash ```bash
$ helm install --name my-release --set serviceType=NodePort fission-all $ helm install --name my-release --set serviceType=NodePort,routerServiceType=NodePort fission-all
``` ```
You can also set parameters with a yaml file (see [values.yaml](fission-all/values.yaml) for You can also set parameters with a yaml file (see [values.yaml](fission-all/values.yaml) for
charts/fission-all/values.yaml
+11
View File
@@ -80,7 +80,17 @@ kafka:
## Persist data to a persistent volume. ## Persist data to a persistent volume.
persistence: persistence:
## If true, fission will create/use a Persistent Volume Claim
## If false, use emptyDir
##
enabled: true enabled: true
## A manually managed Persistent Volume Claim name
## Requires persistence.enabled: true
## If defined, PVC must be created manually before volume will be bound
##
# existingClaim:
## If defined, storageClassName: <storageClass> ## If defined, storageClassName: <storageClass>
## If set to "-", storageClassName: "", which disables dynamic provisioning ## If set to "-", storageClassName: "", which disables dynamic provisioning
## If undefined (the default) or set to null, no storageClassName spec is ## If undefined (the default) or set to null, no storageClassName spec is
@@ -88,6 +98,7 @@ persistence:
## GKE, AWS & OpenStack) ## GKE, AWS & OpenStack)
## ##
# storageClass: "-" # storageClass: "-"
accessMode: ReadWriteOnce accessMode: ReadWriteOnce
size: 8Gi size: 8Gi
charts/fission-core/values.yaml
+11
View File
@@ -46,7 +46,17 @@ enableIstio: false
## Persist data to a persistent volume. ## Persist data to a persistent volume.
persistence: persistence:
## If true, fission will create/use a Persistent Volume Claim
## If false, use emptyDir
##
enabled: true enabled: true
## A manually managed Persistent Volume Claim name
## Requires persistence.enabled: true
## If defined, PVC must be created manually before volume will be bound
##
# existingClaim:
## If defined, storageClassName: <storageClass> ## If defined, storageClassName: <storageClass>
## If set to "-", storageClassName: "", which disables dynamic provisioning ## If set to "-", storageClassName: "", which disables dynamic provisioning
## If undefined (the default) or set to null, no storageClassName spec is ## If undefined (the default) or set to null, no storageClassName spec is
@@ -54,6 +64,7 @@ persistence:
## GKE, AWS & OpenStack) ## GKE, AWS & OpenStack)
## ##
# storageClass: "-" # storageClass: "-"
accessMode: ReadWriteOnce accessMode: ReadWriteOnce
size: 8Gi size: 8Gi