Skip to content

Latest commit

 

History

History
 
 

psmdb-db

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
crds
crds
 
 
templates
templates
 
 
.helmignore
.helmignore
 
 
Chart.yaml
Chart.yaml
 
 
README.md
README.md
 
 
production-values.yaml
production-values.yaml
 
 
values.yaml
values.yaml
 
 

README.md

psmdb-db: A chart for installing Percona Server MongoDB Operator managed Databases

This chart implements Percona Server MongoDB deployment in Kubernets via Custom Resource object. The project itself can be found here:

Pre-requisites

  • PSMDB operator running in you K8S cluster
  • Kubernetes 1.16+
  • PV support on the underlying infrastructure - only if you are provisioning persistent volume(s).
  • At least v2.5.0 version of helm

Custom Resource Details

StatefulSet Details

Chart Details

This chart will:

  • deploy PSMDB database Pods (Custom Resource -> StatefulSet) for the further MongoDB Cluster creation in K8S.

Installing the Chart

To install the chart with the psmdb release name using a dedicated namespace (recommended):

helm repo add percona https://percona.github.io/percona-helm-charts/
helm install my-db percona/psmdb-db --version 1.9.0 --namespace my-namespace

The chart can be customized using the following configurable parameters:

Parameter Description Default
pause Stop PSMDB Database safely false
allowUnsafeConfigurations Allows forbidden configurations like even number of PSMDB cluster pods false
updateStrategy Regulates the way how PSMDB Cluster Pods will be updated after setting a new image SmartUpdate
upgradeOptions.versionServiceEndpoint Endpoint for actual PSMDB Versions provider https://check.percona.com/versions/
upgradeOptions.apply PSMDB image to apply from version service - recommended, latest, actual version like 4.4.2-4 4.4-recommended
upgradeOptions.schedule Cron formatted time to execute the update "0 2 * * *"
upgradeOptions.setFCV Set feature compatibility version on major upgrade false
finalizers:delete-psmdb-pvc Set this if you want to delete database persistent volumes on cluster deletion []
image.repository PSMDB Container image repository percona/percona-server-mongodb
image.tag PSMDB Container image tag 4.4.6-8
imagePullSecrets PSMDB Container pull secret []
runUid Set UserID ""
secrets Users secret structure {}
pmm.enabled Enable integration with Percona Monitoring and Management software false
pmm.image.repository PMM Container image repository percona/pmm-client
pmm.image.tag PMM Container image tag 2.18.0
pmm.serverHost PMM server related K8S service hostname monitoring-service
replsets[0].name ReplicaSet name rs0
replsets[0].size ReplicaSet size (pod quantity) 3
replsets[0].configuration Custom config for mongod in replica set ""
replsets[0].antiAffinityTopologyKey ReplicaSet Pod affinity kubernetes.io/hostname
replsets[0].priorityClass ReplicaSet Pod priorityClassName ""
replsets[0].annotations ReplicaSet Pod annotations {}
replsets[0].labels ReplicaSet Pod labels {}
replsets[0].nodeSelector ReplicaSet Pod nodeSelector labels {}
replsets[0].livenessProbe ReplicaSet Pod livenessProbe structure {}
replsets[0].runtimeClass ReplicaSet Pod runtimeClassName ""
replsets[0].sidecars ReplicaSet Pod sidecars {}
replsets[0].podDisruptionBudget.maxUnavailable ReplicaSet failed Pods maximum quantity 1
replsets[0].expose.enabled Allow access to replicaSet from outside of Kubernetes false
replsets[0].expose.exposeType Network service access point type LoadBalancer
replsets[0].arbiter.enabled Create MongoDB arbiter service false
replsets[0].arbiter.size MongoDB arbiter Pod quantity 1
replsets[0].arbiter.antiAffinityTopologyKey MongoDB arbiter Pod affinity kubernetes.io/hostname
replsets[0].arbiter.priorityClass MongoDB arbiter priorityClassName ""
replsets[0].arbiter.annotations MongoDB arbiter Pod annotations {}
replsets[0].arbiter.labels MongoDB arbiter Pod labels {}
replsets[0].arbiter.nodeSelector MongoDB arbiter Pod nodeSelector labels {}
replsets[0].arbiter.livenessProbe MongoDB arbiter Pod livenessProbe structure {}
replsets[0].schedulerName ReplicaSet Pod schedulerName ""
replsets[0].resources ReplicaSet Pods resource requests and limits {}
replsets[0].volumeSpec ReplicaSet Pods storage resources {}
replsets[0].volumeSpec.emptyDir ReplicaSet Pods emptyDir K8S storage {}
replsets[0].volumeSpec.hostPath ReplicaSet Pods hostPath K8S storage
replsets[0].volumeSpec.hostPath.path ReplicaSet Pods hostPath K8S storage path ""
replsets[0].volumeSpec.pvc ReplicaSet Pods PVC request parameters
replsets[0].volumeSpec.pvc.storageClassName ReplicaSet Pods PVC target storageClass ""
replsets[0].volumeSpec.pvc.accessModes ReplicaSet Pods PVC access policy []
replsets[0].volumeSpec.pvc.resources.requests.storage ReplicaSet Pods PVC storage size 3Gi
sharding.enabled Enable sharding setup true
sharding.configrs.size Config ReplicaSet size (pod quantity) 3
sharding.configrs.configuration Custom config for mongod in config replica set ""
sharding.configrs.antiAffinityTopologyKey Config ReplicaSet Pod affinity kubernetes.io/hostname
sharding.configrs.priorityClass Config ReplicaSet Pod priorityClassName ""
sharding.configrs.annotations Config ReplicaSet Pod annotations {}
sharding.configrs.labels Config ReplicaSet Pod labels {}
sharding.configrs.nodeSelector Config ReplicaSet Pod nodeSelector labels {}
sharding.configrs.runtimeClass Config ReplicaSet Pod runtimeClassName ""
sharding.configrs.sidecars Config ReplicaSet Pod sidecars {}
sharding.configrs.podDisruptionBudget.maxUnavailable Config ReplicaSet failed Pods maximum quantity 1
sharding.configrs.resources.limits.cpu Config ReplicaSet resource limits CPU 300m
sharding.configrs.resources.limits.memory Config ReplicaSet resource limits memory 0.5G
sharding.configrs.resources.requests.cpu Config ReplicaSet resource requests CPU 300m
sharding.configrs.resources.requests.memory Config ReplicaSet resource requests memory 0.5G
sharding.configrs.volumeSpec.hostPath Config ReplicaSet hostPath K8S storage
sharding.configrs.volumeSpec.hostPath.path Config ReplicaSet hostPath K8S storage path ""
sharding.configrs.volumeSpec.emptyDir Config ReplicaSet Pods emptyDir K8S storage
sharding.configrs.volumeSpec.pvc Config ReplicaSet Pods PVC request parameters
sharding.configrs.volumeSpec.pvc.storageClassName Config ReplicaSet Pods PVC storageClass ""
sharding.configrs.volumeSpec.pvc.accessModes Config ReplicaSet Pods PVC access policy []
sharding.configrs.volumeSpec.pvc.resources.requests.storage Config ReplicaSet Pods PVC storage size 3Gi
sharding.mongos.size Mongos size (pod quantity) 3
sharding.mongos.configuration Custom config for mongos ""
sharding.mongos.antiAffinityTopologyKey Mongos Pods affinity kubernetes.io/hostname
sharding.mongos.priorityClass Mongos Pods priorityClassName ""
sharding.mongos.annotations Mongos Pods annotations {}
sharding.mongos.labels Mongos Pods labels {}
sharding.mongos.nodeSelector Mongos Pods nodeSelector labels {}
sharding.mongos.runtimeClass Mongos Pod runtimeClassName ""
sharding.mongos.sidecars Mongos Pod sidecars {}
sharding.mongos.podDisruptionBudget.maxUnavailable Mongos failed Pods maximum quantity 1
sharding.mongos.resources.limits.cpu Mongos Pods resource limits CPU 300m
sharding.mongos.resources.limits.memory Mongos Pods resource limits memory 0.5G
sharding.mongos.resources.requests.cpu Mongos Pods resource requests CPU 300m
sharding.mongos.resources.requests.memory Mongos Pods resource requests memory 0.5G
sharding.mongos.expose.exposeType Mongos service exposeType ClusterIP
sharding.mongos.loadBalancerSourceRanges Limit client IP's access to Load Balancer {}
sharding.mongos.serviceAnnotations Mongos service annotations {}
backup.enabled Enable backup PBM agent true
backup.restartOnFailure Backup Pods restart policy true
backup.image.repository PBM Container image repository percona/percona-server-mongodb-operator
backup.image.tag PBM Container image tag 1.9.0-backup
backup.serviceAccountName Run PBM Container under specified K8S SA percona-server-mongodb-operator
backup.storages Local/remote backup storages settings {}
backup.pitr.enabled Enable point in time recovery for backup false
backup.tasks Backup working schedule {}
users PSMDB essential users {}

Specify parameters using --set key=value[,key=value] argument to helm install Notice that you can use multiple replica sets only with sharding enabled.

Examples

Deploy a replica set with disabled backups and no mongos pods

This is great for a dev PSMDB/MongoDB cluster as it doesn't bother with backups and sharding setup.

$ helm install dev  --namespace psmdb . \
    --set runUid=1001 --set "replsets[0].volumeSpec.pvc.resources.requests.storage=20Gi" \
    --set backup.enabled=false --set sharding.enabled=false