Refs ScientaNL#35: Update README.md with helm install options.

README.md

@@ -26,6 +26,39 @@ use the following command to use the statefulset in kubernetes
 ```
 kubectl create -f ./k8s/proxysql.statefulset.yaml
 ``` 
+
+## Helm Install
+
+You can install using the helm repository using the following command:
+
+```bash
+helm install --name db-proxy deploy/charts/proxysql-cluster 
+```
+
+| Parameter | Description | Default |
+|----|-----------|-------------|
+| `image.repository` | `proxysql` image repo | `scienta/k8s-proxysql-cluster` |
+| `image.tag` | `proxysql` image tag | `1.0.0` |
+| `numReplicas` | Number of replicas to create in StatefulSet | `3` |
+| `proxysql.admin.username` | Admin username for `proxysql` | `admin` |
+| `proxysql.admin.password` | Admin password for `proxysql` | `admin` |
+| `proxysql.admin.iface` | Listen network for `proxysql` service | `0.0.0.0` |
+| `proxysql.admin.port` | Listen port for `proxysql` service | `6032` |
+| `proxysql.clusterAdmin.username` | Cluster user username used by `proxysql` nodes to sync | `cluster1` |
+| `proxysql.clusterAdmin.password` | Cluster user password used by `proxysql` nodes to sync | `secret1pass` |
+| `proxysql.queryCacheSizeMb` | (Optional) Query cache size | `nil` |
+| `proxysql.dataDir` | Directory to store `proxysql` tables, etc. | `/var/lib/proxysql` |
+| `proxysql.webEnabled` | Enable `proxysql` web dashboard | `true` |
+| `mysql.iface` | Listen network for `mysql` service connections | `0.0.0.0` |
+| `mysql.port` | Listen port fo `mysql` service connections | `3306` |
+| `mysql.monitor.username` | Monitor username on MySQL instances for `proxysql` health checks | `monitor` |
+| `mysql.monitor.password` | Monitor password on MySQL instances for `proxysql` health checks | `monitor` |
+| `mysql.admin.username` | Root / admin username on MySQL instances | `root` |
+| `mysql.admin.password` | Root / admin password on MySQL instances | `insecurepassword` |
+| `cronjob.enabled` | Enable k8s `CronJob` to sync `proxysql` configurations | `false` |
+| `resources` | CPU / Memory Limits and Requests | `{}` |
+| `tolerations` | Pod tolerations | '{}' |
+
 ## Workings
 When the container is run with the --k8s-cluster argument the following happens:
 - the container checks if there is a node available at the proxysql service

deploy/charts/proxysql-cluster/README.md

@@ -4,4 +4,4 @@
 
 Set up [ProxySql](http://www.proxysql.com) in a cluster configuration.
 
-See `values.yaml` for configuration details.
+See `values.yaml` for configuration details.

deploy/charts/proxysql-cluster/templates/statefulset.yaml

@@ -22,7 +22,7 @@ spec:
  spec:
  restartPolicy: Always
  containers:
- - image: {{ .Values.image | quote }}
+ - image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
  name: proxysql
  imagePullPolicy: "Always"
  ports:

deploy/charts/proxysql-cluster/templates/sync-cronjob.yaml

@@ -17,7 +17,7 @@ spec:
  restartPolicy: OnFailure
  containers:
  - name: proxysql-sync
- image: {{ .Values.image | quote }}
+ image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
  imagePullPolicy: Always
  args: ["--sync"]
  env:

deploy/charts/proxysql-cluster/values.yaml

@@ -1,7 +1,9 @@
 # values.yaml
 
 # Docker image to use for deployment
-image: "scienta/k8s-proxysql-cluster:1.0.0"
+image:
+ repository: "scienta/k8s-proxysql-cluster"
+ tag: "1.0.0"
 
 # Default number of ProxySQL replicas
 numReplicas: 3
@@ -18,7 +20,7 @@ proxysql:
  username: cluster1
  password: secret1pass
  # Query Cache Size
- queryCacheSizeMb: 256
+ # queryCacheSizeMb: 256
  # ProxySQL needs a cluster name
  dataDir: "/var/lib/proxysql"
  webEnabled: true