Install Percona Server for MongoDB with customized parameters¶

You can customize the configuration of Percona Server for MongoDB and install it with customized parameters.

To check available configuration options, see deploy/cr.yaml and Custom Resource Options.

kubectlHelm

To customize the configuration, do the following:

Clone the repository with all manifests and source code by executing the following command:
```
$ git clone -b v1.20.0 https://github.com/percona/percona-server-mongodb-operator
```
Edit the required options and apply the modified deploy/cr.yaml file as follows:
```
$ kubectl apply -f deploy/cr.yaml
```

To install Percona Server for MongoDB with custom parameters, use the following command:

$ helm install --set key=value

You can pass any of the Operator’s Custom Resource options as a --set key=value[,key=value] argument.

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

Command lineYAML file

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

You can specify customized options in a YAML file instead of using separate command line parameters. The resulting file similar to the following 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

Configure ports for MongoDB cluster components¶

By default, the Operator starts Percona Server for MongoDB with the default port 27017 for all cluster components: mongod, mongos and configsvrReplSet Pods. Starting with version 1.20.0, you can start a new cluster with custom ports for all components or for a specific one.

Here’s how to do it.

kubectlHelm

Edit the deploy/cr.yaml file and specify the following configuration:

spec: 
  ...
  replsets:
    - name: rs0
      configuration: |
        net:
          port: 27018
  sharding:
    configsvrReplSet:
      configuration: |
        net:
          port: 27019
    mongos:
      configuration: |
        net:
          port: 27017

Apply the deploy/cr.yaml to deploy Percona Server for MongoDB:
```
$ kubectl apply -f deploy/cr.yaml
```

Create a yaml file with the desired configuration. For example, values.yaml:

values.yaml

replsets:
  rs0:
    name: rs0
    configuration: |
      net:
        port: 27018
sharding:
  configsvrReplSet:
    configuration: |
      net:
        port: 27019
  mongos:
    configuration: |
      net:
        port: 27017

Install Percona Server for MongoDB with the specified configuration:

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

Last update: 2025-05-20