Attention: Deprecation notice for Bintray, JCenter, GoCenter and ChartCenter. Learn More

ibm-charts/ibm-galera-mariadb-dev

Chart version: 1.1.0
Api version: v1
App version: n/a
Galera Cluster is a multi-master solution for MariaDB which pro...
application
Chart Type
Active
Status
Apache-2.0
License
1034
Downloads
https://raw.githubusercontent.com/IBM/charts/master/repo/stable
Set me up:
helm repo add center https://repo.chartcenter.io
Install Chart:
helm install ibm-galera-mariadb-dev center/ibm-charts/ibm-galera-mariadb-dev
Versions (0)

MariaDB Galera Cluster

MariaDB is one of the most popular database servers in the world. It’s made by the original developers of MySQL and guaranteed to stay open source. Notable users include Wikipedia, Facebook and Google.

Galera Cluster is a multi-master solution for MariaDB which provides an easy-to-use, high-availability solution for MariaDB based databases.

Introduction

This chart bootstraps a MariaDB Galera Cluster deployment on a Kubernetes cluster using the Helm package manager.

Chart Details

This chart creates:

  • StatefulSet of a multiple MariaDB databases with Galera clustering
  • Service to expose the nodes of the StatefulSet to the Kubernetes cluster
  • Secret to store database credentials

Prerequisites

  • Kubernetes 1.7+ with Beta APIs enabled
  • Tiller 2.7.2 or later
  • The host servers need to support /etc/localtime for the databases to have accurate times within the cluster
  • PersistentVolume Provisioner support in the underlying infrastructure or manually created Persistent Volumes

Resources Required

The chart deploys pods consuming minimum resources as specified in the resources configuration parameter (default: Memory: 256Mi, CPU: 250m)

Installing the Chart

This deploys MariaDB with Galera Cluster on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

To install the chart with the release name my-release:

helm install --name my-release stable/ibm-galera-mariadb-dev

After the command runs, it will print the current status of the release and extra information such as how to access the RabbitMQ admin console with a browser.

Tip: List all releases using helm list

Verifying the Chart

See NOTES.txt associated with this chart for verification instructions

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm delete --purge my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the MariaDB chart and their default values.

Parameter Description Default
arch.amd64 Preference to run on amd64 architecture 2 - No preference
arch.ppc64le Preference to run on ppc64le architecture 2 - No preference
image.repository Docker image repository ibmcom/galera-mariadb
image.tag Docker image tag 10.2.14
image.pullPolicy Image pull policy IfNotPresent
mariadb.rootPassword Password for the root user. random 16 character alphanumeric string
mariadb.user Username of new user to create. ""
mariadb.password Password for the new user. ""
mariadb.database Name for new database to create. ""
mariadb.configMapName Name of a ConfigMap containing a my_extra.cnf ""
replicas.replicaCount Number of replicas to deploy 3
persistence.enabled Use a PVC to persist data true
persistence.useDynamicProvisioning Use dynamic provisioning for all volumes true
dataPVC.storageClassName Storage class of dynamic provisioning ""
dataPVC.selector.label Refine the binding process if not using dynamic provisioning with the name of a label to search for ""
dataPVC.selector.value Refine the binding process if not using dynamic provisioning with the value of a label to search for ""
dataPVC.size Size of data volume 2Gi
resources.requests.memory Memory resource requests 256Mi
resources.requests.cpu CPU resource requests 250m
resources.limits.memory Memory resource limits 1Gi
resources.limits.cpu CPU resource limits 1000m

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set mariadb.rootPassword=secretpassword,mariadb.user=my-user,mariadb.password=my-password,mariadb.database=my-database \
    stable/ibm-galera-mariadb-dev

The above command sets the MariaDB root account password to secretpassword. Additionally it creates a standard database user named my-user, with the password my-password, who has access to a database named my-database.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

helm install --name my-release -f values.yaml stable/ibm-galera-mariadb-dev

Tip: You can use the default values.yaml

Random MariaDB root password

If you don’t configure a password for the MariaDB root user, helm will generate a random one for you. You can get the configured password from the created Kubernetes secret:

kubectl get secret <release_name>-ibm-galera-mariadb-dev  -o jsonpath='{.data.mysql-root-password}' | base64 --decode

Custom my.cnf configuration

A Kubernetes ConfigMap can be created and use that supplies MariaDB configuration that would normally go in a my.cnf file. If you wnat to inject configuration, you will need to create a ConfigMap containing data for my_extra.cnf.

For example, create a galera-my-cnf.yaml file with the following content:

apiVersion: v1
kind: ConfigMap
metadata:
  name: galera-my-cnf
data:
  my_extra.cnf: |-
    [mysqld]
    max_allowed_packet = 64M
    sql_mode=STRICT_ALL_TABLES
    innodb_buffer_pool_size=2G

And then create the ConfigMap:

kubectl create -f galera-my-cnf.yaml

Storage

The MariaDB Galera Chart image stores the MariaDB data files at the /var/lib/mysql path of the container.

The chart mounts a Persistent Volume at this location in every pod of the StatefulSet. The volumes may be dynamically provisioned by a PersistentVolume Provisioner or may be manually created ahead of time and then claimed.

Limitations

  • replicas.replicaCount needs to be 3 or more for automatic cluster failovers. Read more about how the number of nodes affects quorum.
  • The chart does not support the s390x architecture

Copyright

© Copyright IBM Corporation 2018. All Rights Reserved.