kubernetes/common/mariadb-galera/values.yaml

   1 # Copyright © 2018 Amdocs
   2 # Copyright © 2018,2021 Bell Canada
   3 # Copyright © 2019 Samsung Electronics
   4 # Copyright © 2020 Bitnami, Orange
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17
  18
  19 #################################################################
  20 # Secrets metaconfig
  21 #################################################################
  22 secrets:
  23   - uid: '{{ include "common.mariadb.secret.rootPassUID" . }}'
  24     type: password
  25     externalSecret: '{{ tpl (default "" .Values.rootUser.externalSecret) . }}'
  26     password: '{{ .Values.rootUser.password }}'
  27   - uid: '{{ include "common.mariadb.secret.userCredentialsUID" . }}'
  28     type: basicAuth
  29     externalSecret: '{{ tpl (default "" .Values.db.externalSecret) . }}'
  30     login: '{{ .Values.db.user }}'
  31     password: '{{ .Values.db.password }}'
  32   - uid: '{{ include "common.mariadb.secret.backupCredentialsUID" . }}'
  33     type: basicAuth
  34     externalSecret: '{{ tpl (default "" .Values.galera.mariabackup.externalSecret) . }}'
  35     login: '{{ .Values.galera.mariabackup.user }}'
  36     password: '{{ .Values.galera.mariabackup.password }}'
  37
  38 # bitnami image doesn't support well single quote in password
  39 passwordStrengthOverride: basic
  40
  41 #################################################################
  42 # Global configuration defaults.
  43 #################################################################
  44 global:
  45   nodePortPrefix: 302
  46   persistence:
  47     mountPath: /dockerdata-nfs
  48     backup:
  49       mountPath: /dockerdata-nfs/backup
  50   clusterDomain: cluster.local
  51   metrics: {}
  52
  53 image: bitnami/mariadb-galera:10.6.5-debian-10-r28
  54 ## Specify a imagePullPolicy
  55 ## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'
  56 ## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images
  57 ##
  58 pullPolicy: Always
  59
  60 ## Set to true if you would like to see extra information on logs
  61 ## It turns BASH debugging in minideb-extras-base
  62 ##
  63 debug: true
  64
  65 ## Sometimes, especially when a lot of pods are created at the same time,
  66 ## actions performed on the databases are tried to be done before actual start.
  67 init_sleep_time: 5
  68
  69 ## String to partially override common.names.fullname template (will maintain the release name)
  70 ##
  71 nameOverride: mariadb-galera
  72
  73 ## Use an alternate scheduler, e.g. "stork".
  74 ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
  75 ##
  76 # schedulerName:
  77
  78 ## StatefulSet controller supports relax its ordering guarantees while preserving its uniqueness and identity guarantees. There are two valid pod management policies: OrderedReady and Parallel
  79 ## ref: https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#pod-management-policy
  80 ##
  81 podManagementPolicy: OrderedReady
  82
  83 ## MariaDB Gallera K8s svc properties
  84 ##
  85 service:
  86   ## Kubernetes service type and port number
  87   ##
  88   type: ClusterIP
  89   headless: {}
  90   internalPort: &dbPort 3306
  91   ports:
  92     - name: mysql
  93       port: *dbPort
  94   headlessPorts:
  95     - name: galera
  96       port: 4567
  97     - name: ist
  98       port: 4568
  99     - name: sst
 100       port: 4444
 101
 102
 103 ## Pods Service Account
 104 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
 105 ##
 106 serviceAccount:
 107   nameOverride: mariadb-galera
 108   roles:
 109     - read
 110
 111 ## Pod Security Context
 112 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
 113 ##
 114 securityContext:
 115   enabled: true
 116   user_id: 10001
 117   group_id: 10001
 118
 119 ## Database credentials for root (admin) user
 120 ##
 121 rootUser:
 122   ## MariaDB admin user
 123   user: root
 124   ## MariaDB admin password
 125   ## Password is ignored if externalSecret is specified.
 126   ## If not set, password will be "randomly" generated
 127   ## ref: https://github.com/bitnami/bitnami-docker-mariadb-galera#setting-the-root-password-on-first-run
 128   ##
 129   # password:
 130   # externalSecret:
 131
 132 ## Custom db configuration
 133 ##
 134 db:
 135   ## MariaDB username and password
 136   ## Password is ignored if externalSecret is specified.
 137   ## If not set, password will be "randomly" generated
 138   ## ref: https://github.com/bitnami/bitnami-docker-mariadb-galera#creating-a-database-user-on-first-run
 139   ##
 140   user: my-user
 141   # password:
 142   # externalSecret:
 143   ## Database to create
 144   ## ref: https://github.com/bitnami/bitnami-docker-mariadb-galera#creating-a-database-on-first-run
 145   ##
 146   # name: my_database
 147
 148 ## Galera configuration
 149 ##
 150 galera:
 151   ## Galera cluster name
 152   ##
 153   name: galera
 154
 155   ## Bootstraping options
 156   ## ref: https://github.com/bitnami/bitnami-docker-mariadb-galera#bootstraping
 157   bootstrap:
 158     ## Node to bootstrap from, you will need to change this parameter incase you want to bootstrap from other node
 159     ##
 160     bootstrapFromNode:
 161     ## Force safe_to_bootstrap in grastate.date file.
 162     ## This will set safe_to_bootstrap=1 in the node indicated by bootstrapFromNode.
 163     forceSafeToBootstrap: false
 164
 165   ## Credentials to perform backups
 166   ##
 167   mariabackup:
 168     ## MariaBackup username and password
 169     ## Password is ignored if externalSecret is specified.
 170     ## If not set, password will be "randomly" generated
 171     ## ref: https://github.com/bitnami/bitnami-docker-mariadb-galera#setting-up-a-multi-master-cluster
 172     ##
 173     user: mariabackup
 174     # password:
 175     # externalSecret:
 176
 177 backup:
 178   enabled: false
 179   cron: "00 00 * * *"
 180   retentionPeriod: 3
 181   persistence:
 182     ## If true, use a Persistent Volume Claim, If false, use emptyDir
 183     ##
 184     enabled: true
 185     # Enable persistence using an existing PVC
 186     # existingClaim:
 187     ## selector can be used to match an existing PersistentVolume
 188     ## selector:
 189     ##   matchLabels:
 190     ##     app: my-app
 191     selector: {}
 192     ## Persistent Volume Storage Class
 193     ## If defined, storageClassName: <storageClass>
 194     ## If set to "-", storageClassName: "", which disables dynamic provisioning
 195     ## If undefined (the default) or set to null, no storageClassName spec is
 196     ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
 197     ##   GKE, AWS & OpenStack)
 198     ##
 199     # storageClass: "-"
 200     ## Persistent Volume Claim annotations
 201     ##
 202     annotations:
 203     ## Persistent Volume Access Mode
 204     ##
 205     accessMode: ReadWriteOnce
 206     ## Persistent Volume size
 207     ##
 208     size: 2Gi
 209
 210
 211 readinessCheck:
 212   wait_for:
 213     - '{{ include "common.name" . }}'
 214
 215 ## TLS configuration
 216 ##
 217 tls:
 218   ## Enable TLS
 219   ##
 220   enabled: false
 221   ## Name of the secret that contains the certificates
 222   ##
 223   # certificatesSecret:
 224   ## Certificate filename
 225   ##
 226   # certFilename:
 227   ## Certificate Key filename
 228   ##
 229   # certKeyFilename:
 230   ## CA Certificate filename
 231   ##
 232   # certCAFilename:
 233
 234 ## Configure MariaDB with a custom my.cnf file
 235 ## ref: https://mysql.com/kb/en/mysql/configuring-mysql-with-mycnf/#example-of-configuration-file
 236 ## Alternatively, you can put your my.cnf under the files/ directory
 237 ##
 238 mariadbConfiguration: |-
 239   [client]
 240   port=3306
 241   socket=/opt/bitnami/mariadb/tmp/mysql.sock
 242   plugin_dir=/opt/bitnami/mariadb/plugin
 243
 244   [mysqld]
 245   lower_case_table_names = 1
 246   default_storage_engine=InnoDB
 247   basedir=/opt/bitnami/mariadb
 248   datadir=/bitnami/mariadb/data
 249   plugin_dir=/opt/bitnami/mariadb/plugin
 250   tmpdir=/opt/bitnami/mariadb/tmp
 251   socket=/opt/bitnami/mariadb/tmp/mysql.sock
 252   pid_file=/opt/bitnami/mariadb/tmp/mysqld.pid
 253   bind_address=0.0.0.0
 254
 255   ## Character set
 256   collation_server=utf8_unicode_ci
 257   init_connect='SET NAMES utf8'
 258   character_set_server=utf8
 259
 260   ## MyISAM
 261   key_buffer_size=32M
 262   myisam_recover_options=FORCE,BACKUP
 263
 264   ## Safety
 265   skip_host_cache
 266   skip_name_resolve
 267   max_allowed_packet=16M
 268   max_connect_errors=1000000
 269   sql_mode=STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_AUTO_VALUE_ON_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,ONLY_FULL_GROUP_BY
 270   sysdate_is_now=1
 271
 272   ## Binary Logging
 273   log_bin=mysql-bin
 274   expire_logs_days=14
 275   # Disabling for performance per http://severalnines.com/blog/9-tips-going-production-galera-cluster-mysql
 276   sync_binlog=0
 277   # Required for Galera
 278   binlog_format=row
 279
 280   ## Caches and Limits
 281   tmp_table_size=32M
 282   max_heap_table_size=32M
 283   # Re-enabling as now works with Maria 10.1.2
 284   query_cache_type=1
 285   query_cache_limit=4M
 286   query_cache_size=256M
 287   max_connections=500
 288   thread_cache_size=50
 289   open_files_limit=65535
 290   table_definition_cache=4096
 291   table_open_cache=4096
 292
 293   ## InnoDB
 294   innodb=FORCE
 295   innodb_strict_mode=1
 296   # Mandatory per https://github.com/codership/documentation/issues/25
 297   innodb_autoinc_lock_mode=2
 298   # Per https://www.percona.com/blog/2006/08/04/innodb-double-write/
 299   innodb_doublewrite=1
 300   innodb_flush_method=O_DIRECT
 301   innodb_log_files_in_group=2
 302   innodb_log_file_size=128M
 303   innodb_flush_log_at_trx_commit=1
 304   innodb_file_per_table=1
 305   # 80% Memory is default reco.
 306   # Need to re-evaluate when DB size grows
 307   innodb_buffer_pool_size=2G
 308   innodb_file_format=Barracuda
 309
 310   ## Logging
 311   log_error=/opt/bitnami/mariadb/logs/mysqld.log
 312   slow_query_log_file=/opt/bitnami/mariadb/logs/mysqld.log
 313   log_queries_not_using_indexes=1
 314   slow_query_log=1
 315
 316   ## SSL
 317   ## Use extraVolumes and extraVolumeMounts to mount /certs filesystem
 318   # ssl_ca=/certs/ca.pem
 319   # ssl_cert=/certs/server-cert.pem
 320   # ssl_key=/certs/server-key.pem
 321
 322   [galera]
 323   wsrep_on=ON
 324   wsrep_provider=/opt/bitnami/mariadb/lib/libgalera_smm.so
 325   wsrep_sst_method=mariabackup
 326   wsrep_slave_threads=4
 327   wsrep_cluster_address=gcomm://
 328   wsrep_cluster_name=galera
 329   wsrep_sst_auth="root:"
 330   # Enabled for performance per https://mariadb.com/kb/en/innodb-system-variables/#innodb_flush_log_at_trx_commit
 331   innodb_flush_log_at_trx_commit=2
 332   # MYISAM REPLICATION SUPPORT #
 333   wsrep_replicate_myisam=ON
 334   binlog_format=row
 335   default_storage_engine=InnoDB
 336   innodb_autoinc_lock_mode=2
 337   transaction-isolation=READ-COMMITTED
 338   wsrep_causal_reads=1
 339   wsrep_sync_wait=7
 340
 341   [mariadb]
 342   plugin_load_add=auth_pam
 343
 344   ## Data-at-Rest Encryption
 345   ## Use extraVolumes and extraVolumeMounts to mount /encryption filesystem
 346   # plugin_load_add=file_key_management
 347   # file_key_management_filename=/encryption/keyfile.enc
 348   # file_key_management_filekey=FILE:/encryption/keyfile.key
 349   # file_key_management_encryption_algorithm=AES_CTR
 350   # encrypt_binlog=ON
 351   # encrypt_tmp_files=ON
 352
 353   ## InnoDB/XtraDB Encryption
 354   # innodb_encrypt_tables=ON
 355   # innodb_encrypt_temporary_tables=ON
 356   # innodb_encrypt_log=ON
 357   # innodb_encryption_threads=4
 358   # innodb_encryption_rotate_key_age=1
 359
 360   ## Aria Encryption
 361   # aria_encrypt_tables=ON
 362   # encrypt_tmp_disk_tables=ON
 363
 364 ## MariaDB additional command line flags
 365 ## Can be used to specify command line flags, for example:
 366 ##
 367 ## extraFlags: "--max-connect-errors=1000 --max_connections=155"
 368
 369 ## Desired number of cluster nodes
 370 ##
 371 replicaCount: 3
 372
 373 ## updateStrategy for MariaDB Master StatefulSet
 374 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
 375 ##
 376 updateStrategy:
 377   type: RollingUpdate
 378
 379 ## Additional pod annotations for MariaDB Galera pods
 380 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
 381 ##
 382 podAnnotations: {}
 383
 384 ## Pod affinity preset
 385 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
 386 ## Allowed values: soft, hard
 387 ##
 388 podAffinityPreset: ""
 389
 390 ## Pod anti-affinity preset
 391 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
 392 ## Allowed values: soft, hard
 393 ##
 394 podAntiAffinityPreset: soft
 395
 396 ## Node affinity preset
 397 ## Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
 398 ## Allowed values: soft, hard
 399 ##
 400 nodeAffinityPreset:
 401   ## Node affinity type
 402   ## Allowed values: soft, hard
 403   type: ""
 404   ## Node label key to match
 405   ## E.g.
 406   ## key: "kubernetes.io/e2e-az-name"
 407   ##
 408   key: ""
 409   ## Node label values to match
 410   ## E.g.
 411   ## values:
 412   ##   - e2e-az1
 413   ##   - e2e-az2
 414   ##
 415   values: []
 416
 417 ## Affinity for pod assignment. Evaluated as a template.
 418 ## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
 419 ## Note: podAffinityPreset, podAntiAffinityPreset, and nodeAffinityPreset will be ignored when it's set
 420 ##
 421 affinity: {}
 422
 423 ## Node labels for pod assignment. Evaluated as a template.
 424 ## ref: https://kubernetes.io/docs/user-guide/node-selection/
 425 ##
 426 nodeSelector: {}
 427
 428 ## Tolerations for pod assignment. Evaluated as a template.
 429 ## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
 430 ##
 431 tolerations: []
 432
 433 ## Enable persistence using Persistent Volume Claims
 434 ## ref: http://kubernetes.io/docs/user-guide/persistent-volumes/
 435 ##
 436 persistence:
 437   ## If true, use a Persistent Volume Claim, If false, use emptyDir
 438   ##
 439   enabled: true
 440   # Enable persistence using an existing PVC
 441   # existingClaim:
 442   mountPath: /dockerdata-nfs
 443   mountSubPath: "mariadb-galera/data"
 444   ## selector can be used to match an existing PersistentVolume
 445   ## selector:
 446   ##   matchLabels:
 447   ##     app: my-app
 448   selector: {}
 449   ## Persistent Volume Storage Class
 450   ## If defined, storageClassName: <storageClass>
 451   ## If set to "-", storageClassName: "", which disables dynamic provisioning
 452   ## If undefined (the default) or set to null, no storageClassName spec is
 453   ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
 454   ##   GKE, AWS & OpenStack)
 455   ##
 456   # storageClass: "-"
 457   ## Persistent Volume Claim annotations
 458   ##
 459   annotations:
 460   ## Persistent Volume Access Mode
 461   ##
 462   accessMode: ReadWriteOnce
 463   ## Persistent Volume size
 464   ##
 465   size: 2Gi
 466
 467 ## Additional pod labels
 468 ##
 469 # podLabels:
 470 #   extraLabel: extraValue
 471
 472 ## Priority Class Name
 473 #
 474 # priorityClassName: 'priorityClass'
 475
 476 ## MariaDB Galera containers' resource requests and limits
 477 ## ref: http://kubernetes.io/docs/user-guide/compute-resources/
 478 ##
 479 flavor: small
 480 resources:
 481   small:
 482     limits:
 483       cpu: 1
 484       memory: 4Gi
 485     requests:
 486       cpu: 500m
 487       memory: 2Gi
 488   large:
 489     limits:
 490       cpu: 2
 491       memory: 6Gi
 492     requests:
 493       cpu: 1
 494       memory: 3Gi
 495   unlimited: {}
 496
 497 ## MariaDB Galera containers' liveness and readiness probes
 498 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
 499 ##
 500 livenessProbe:
 501   enabled: true
 502   initialDelaySeconds: 1
 503   periodSeconds: 10
 504   timeoutSeconds: 1
 505   successThreshold: 1
 506   failureThreshold: 3
 507 readinessProbe:
 508   enabled: true
 509   initialDelaySeconds: 1
 510   periodSeconds: 10
 511   timeoutSeconds: 1
 512   successThreshold: 1
 513   failureThreshold: 3
 514 startupProbe:
 515   ## Initializing the database could take some time
 516   ##
 517   enabled: true
 518   initialDelaySeconds: 10
 519   periodSeconds: 10
 520   timeoutSeconds: 1
 521   successThreshold: 1
 522   # will wait up for initialDelaySeconds + failureThreshold*periodSeconds before
 523   # stating startup wasn't good (910s per default)
 524   failureThreshold: 90
 525
 526 ## Pod disruption budget configuration
 527 ##
 528 podDisruptionBudget:
 529   ## Specifies whether a Pod disruption budget should be created
 530   ##
 531   create: true
 532   minAvailable: 1
 533   # maxUnavailable: 1
 534
 535 ## Prometheus exporter configuration
 536 ##
 537 metrics:
 538   ## Bitnami MySQL Prometheus exporter image
 539   ## ref: https://hub.docker.com/r/bitnami/mysqld-exporter/tags/
 540   ##
 541   image: bitnami/mysqld-exporter:0.12.1-debian-10-r264
 542   pullPolicy: Always
 543   ## MySQL exporter additional command line flags
 544   ## Can be used to specify command line flags
 545   ## E.g.:
 546   ## extraFlags:
 547   ##   - --collect.binlog_size
 548   ##
 549   extraFlags: []
 550   ## MySQL Prometheus exporter containers' resource requests and limits
 551   ## ref: http://kubernetes.io/docs/user-guide/compute-resources/
 552   ##
 553   resources:
 554     # We usually recommend not to specify default resources and to leave this as a conscious
 555     # choice for the user. This also increases chances charts run on environments with little
 556     # resources, such as Minikube. If you do want to specify resources, uncomment the following
 557     # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
 558     limits:
 559       cpu: 0.5
 560       memory: 256Mi
 561     requests:
 562       cpu: 0.5
 563       memory: 256Mi
 564   ## MariaDB Galera metrics container's liveness and readiness probes
 565   ## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
 566   ##
 567   livenessProbe:
 568     enabled: true
 569     initialDelaySeconds: 30
 570     periodSeconds: 10
 571     timeoutSeconds: 5
 572     successThreshold: 1
 573     failureThreshold: 3
 574   readinessProbe:
 575     enabled: true
 576     initialDelaySeconds: 5
 577     periodSeconds: 10
 578     timeoutSeconds: 5
 579     successThreshold: 1
 580     failureThreshold: 3
 581   ## MySQL Prometheus exporter service parameters
 582   ##
 583   service:
 584     type: ClusterIP
 585     port: 9104
 586     annotations:
 587       prometheus.io/scrape: "true"
 588       prometheus.io/port: "9104"
 589
 590   ## Prometheus Operator ServiceMonitor configuration
 591   ##
 592   serviceMonitor:
 593     enabled: false
 594     ## Namespace in which Prometheus is running
 595     ##
 596     # namespace: monitoring
 597
 598     ## Interval at which metrics should be scraped.
 599     ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
 600     ##
 601     # interval: 10s
 602
 603     ## Timeout after which the scrape is ended
 604     ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
 605     ##
 606     # scrapeTimeout: 10s
 607
 608     ## ServiceMonitor selector labels
 609     ## ref: https://github.com/bitnami/charts/tree/master/bitnami/prometheus-operator#prometheus-configuration
 610     ##
 611     # selector:
 612     #   prometheus: kube-prometheus
 613
 614     ## RelabelConfigs to apply to samples before scraping
 615     ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#relabelconfig
 616     ## Value is evalued as a template
 617     ##
 618     relabelings: []
 619
 620     ## MetricRelabelConfigs to apply to samples before ingestion
 621     ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#relabelconfig
 622     ## Value is evalued as a template
 623     ##
 624     metricRelabelings: []
 625     #  - sourceLabels:
 626     #      - "__name__"
 627     #    targetLabel: "__name__"
 628     #    action: replace
 629     #    regex: '(.*)'
 630     #    replacement: 'example_prefix_$1'
 631
 632   ## Prometheus Operator PrometheusRule configuration
 633   ##
 634   prometheusRules:
 635     enabled: false
 636
 637     ## Additional labels to add to the PrometheusRule so it is picked up by the operator.
 638     ## If using the [Helm Chart](https://github.com/helm/charts/tree/master/stable/prometheus-operator) this is the name of the Helm release and 'app: prometheus-operator'
 639     selector:
 640       app: prometheus-operator
 641       release: prometheus
 642
 643     ## Rules as a map.
 644     rules: {}
 645     #  - alert: MariaDB-Down
 646     #    annotations:
 647     #      message: 'MariaDB instance {{ $labels.instance }} is down'
 648     #      summary: MariaDB instance is down
 649     #    expr: absent(up{job="mariadb-galera"} == 1)
 650     #    labels:
 651     #      severity: warning
 652     #      service: mariadb-galera
 653     #    for: 5m