Install Percona Server for MongoDB using Helm

Helm is the package manager for Kubernetes. Percona Helm charts can be found in percona/percona-helm-charts repository on Github.

Pre-requisites

Install Helm following its official installation instructions.

Note

Helm v3 is needed to run the following steps.

Installation

1. Add the Percona’s Helm charts repository and make your Helm client up to date with it:

   $ helm repo add percona https://percona.github.io/percona-helm-charts/
   $ helm repo update
   

2. Install Percona Operator for MongoDB:

   $ helm install my-op percona/psmdb-operator
   

   The my-op parameter in the above example is the name of a new release object which is created for the Operator when you install its Helm chart (use any name you like).

   Note

   If nothing explicitly specified, helm install command will work with the default namespace and the latest version of the Helm chart.

   • To use different namespace, provide its name with the following additional parameter: --namespace my-namespace.

   • To use different Helm chart version, provide it as follows: --version 1.14.0

3. Install Percona Server for MongoDB:

   $ helm install my-db percona/psmdb-db --namespace my-namespace
   

   The my-db parameter in the above example is the name of a new release object which is created for the Percona Server for MongoDB when you install its Helm chart (use any name you like).

Installing Percona Server for MongoDB with customized parameters

The command above installs Percona Server for MongoDB with default parameters. Custom options can be passed to a helm install command as a --set key=value[,key=value] argument. The options passed with a chart can be any of the Operator’s Custom Resource options.

Note

Parameters from the Replica Set section are treated differently: if you specify any parameter from replsets, the Operator will not use default values for this Replica Set. So do not specify Replica Set options at all or specify all needed options for the Replica Set.

The following example will deploy a Percona Server for MongoDB Cluster in the psmdb namespace, with disabled backups and 20 Gi storage:

$ helm install my-db percona/psmdb-db --version 1.14.0 --namespace psmdb \
  --set "replsets[0].name=rs0" --set "replsets[0].size=3" \
  --set "replsets[0].volumeSpec.pvc.resources.requests.storage=20Gi" \
  --set backup.enabled=false --set sharding.enabled=false

Also it can be more convenient in some cases to specify customized options in a YAML file instead of using separate command line parameters. The resulting file similar to the above example looks as follows:

values.yaml

allowUnsafeConfigurations: true
sharding:
  enabled: false
replsets:
- name: rs0
  size: 3
  volumeSpec:
    pvc:
      resources:
        requests:
          storage: 2Gi
backup:
  enabled: false

Apply the resulting YAML file as follows:

$ helm install my-db percona/psmdb-db --namespace psmdb -f values.yaml

Contact Us

For free technical help, visit the Percona Community Forum.

To report bugs or submit feature requests, open a JIRA ticket.

For paid support and managed or consulting services , contact Percona Sales.

---

Last update: 2023-05-23