fixed readme (#11660)

Signed-off-by: André Bauer <monotek23@gmail.com>
This commit is contained in:
André Bauer
2019-03-26 06:11:19 -07:00
committed by Kubernetes Prow Robot
parent 6cca367111
commit a1a7257432
2 changed files with 33 additions and 33 deletions
+1 -1
View File
@@ -1,7 +1,7 @@
apiVersion: v1
description: A Helm chart for prometheus mysql exporter with cloudsqlproxy
name: prometheus-mysql-exporter
version: 0.3.1
version: 0.3.2
home: https://github.com/prometheus/mysqld_exporter
appVersion: v0.11.0
sources:
+32 -32
View File
@@ -1,6 +1,6 @@
# Prometheus Mysql Exporter
* Installs prometheus [mysql exporter](https://github.com/prometheus/mysqld_exporter)
- Installs prometheus [mysql exporter](https://github.com/prometheus/mysqld_exporter)
## TL;DR;
@@ -17,7 +17,7 @@ This chart bootstraps a prometheus [mysql exporter](http://github.com/prometheus
To install the chart with the release name `my-release`:
```console
$ helm install --name my-release stable/prometheus-mysql-exporter --set datasource="username:password@(db:3306)/"
$ helm install --name my-release stable/prometheus-mysql-exporter --set mysql.user="username",mysql.pass="password",mysql.host="example.com",mysql.port="3306"
```
The command deploys a mysql exporter on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
@@ -36,34 +36,34 @@ The command removes all the Kubernetes components associated with the chart and
The following table lists the configurable parameters of the mysql exporter chart and their default values.
| Parameter | Description | Default |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| `replicaCount` | Amount of pods for the deployment | `1` |
| `image.repository` | Image repository | `prom/mysqld-exporter` |
| `image.tag` | Image tag | `v0.11.0` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `service.name` | Service name | `mysql-exporter` |
| `service.type` | Service type | `ClusterIP` |
| `service.externalport` | The service port | `9104` |
| `service.internalPort` | The target port of the container | `9104` |
| `resources` | CPU/Memory resource requests/limits | `{}` |
| `annotations` | pod annotations for easier discovery | `see values.yaml` |
| `collectors` | Collector configuration | `see values.yaml` |
| `podLabels` | Additional labels to add to each pod | `{}` |
| `mysql.db` | MySQL connection db (optional) | `""` |
| `mysql.host` | MySQL connection host | `localhost` |
| `mysql.param` | MySQL connection parameters (optional) | `"tcp"` |
| `mysql.pass` | MySQL connection password | `password` |
| `mysql.port` | MySQL connection port | `3306` |
| `mysql.protocol` | MySQL connection protocol (optional) | `""` |
| `mysql.user` | MySQL connection username | `exporter` |
| `cloudsqlproxy.enabled` | Flag to enable the connection using Cloud SQL Proxy | `false` |
| `cloudsqlproxy.image.repo` | Cloud SQL Proxy image repository | `gcr.io/cloudsql-docker/gce-proxy` |
| `cloudsqlproxy.image.tag` | Cloud SQL Proxy image tag | `1.11` |
| `cloudsqlproxy.image.pullPolicy` | Cloud SQL Proxy image pull policy | `IfNotPresent` |
| `cloudsqlproxy.instanceConnectionName` | Google Cloud instance connection name | `project:us-central1:dbname` |
| `cloudsqlproxy.port` | Cloud SQL Proxy listening port | `3306` |
| `cloudsqlproxy.credentials` | Cloud SQL Proxy service account credentials | `bogus credential file` |
| Parameter | Description | Default |
| -------------------------------------- | --------------------------------------------------- | ---------------------------------- |
| `replicaCount` | Amount of pods for the deployment | `1` |
| `image.repository` | Image repository | `prom/mysqld-exporter` |
| `image.tag` | Image tag | `v0.11.0` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `service.name` | Service name | `mysql-exporter` |
| `service.type` | Service type | `ClusterIP` |
| `service.externalport` | The service port | `9104` |
| `service.internalPort` | The target port of the container | `9104` |
| `resources` | CPU/Memory resource requests/limits | `{}` |
| `annotations` | pod annotations for easier discovery | `see values.yaml` |
| `collectors` | Collector configuration | `see values.yaml` |
| `podLabels` | Additional labels to add to each pod | `{}` |
| `mysql.db` | MySQL connection db (optional) | `""` |
| `mysql.host` | MySQL connection host | `localhost` |
| `mysql.param` | MySQL connection parameters (optional) | `"tcp"` |
| `mysql.pass` | MySQL connection password | `password` |
| `mysql.port` | MySQL connection port | `3306` |
| `mysql.protocol` | MySQL connection protocol (optional) | `""` |
| `mysql.user` | MySQL connection username | `exporter` |
| `cloudsqlproxy.enabled` | Flag to enable the connection using Cloud SQL Proxy | `false` |
| `cloudsqlproxy.image.repo` | Cloud SQL Proxy image repository | `gcr.io/cloudsql-docker/gce-proxy` |
| `cloudsqlproxy.image.tag` | Cloud SQL Proxy image tag | `1.11` |
| `cloudsqlproxy.image.pullPolicy` | Cloud SQL Proxy image pull policy | `IfNotPresent` |
| `cloudsqlproxy.instanceConnectionName` | Google Cloud instance connection name | `project:us-central1:dbname` |
| `cloudsqlproxy.port` | Cloud SQL Proxy listening port | `3306` |
| `cloudsqlproxy.credentials` | Cloud SQL Proxy service account credentials | `bogus credential file` |
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
@@ -79,8 +79,8 @@ Alternatively, a YAML file that specifies the values for the above parameters ca
$ helm install --name my-release -f values.yaml stable/prometheus-mysql-exporter
```
Documentation for the MySQL Exporter can be found here: (https://github.com/prometheus/mysqld_exporter)
A mysql params overview can be found here: (https://github.com/go-sql-driver/mysql#dsn-data-source-name)
Documentation for the MySQL Exporter can be found here: (<https://github.com/prometheus/mysqld_exporter>)
A mysql params overview can be found here: (<https://github.com/go-sql-driver/mysql#dsn-data-source-name>)
## Collector Flags