MariaDB Kubernetes Parameters

MariaDB Kubernetes Operator supports a number of parameters that allow you to customize your cluster deployments.

Parameter Configuration

Parameters have default settings that can be overwritten during creation or my YaML files. The specific parameter names vary depending on whether you are using the Operator or the Helm Chart.

Setting Parameters when using the Operator

When using the Operator on your Kubernetes cluster, parameters can be set in YaML files under the spec heading.

$ cat config.yaml

apiVersion: "mariadb.com/v1alpha1"
kind: MariaDB
metadata:
  name: example-masterslave-medium
spec:
  cluster:
    topology: masterslave
    size: small
...

Setting Parameters when using Helm

When using the Helm to install MariaDB Kubernetes Operator on your cluster, the parameter names all have the mariadb prefix. You can set the parameters by modifying those set in the values.yaml file.

$ cat values.yaml

mariadb:
  debug: true

  # general cluster parameters
  cluster:
    id: null 
    topology: galera 
...

You can override the values set in values.yaml at the command-line using the --set option with the parameter's YaML path.

$ helm install . --set mariadb.cluster.topology=galera

Bear in mind that when using MariaDB Kubernetes Operator with Helm, all configuration parameters have the mariadb prefix.

Parameters

Global Cluster Parameters

cluster.id

  • Description: Generated unique ID of the cluster (used as a label on all artifacts) for discovery in multi-tenant environments.
  • Helm Chart: mariadb.cluster.id
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

cluster.topology

  • Description: Type of cluster to create.
  • Valid Values: masterslave, galera, standalone, columnstore, columnstore-standalone.
  • Helm Chart: mariadb.cluster.topology
  • Default: masterslave
  • Introduced: MariaDB Kubernetes Operator 0.1.2

cluster.labels

  • Description: Associative array of custom labels in the format of name:value added to the cluster endpoint.
  • Default: null
  • Helm Chart: mariadb.cluster.labels
  • Introduced: MariaDB Kubernetes Operator 0.1.2

cluster.annotations

  • Description: Associative array of custom annotations added to each pod in the topology.
  • Helm Chart: mariadb.cluster.annotations
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

cluster.nodeGroup

  • Description: Label used to group cluster pods. Ensures that Kubernetes only allocates cluster pods to nodes with the label node.mariadb=.
  • Helm Chart: mariadb.cluster.nodeGroup
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.3

Server Instance Parameters

server.users.admin.username

  • Description: Username for the administrative user.
  • Helm Chart: mariadb.server.users.admin.username
  • Default: admin
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.users.admin.password

  • Description: Password for the administrative user.
  • Helm Chart: mariadb.server.users.admin.password
  • Default: 5LVTpbGE2cGFtw69
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.users.replication.username

  • Description: Replication username.
  • Helm Chart: mariadb.server.users.replication.username
  • Default: repl
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.users.replication.password

  • Description: Password for the replication user.
  • Helm Chart: mariadb.server.users.replication.password
  • Default: 5LVTpbGE2cGFtw69
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.storage.class

  • Description: Storage class specification of the data volume.
  • Helm Chart: mariadb.server.storage.class
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.storage.size

  • Description: Size of data volume.
  • Helm Chart: mariadb.server.storage.size
  • Default: 256Mi
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.replicas

  • Description: Number of MariaDB Server instances in masterslave and galera topologies. When using the standalone topology, value fixed at 1.
  • Helm Chart: mariadb.server.replicas
  • Default: 3
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.image

  • Description: Name of the Docker image to use for the MariaDB Server.
  • Helm Chart: mariadb.server.image
  • Default: mariadb/server:10.3
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.port

  • Description: TCP/IP port on which each MariaDB Server instance exposes a SQL interface.
  • Helm Chart: mariadb.server.port
  • Default: 3306
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.labels

  • Description: Associative array of custom labels, in the name:value format added to MariaDB Server pods.
  • Helm Chart: mariadb.server.labels
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.annotations

  • Description: Associative array of custom annotations in the name:value format, added to MariaDB Server pods.
  • Helm Chart: mariadb.server.annotations
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.resources.requests.cpu

  • Description: Requested share of CPU for each MariaDB Server pod.
  • Helm Chart: mariadb.server.resources.requests.cpu
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.resources.requests.memory

  • Description: Requested memory for each MariaDB Server pod.
  • Helm Chart: mariadb.server.resources.requests.memory
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.resources.limits.cpu

  • Description: Maximum share of CPU for each MariaDB Server pod.
  • Helm Chart: mariadb.server.resources.limits.cpu
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.resources.limits.memory

  • Description: Maximum share of memory for each MariaDB Server pod
  • Helm Chart: mariadb.server.resources.limits.memory
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

