|
| 1 | +# vshnmariadb |
| 2 | + |
| 3 | +  |
| 4 | + |
| 5 | +A Helm chart for MariaDB instances using the mariadb-operator |
| 6 | + |
| 7 | +## Installation |
| 8 | + |
| 9 | +```bash |
| 10 | +helm repo add appcat https://charts.appcat.ch |
| 11 | +helm install vshnmariadb vshn/vshnmariadb |
| 12 | +``` |
| 13 | +<!--- |
| 14 | +The README.md file is automatically generated with helm-docs! |
| 15 | +
|
| 16 | +Edit the README.gotmpl.md template instead. |
| 17 | +--> |
| 18 | + |
| 19 | +## Introduction |
| 20 | + |
| 21 | +This helm chart is used to deploy mariadb instances using the [mariadb-operator](https://github.com/mariadb-operator/mariadb-operator). |
| 22 | + |
| 23 | +## Configuration |
| 24 | + |
| 25 | +The following table lists the configurable parameters chart. For default values and examples, consult `values.yaml`. |
| 26 | + |
| 27 | +### Generic parameters |
| 28 | +| Parameter | Description | Default |
| 29 | +|--- | --- | --- |
| 30 | +| `image` | Image name to be used by the MariaDB instances. The supported format is <image>:<tag>. |
| 31 | +Only MariaDB official images are supported. | |
| 32 | +| `replicas` | Number of replicas to deploy | 3 |
| 33 | +| `myCnf` | Custom MariaDB configuration | "" |
| 34 | +| `storage.size` | PVC size of the instance | 1Gi |
| 35 | +| `resources` | Resources describes the compute resource requirements. | |
| 36 | +| `rootPasswordSecretKeyRef` | Reference to the secret containing the root password | |
| 37 | + |
| 38 | +### Galera |
| 39 | + |
| 40 | +| Parameter | Description | Default |
| 41 | +|--- | --- | --- |
| 42 | +| `galera.enabled` | If galera should be enabled | true |
| 43 | +| `galera.config.resuseStorageVolume` | ReuseStorageVolume indicates that storage volume used by MariaDB should be reused to store the Galera configuration files. | true |
| 44 | +| `galera.providerOptions` | ProviderOptions is map of Galera configuration parameters. [More info]( https://mariadb.com/kb/en/galera-cluster-system-variables/#wsrep_provider_options). | `{'gcs.fc_single_primary': yes', 'cert.log_conflicts': 'yes'}` |
| 45 | + |
| 46 | +### Metrics |
| 47 | + |
| 48 | +| Parameter | Description | Default |
| 49 | +| --- | --- | --- |
| 50 | +| `metrics.enabled` | Enabled is a flag to enable Metrics | true |
| 51 | +| `exporter.image` | Image name to be used as metrics exporter. The supported format is <image>:<tag>. | |
| 52 | + |
| 53 | +<!--- |
| 54 | +Common/Useful Link references from values.yaml |
| 55 | +--> |
| 56 | +[resource-units]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes |
| 57 | +[prometheus-operator]: https://github.com/coreos/prometheus-operator |
0 commit comments