server.backup.nfs.server

  • Description: Backup NFS server host.
  • Helm Chart: mariadb.server.backup.nfs.server
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.3

server.backup.nfs.path

  • Description: Backup NFS server path to mount.
  • Helm Chart: mariadb.server.backup.nfs.path
  • Default: /
  • Introduced: MariaDB Kubernetes Operator 0.1.3

server.backup.nfs.restoreFrom

  • Description: Subdirectory to use to restore the database on initial startup.
  • Helm Chart: mariadb.server.backup.nfs.restoreFrom
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.3

MaxScale Instance Parameters

maxscale.image

  • Description: Name of the Docker image for MaxScale.
  • Helm Chart: mariadb.maxscale.image
  • Default: mariadb/maxscale:2.2
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.ports.readonly

  • Description: TCP/IP port on which the cluster instance exposes a read-only SQL interface through a service endpoint.
  • Helm Chart: mariadb.maxscale.ports.readonly
  • Default: 4008
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.ports.readwrite

  • Description: TCP/IP port on which the cluster instance exposes a read-write SQL interface through a service endpoint.
  • Helm Chart: mariadb.maxscale.ports.readwrite
  • Default: 4006
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.labels

  • Description: Associative array of custom labels in the name:value format added to the MaxScale pods.
  • Helm Chart: mariadb.maxscale.labels
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.annotations

  • Description: Associative array of custom annotations in the name:value format added to the MaxScale pods.
  • Helm Chart: mariadb.maxscale.annotations
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.replicas

  • Description: Number of MaxScale instances in Master/Slave and Galera topologies.
  • Helm Chart: mariadb.maxscale.replicas
  • Default: 2
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.resources.requests.cpu

  • Description: Requested share of CPU for each MaxScale pod.
  • Helm Chart: mariadb.maxscale.resources.requests.cpu
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.resources.requests.memory

  • Description: Requested memory for each MaxScale pod.
  • Helm Chart: mariadb.maxscale.resources.requests.memory
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.resources.limits.cpu

  • Description: Maximum share of CPU for each MaxScale pod.
  • Helm Chart: mariadb.maxscale.resources.limits.cpu
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

maxscale.resources.limits.memory

  • Description: Maximum share of memory for each MaxScale pod.
  • Helm Chart: mariadb.maxscale.resources.limits.memory
  • Default: null
  • Introduced: MariaDB Kubernetes Operator 0.1.2

ColumnStore Instance Parameters

columnstore.image

  • Description: Docker image used for MariaDB ColumnStore.
  • Helm Chart: mariadb.columnstore.image
  • Default: mariadb/columnstore:1.2.3
  • Introduced: MariaDB Kubernetes Operator 0.1.3

columnstore.numBlocksPct

  • Description: Amount of physical memory to utilize for disk block caching.
  • Helm Chart: mariadb.columnstore.numBlocksPct
  • Default: 1024M
  • Introduced: MariaDB Kubernetes Operator 0.1.3

columnstore.totalUmMemory

  • Description: Amount of physical memory to utilize for joins, intermediate results and set operations on the User Module.
  • Helm Chart: mariadb.columnstore.totalUmMemory
  • Default: 1G
  • Introduced: MariaDB Kubernetes Operator 0.1.3

columnstore.um.replicas

  • Description: Number of ColumnStore User Module instances to deploy in the columnstore topology.
  • Helm Chart: mariadb.columnstore.um.replicas
  • Default: 1
  • Introduced: MariaDB Kubernetes Operator 0.1.3

columnstore.pm.replicas

  • Description: Number of ColumnStore Performance Module instances to deploy in columnstore topology.
  • Helm Chart: mariadb.columnstore.pm.replicas
  • Default: 3
  • Introduced: MariaDB Kubernetes Operator 0.1.3

StateStore Instance Parameters

statestore.image

  • Description: Name of the Docker image to use for the MariaDB StateStore.
  • Helm Chart: mariadb.statestore.image
  • Default: mariadb/statestore:0.0.3
  • Introduced: MariaDB Kubernetes Operator 0.1.2

Comments

Comments loading...
Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.