Docs Menu
Docs Home
/ /
Deploy Search & Vector Search
Docs Home
/
Management
/
Controllers for Kubernetes Operator
/
Deploy Search & Vector Search
Docs Home
/
Management
/
Controllers for Kubernetes Operator
/
Deploy Search & Vector Search

Install and use With MongoDB Community Edition

You can use the Kubernetes Operator and deploy the mongot process resources to run with MongoDB Community Edition v8.2.0 or higher on a Kubernetes cluster. The mongot process supports both MongoDB Search search Vector Search. The following procedure demonstrates how to deploy and configure MongoDB Search and Vector Search to run with a new or existing replica set in your Kubernetes cluster.

Prerequisites

To deploy MongoDB Search and Vector Search, you must have the following:

  • A running Kubernetes cluster.

  • Kubernetes command-line tool, kubectl, configured to communicate with your cluster.

  • Helm, the package manager for Kubernetes, to install the Kubernetes Operator.

  • Bash v5.1 or higher for running the commands in this tutorial.

Procedure

1

Required. Set the environment variables.

To set the environment variables for use in the subsequent steps in this procedure, copy the following, set the values for the environment variables, and then load the environment variables:

1# set it to the context name of the k8s cluster
2export K8S_CTX="<local cluster context>"
3
4# the following namespace will be created if not exists
5export MDB_NS="mongodb"
6
7# minimum required MongoDB version for running MongoDB Search is 8.2.0
8export MDB_VERSION="8.2.0"
9
10# root admin user for convenience, not used here at all in this guide
11export MDB_ADMIN_USER_PASSWORD="admin-user-password-CHANGE-ME"
12# regular user performing restore and search queries on sample mflix database
13export MDB_USER_PASSWORD="mdb-user-password-CHANGE-ME"
14# user for MongoDB Search to connect to the replica set to synchronise data from
15export MDB_SEARCH_SYNC_USER_PASSWORD="search-sync-user-password-CHANGE-ME"
16
17export OPERATOR_HELM_CHART="mongodb/mongodb-kubernetes"
18# comma-separated key=value pairs for additional parameters passed to the helm-chart installing the operator
19export OPERATOR_ADDITIONAL_HELM_VALUES=""
20
21export MDB_CONNECTION_STRING="mongodb://mdb-user:${MDB_USER_PASSWORD}@mdbc-rs-0.mdbc-rs-svc.${MDB_NS}.svc.cluster.local:27017/?replicaSet=mdbc-rs"
2

Conditional. Add the MongoDB Helm repository.

Helm automates the deployment and management of MongoDB instances on Kubernetes. If you already have the Helm repository that contains the Helm chart for installing the Kubernetes Operator operator, or skip this step. Otherwise, add the Helm repository.

To add the Helm repository, copy, paste, and run the following:

1helm repo add mongodb https://mongodb.github.io/helm-charts
2helm repo update mongodb
3helm search repo mongodb/mongodb-kubernetes
1"mongodb" has been added to your repositories
2Hang tight while we grab the latest from your chart repositories...
3...Successfully got an update from the "mongodb" chart repository
4Update Complete. ⎈Happy Helming!⎈
5NAME                      	CHART VERSION	APP VERSION	DESCRIPTION                                       
6mongodb/mongodb-kubernetes	1.5.0        	           	MongoDB Controllers for Kubernetes translate th...
3

Conditional. Install the MongoDB Controllers for Kubernetes Operator.

The Kubernetes Operator watches MongoDBCommunity and MongoDBSearch custom resources and manages the lifecycle of your MongoDB deployments. If you already installed the MongoDB Controllers for Kubernetes Operator, skip this step. Otherwise, install the MongoDB Controllers for Kubernetes Operator from the Helm repository you added in the previous step.

To install the MongoDB Controllers for Kubernetes Operator in the mongodb namespace, copy, paste, and run the following commands:

1helm upgrade --install --debug --kube-context "${K8S_CTX}" \
2  --create-namespace \
3  --namespace="${MDB_NS}" \
4  mongodb-kubernetes \
5  ${OPERATOR_ADDITIONAL_HELM_VALUES:+--set ${OPERATOR_ADDITIONAL_HELM_VALUES}} \
6  "${OPERATOR_HELM_CHART}"
1Release "mongodb-kubernetes" does not exist. Installing it now.
2NAME: mongodb-kubernetes
3LAST DEPLOYED: Wed Oct 15 09:35:29 2025
4NAMESPACE: mongodb
5STATUS: deployed
6REVISION: 1
7TEST SUITE: None
8USER-SUPPLIED VALUES:
9{}
10
11COMPUTED VALUES:
12agent:
13  name: mongodb-agent
14  version: 108.0.12.8846-1
15community:
16  agent:
17    name: mongodb-agent
18    version: 108.0.2.8729-1
19  mongodb:
20    imageType: ubi8
21    name: mongodb-community-server
22    repo: quay.io/mongodb
23  registry:
24    agent: quay.io/mongodb
25  resource:
26    members: 3
27    name: mongodb-replica-set
28    tls:
29      caCertificateSecretRef: tls-ca-key-pair
30      certManager:
31        certDuration: 8760h
32        renewCertBefore: 720h
33      certificateKeySecretRef: tls-certificate
34      enabled: false
35      sampleX509User: false
36      useCertManager: true
37      useX509: false
38    version: 4.4.0
39database:
40  name: mongodb-kubernetes-database
41  version: 1.5.0
42initAppDb:
43  name: mongodb-kubernetes-init-appdb
44  version: 1.5.0
45initDatabase:
46  name: mongodb-kubernetes-init-database
47  version: 1.5.0
48initOpsManager:
49  name: mongodb-kubernetes-init-ops-manager
50  version: 1.5.0
51managedSecurityContext: false
52mongodb:
53  appdbAssumeOldFormat: false
54  imageType: ubi8
55  name: mongodb-enterprise-server
56  repo: quay.io/mongodb
57multiCluster:
58  clusterClientTimeout: 10
59  clusters: []
60  kubeConfigSecretName: mongodb-enterprise-operator-multi-cluster-kubeconfig
61  performFailOver: true
62operator:
63  additionalArguments: []
64  affinity: {}
65  baseName: mongodb-kubernetes
66  createOperatorServiceAccount: true
67  createResourcesServiceAccountsAndRoles: true
68  deployment_name: mongodb-kubernetes-operator
69  enableClusterMongoDBRoles: true
70  enablePVCResize: true
71  env: prod
72  maxConcurrentReconciles: 1
73  mdbDefaultArchitecture: non-static
74  name: mongodb-kubernetes-operator
75  nodeSelector: {}
76  operator_image_name: mongodb-kubernetes
77  replicas: 1
78  resources:
79    limits:
80      cpu: 1100m
81      memory: 1Gi
82    requests:
83      cpu: 500m
84      memory: 200Mi
85  telemetry:
86    collection:
87      clusters: {}
88      deployments: {}
89      frequency: 1h
90      operators: {}
91    send:
92      frequency: 168h
93  tolerations: []
94  vaultSecretBackend:
95    enabled: false
96    tlsSecretRef: ""
97  version: 1.5.0
98  watchedResources:
99  - mongodb
100  - opsmanagers
101  - mongodbusers
102  - mongodbcommunity
103  - mongodbsearch
104  webhook:
105    installClusterRole: true
106    registerConfiguration: true
107opsManager:
108  name: mongodb-enterprise-ops-manager-ubi
109readinessProbe:
110  name: mongodb-kubernetes-readinessprobe
111  version: 1.0.23
112registry:
113  agent: quay.io/mongodb
114  database: quay.io/mongodb
115  imagePullSecrets: null
116  initAppDb: quay.io/mongodb
117  initDatabase: quay.io/mongodb
118  initOpsManager: quay.io/mongodb
119  operator: quay.io/mongodb
120  opsManager: quay.io/mongodb
121  pullPolicy: Always
122  readinessProbe: quay.io/mongodb
123  versionUpgradeHook: quay.io/mongodb
124search:
125  name: mongodb-search
126  repo: quay.io/mongodb
127  version: 0.53.1
128versionUpgradeHook:
129  name: mongodb-kubernetes-operator-version-upgrade-post-start-hook
130  version: 1.0.10
131
132HOOKS:
133MANIFEST:
134---
135# Source: mongodb-kubernetes/templates/database-roles.yaml
136apiVersion: v1
137kind: ServiceAccount
138metadata:
139  name: mongodb-kubernetes-appdb
140  namespace: mongodb
141---
142# Source: mongodb-kubernetes/templates/database-roles.yaml
143apiVersion: v1
144kind: ServiceAccount
145metadata:
146  name: mongodb-kubernetes-database-pods
147  namespace: mongodb
148---
149# Source: mongodb-kubernetes/templates/database-roles.yaml
150apiVersion: v1
151kind: ServiceAccount
152metadata:
153  name: mongodb-kubernetes-ops-manager
154  namespace: mongodb
155---
156# Source: mongodb-kubernetes/templates/operator-sa.yaml
157apiVersion: v1
158kind: ServiceAccount
159metadata:
160  name: mongodb-kubernetes-operator
161  namespace: mongodb
162---
163# Source: mongodb-kubernetes/templates/operator-roles-clustermongodbroles.yaml
164kind: ClusterRole
165apiVersion: rbac.authorization.k8s.io/v1
166metadata:
167  name: mongodb-kubernetes-operator-mongodb-cluster-mongodb-role
168rules:
169  - apiGroups:
170      - mongodb.com
171    verbs:
172      - '*'
173    resources:
174      - clustermongodbroles
175---
176# Source: mongodb-kubernetes/templates/operator-roles-telemetry.yaml
177# Additional ClusterRole for clusterVersionDetection
178kind: ClusterRole
179apiVersion: rbac.authorization.k8s.io/v1
180metadata:
181  name: mongodb-kubernetes-operator-cluster-telemetry
182rules:
183  # Non-resource URL permissions
184  - nonResourceURLs:
185      - "/version"
186    verbs:
187      - get
188  # Cluster-scoped resource permissions
189  - apiGroups:
190      - ''
191    resources:
192      - namespaces
193    resourceNames:
194      - kube-system
195    verbs:
196      - get
197  - apiGroups:
198      - ''
199    resources:
200      - nodes
201    verbs:
202      - list
203---
204# Source: mongodb-kubernetes/templates/operator-roles-webhook.yaml
205kind: ClusterRole
206apiVersion: rbac.authorization.k8s.io/v1
207metadata:
208  name: mongodb-kubernetes-operator-mongodb-webhook-cr
209rules:
210  - apiGroups:
211      - "admissionregistration.k8s.io"
212    resources:
213      - validatingwebhookconfigurations
214    verbs:
215      - get
216      - create
217      - update
218      - delete
219  - apiGroups:
220      - ""
221    resources:
222      - services
223    verbs:
224      - get
225      - list
226      - watch
227      - create
228      - update
229      - delete
230---
231# Source: mongodb-kubernetes/templates/operator-roles-clustermongodbroles.yaml
232kind: ClusterRoleBinding
233apiVersion: rbac.authorization.k8s.io/v1
234metadata:
235  name: mongodb-kubernetes-operator-mongodb-cluster-mongodb-role-binding
236roleRef:
237  apiGroup: rbac.authorization.k8s.io
238  kind: ClusterRole
239  name: mongodb-kubernetes-operator-mongodb-cluster-mongodb-role
240subjects:
241  - kind: ServiceAccount
242    name: mongodb-kubernetes-operator
243    namespace: mongodb
244---
245# Source: mongodb-kubernetes/templates/operator-roles-telemetry.yaml
246# ClusterRoleBinding for clusterVersionDetection
247kind: ClusterRoleBinding
248apiVersion: rbac.authorization.k8s.io/v1
249metadata:
250  name: mongodb-kubernetes-operator-mongodb-cluster-telemetry-binding
251roleRef:
252  apiGroup: rbac.authorization.k8s.io
253  kind: ClusterRole
254  name: mongodb-kubernetes-operator-cluster-telemetry
255subjects:
256  - kind: ServiceAccount
257    name: mongodb-kubernetes-operator
258    namespace: mongodb
259---
260# Source: mongodb-kubernetes/templates/operator-roles-webhook.yaml
261kind: ClusterRoleBinding
262apiVersion: rbac.authorization.k8s.io/v1
263metadata:
264  name: mongodb-kubernetes-operator-mongodb-webhook-crb
265roleRef:
266  apiGroup: rbac.authorization.k8s.io
267  kind: ClusterRole
268  name: mongodb-kubernetes-operator-mongodb-webhook-cr
269subjects:
270  - kind: ServiceAccount
271    name: mongodb-kubernetes-operator
272    namespace: mongodb
273---
274# Source: mongodb-kubernetes/templates/database-roles.yaml
275kind: Role
276apiVersion: rbac.authorization.k8s.io/v1
277metadata:
278  name: mongodb-kubernetes-appdb
279  namespace: mongodb
280rules:
281  - apiGroups:
282      - ''
283    resources:
284      - secrets
285    verbs:
286      - get
287  - apiGroups:
288      - ''
289    resources:
290      - pods
291    verbs:
292      - patch
293      - delete
294      - get
295---
296# Source: mongodb-kubernetes/templates/operator-roles-base.yaml
297kind: Role
298apiVersion: rbac.authorization.k8s.io/v1
299metadata:
300  name: mongodb-kubernetes-operator
301  namespace: mongodb
302rules:
303  - apiGroups:
304      - ''
305    resources:
306      - services
307    verbs:
308      - get
309      - list
310      - watch
311      - create
312      - update
313      - delete
314  - apiGroups:
315      - ''
316    resources:
317      - secrets
318      - configmaps
319    verbs:
320      - get
321      - list
322      - create
323      - update
324      - delete
325      - watch
326  - apiGroups:
327      - apps
328    resources:
329      - statefulsets
330    verbs:
331      - create
332      - get
333      - list
334      - watch
335      - delete
336      - update
337  - apiGroups:
338      - ''
339    resources:
340      - pods
341    verbs:
342      - get
343      - list
344      - watch
345      - delete
346      - deletecollection
347  - apiGroups:
348      - mongodbcommunity.mongodb.com
349    resources:
350      - mongodbcommunity
351      - mongodbcommunity/status
352      - mongodbcommunity/spec
353      - mongodbcommunity/finalizers
354    verbs:
355      - '*'
356  - apiGroups:
357      - mongodb.com
358    verbs:
359      - '*'
360    resources:
361      - mongodb
362      - mongodb/finalizers
363      - mongodbusers
364      - mongodbusers/finalizers
365      - opsmanagers
366      - opsmanagers/finalizers
367      - mongodbmulticluster
368      - mongodbmulticluster/finalizers
369      - mongodbsearch
370      - mongodbsearch/finalizers
371      - mongodb/status
372      - mongodbusers/status
373      - opsmanagers/status
374      - mongodbmulticluster/status
375      - mongodbsearch/status
376---
377# Source: mongodb-kubernetes/templates/operator-roles-pvc-resize.yaml
378kind: Role
379apiVersion: rbac.authorization.k8s.io/v1
380metadata:
381  name: mongodb-kubernetes-operator-pvc-resize
382  namespace: mongodb
383rules:
384  - apiGroups:
385      - ''
386    resources:
387      - persistentvolumeclaims
388    verbs:
389      - get
390      - delete
391      - list
392      - watch
393      - patch
394      - update
395---
396# Source: mongodb-kubernetes/templates/database-roles.yaml
397kind: RoleBinding
398apiVersion: rbac.authorization.k8s.io/v1
399metadata:
400  name: mongodb-kubernetes-appdb
401  namespace: mongodb
402roleRef:
403  apiGroup: rbac.authorization.k8s.io
404  kind: Role
405  name: mongodb-kubernetes-appdb
406subjects:
407  - kind: ServiceAccount
408    name: mongodb-kubernetes-appdb
409    namespace: mongodb
410---
411# Source: mongodb-kubernetes/templates/operator-roles-base.yaml
412kind: RoleBinding
413apiVersion: rbac.authorization.k8s.io/v1
414metadata:
415  name: mongodb-kubernetes-operator
416  namespace: mongodb
417roleRef:
418  apiGroup: rbac.authorization.k8s.io
419  kind: Role
420  name: mongodb-kubernetes-operator
421subjects:
422  - kind: ServiceAccount
423    name: mongodb-kubernetes-operator
424    namespace: mongodb
425---
426# Source: mongodb-kubernetes/templates/operator-roles-pvc-resize.yaml
427kind: RoleBinding
428apiVersion: rbac.authorization.k8s.io/v1
429metadata:
430  name: mongodb-kubernetes-operator-pvc-resize-binding
431  namespace: mongodb
432roleRef:
433  apiGroup: rbac.authorization.k8s.io
434  kind: Role
435  name: mongodb-kubernetes-operator-pvc-resize
436subjects:
437  - kind: ServiceAccount
438    name: mongodb-kubernetes-operator
439    namespace: mongodb
440---
441# Source: mongodb-kubernetes/templates/operator.yaml
442apiVersion: apps/v1
443kind: Deployment
444metadata:
445  name: mongodb-kubernetes-operator
446  namespace: mongodb
447spec:
448  replicas: 1
449  selector:
450    matchLabels:
451      app.kubernetes.io/component: controller
452      app.kubernetes.io/name: mongodb-kubernetes-operator
453      app.kubernetes.io/instance: mongodb-kubernetes-operator
454  template:
455    metadata:
456      labels:
457        app.kubernetes.io/component: controller
458        app.kubernetes.io/name: mongodb-kubernetes-operator
459        app.kubernetes.io/instance: mongodb-kubernetes-operator
460    spec:
461      serviceAccountName: mongodb-kubernetes-operator
462      securityContext:
463        runAsNonRoot: true
464        runAsUser: 2000
465      containers:
466        - name: mongodb-kubernetes-operator
467          image: "quay.io/mongodb/mongodb-kubernetes:1.5.0"
468          imagePullPolicy: Always
469          args:
470            - -watch-resource=mongodb
471            - -watch-resource=opsmanagers
472            - -watch-resource=mongodbusers
473            - -watch-resource=mongodbcommunity
474            - -watch-resource=mongodbsearch
475            - -watch-resource=clustermongodbroles
476          command:
477            - /usr/local/bin/mongodb-kubernetes-operator
478          resources:
479            limits:
480              cpu: 1100m
481              memory: 1Gi
482            requests:
483              cpu: 500m
484              memory: 200Mi
485          env:
486            - name: OPERATOR_ENV
487              value: prod
488            - name: MDB_DEFAULT_ARCHITECTURE
489              value: non-static
490            - name: NAMESPACE
491              valueFrom:
492                fieldRef:
493                  fieldPath: metadata.namespace
494            - name: WATCH_NAMESPACE
495              valueFrom:
496                fieldRef:
497                  fieldPath: metadata.namespace
498            - name: MDB_OPERATOR_TELEMETRY_COLLECTION_FREQUENCY
499              value: "1h"
500            - name: MDB_OPERATOR_TELEMETRY_SEND_FREQUENCY
501              value: "168h"
502            - name: CLUSTER_CLIENT_TIMEOUT
503              value: "10"
504            - name: IMAGE_PULL_POLICY
505              value: Always
506            # Database
507            - name: MONGODB_ENTERPRISE_DATABASE_IMAGE
508              value: quay.io/mongodb/mongodb-kubernetes-database
509            - name: INIT_DATABASE_IMAGE_REPOSITORY
510              value: quay.io/mongodb/mongodb-kubernetes-init-database
511            - name: INIT_DATABASE_VERSION
512              value: 1.5.0
513            - name: DATABASE_VERSION
514              value: 1.5.0
515            # Ops Manager
516            - name: OPS_MANAGER_IMAGE_REPOSITORY
517              value: quay.io/mongodb/mongodb-enterprise-ops-manager-ubi
518            - name: INIT_OPS_MANAGER_IMAGE_REPOSITORY
519              value: quay.io/mongodb/mongodb-kubernetes-init-ops-manager
520            - name: INIT_OPS_MANAGER_VERSION
521              value: 1.5.0
522            # AppDB
523            - name: INIT_APPDB_IMAGE_REPOSITORY
524              value: quay.io/mongodb/mongodb-kubernetes-init-appdb
525            - name: INIT_APPDB_VERSION
526              value: 1.5.0
527            - name: OPS_MANAGER_IMAGE_PULL_POLICY
528              value: Always
529            - name: AGENT_IMAGE
530              value: "quay.io/mongodb/mongodb-agent:108.0.12.8846-1"
531            - name: MDB_AGENT_IMAGE_REPOSITORY
532              value: "quay.io/mongodb/mongodb-agent"
533            - name: MONGODB_IMAGE
534              value: mongodb-enterprise-server
535            - name: MONGODB_REPO_URL
536              value: quay.io/mongodb
537            - name: MDB_IMAGE_TYPE
538              value: ubi8
539            - name: PERFORM_FAILOVER
540              value: 'true'
541            - name: MDB_MAX_CONCURRENT_RECONCILES
542              value: "1"
543            - name: POD_NAME
544              valueFrom:
545                fieldRef:
546                  fieldPath: metadata.name
547            - name: OPERATOR_NAME
548              value: mongodb-kubernetes-operator
549            # Community Env Vars Start
550            - name: MDB_COMMUNITY_AGENT_IMAGE
551              value: "quay.io/mongodb/mongodb-agent:108.0.2.8729-1"
552            - name: VERSION_UPGRADE_HOOK_IMAGE
553              value: "quay.io/mongodb/mongodb-kubernetes-operator-version-upgrade-post-start-hook:1.0.10"
554            - name: READINESS_PROBE_IMAGE
555              value: "quay.io/mongodb/mongodb-kubernetes-readinessprobe:1.0.23"
556            - name: MDB_COMMUNITY_IMAGE
557              value: "mongodb-community-server"
558            - name: MDB_COMMUNITY_REPO_URL
559              value: "quay.io/mongodb"
560            - name: MDB_COMMUNITY_IMAGE_TYPE
561              value: "ubi8"
562            # Community Env Vars End
563            - name: MDB_SEARCH_REPO_URL
564              value: "quay.io/mongodb"
565            - name: MDB_SEARCH_NAME
566              value: "mongodb-search"
567            - name: MDB_SEARCH_VERSION
568              value: "0.53.1"
4

Required. Create and load the MongoDB user secrets.

MongoDB requires authentication for secure access. In this step, you create three Kubernetes secrets:

  • mdb-admin-user-password: Credentials for the MongoDB administrator.

  • mdb-user-password: Credentials for the user authorized to perform search queries.

  • mdbc-rs-search-sync-source-password: Credentials for a dedicated search user used internally by the mongot process to synchronize data and manage indexes.

Kubernetes Operator uses passwords from those secrets to automatically create the users in the MongoDB database.

To create the secrets, copy, paste, and run the following command:

1kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
2  create secret generic mdb-admin-user-password \
3  --from-literal=password="${MDB_ADMIN_USER_PASSWORD}"
4
5kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
6  create secret generic mdbc-rs-search-sync-source-password \
7  --from-literal=password="${MDB_SEARCH_SYNC_USER_PASSWORD}"
8
9kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
10  create secret generic mdb-user-password \
11  --from-literal=password="${MDB_USER_PASSWORD}"
1secret/mdb-admin-user-password created
2secret/mdbc-rs-search-sync-source-password created
3secret/mdb-user-password created
5

Conditional. Create and deploy the MongoDB Community resource.

If you've already deployed the MongoDB Community Edition, skip this step. Otherwise, deploy the MongoDB Community Edition.

To deploy the MongoDB Community Edition, complete the following steps:

  1. Create a MongoDBCommunity custom resource named mdb-rs.

    The resource defines CPU and memory resources for the mongod and mongodb-agent containers, and sets up the following three users:

    mdb-user

    User that can restore database and run search queries. This user uses the mdb-user-password secret to perform these operations.

    search-sync-source

    User that MongoDB Search uses to connect to MongoDB database in order to manage and build indexes. This user uses searchCoordinator role that the Kubernetes operator creates. This uses uses the mdbc-rs-search-sync-source-password secret to connect mongot to mongod.

    admin-user

    Database admin user.

    The Kubernetes Operator uses this resource to configure a MongoDB replica set with 3 members.

    To create the secrets, copy, paste, and run the following commands:

    1kubectl apply --context "${K8S_CTX}" -n "${MDB_NS}" -f - <<EOF
    2apiVersion: mongodbcommunity.mongodb.com/v1
    3kind: MongoDBCommunity
    4metadata:
    5  name: mdbc-rs
    6spec:
    7  version: ${MDB_VERSION}
    8  type: ReplicaSet
    9  members: 3
    10  security:
    11    authentication:
    12      ignoreUnknownUsers: true
    13      modes:
    14        - SCRAM
    15  agent:
    16    logLevel: DEBUG
    17  statefulSet:
    18    spec:
    19      template:
    20        spec:
    21          containers:
    22            - name: mongod
    23              resources:
    24                limits:
    25                  cpu: "2"
    26                  memory: 2Gi
    27                requests:
    28                  cpu: "1"
    29                  memory: 1Gi
    30            - name: mongodb-agent
    31              resources:
    32                limits:
    33                  cpu: "1"
    34                  memory: 2Gi
    35                requests:
    36                  cpu: "0.5"
    37                  memory: 1Gi
    38  users:
    39    # admin user with root role
    40    - name: mdb-admin
    41      db: admin
    42      # a reference to the secret containing user password
    43      passwordSecretRef:
    44        name: mdb-admin-user-password
    45      scramCredentialsSecretName: mdb-admin-user
    46      roles:
    47        - name: root
    48          db: admin
    49    # user performing search queries
    50    - name: mdb-user
    51      db: admin
    52      # a reference to the secret containing user password
    53      passwordSecretRef:
    54        name: mdb-user-password
    55      scramCredentialsSecretName: mdb-user-scram
    56      roles:
    57        - name: restore
    58          db: sample_mflix
    59        - name: readWrite
    60          db: sample_mflix
    61    # user used by MongoDB Search to connect to MongoDB database to
    62    # synchronize data from.
    63    # For MongoDB <8.2, the operator will be creating the
    64    # searchCoordinator custom role automatically.
    65    # From MongoDB 8.2, searchCoordinator role will be a
    66    # built-in role.
    67    - name: search-sync-source
    68      db: admin
    69      # a reference to the secret that will be used to generate the user's password
    70      passwordSecretRef:
    71        name: mdbc-rs-search-sync-source-password
    72      scramCredentialsSecretName: mdbc-rs-search-sync-source
    73      roles:
    74        - name: searchCoordinator
    75          db: admin
    76EOF

  2. Wait for the MongoDBCommunity resource deployment to complete.

    When you apply the MongoDBCommunity custom resource, the Kubernetes operator begins deploying the MongoDB nodes (pods). This step pauses the execution until the mdbc-rs resource's status phase is Running, which indicates that the MongoDB Community replica set is operational.

    1echo "Waiting for MongoDBCommunity resource to reach Running phase..."
    2kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
    3  --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
    4echo; echo "MongoDBCommunity resource"
    5kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get mdbc/mdbc-rs
    6echo; echo "Pods running in cluster ${K8S_CTX}"
    7kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get pods
    1Waiting for MongoDBCommunity resource to reach Running phase...
    2mongodbcommunity.mongodbcommunity.mongodb.com/mdbc-rs condition met
    3
    4MongoDBCommunity resource
    5NAME      PHASE     VERSION
    6mdbc-rs   Running   8.0.10
    7
    8Pods running in cluster minikube
    9NAME                                           READY   STATUS    RESTARTS   AGE
    10mdbc-rs-0                                      2/2     Running   0          2m30s
    11mdbc-rs-1                                      2/2     Running   0          82s
    12mdbc-rs-2                                      2/2     Running   0          38s
    13mongodb-kubernetes-operator-5776c8b4df-cppnf   1/1     Running   0          7m37s
6

Required. Create and deploy the resource for MongoDB Search and Vector Search.

You can deploy one instance of the search node without any load balancing. To deploy, complete the following steps:

  1. Create a MongoDBSearch custom resource named mdbc-rs.

    This resource specifies the CPU and memory resource requirements for the search nodes. To learn more about the settings in this custom resource, see MongoDB Search and Vector Search Settings.

    1kubectl apply --context "${K8S_CTX}" -n "${MDB_NS}" -f - <<EOF
    2apiVersion: mongodb.com/v1
    3kind: MongoDBSearch
    4metadata:
    5  name: mdbc-rs
    6spec:
    7  resourceRequirements:
    8    limits:
    9      cpu: "3"
    10      memory: 5Gi
    11    requests:
    12      cpu: "2"
    13      memory: 3Gi
    14EOF

  2. Wait for the MongoDBSearch resource deployment to complete.

    When you apply the MongoDBSearch custom resource, the Kubernetes operator begins deploying the search nodes (pods). This step pauses the execution until the mdbc-rs MongoDBSearch resource's status phase is Running, which indicates that the MongoDB Search is operational.

    1echo "Waiting for MongoDBSearch resource to reach Running phase..."
    2kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
    3  --for=jsonpath='{.status.phase}'=Running mdbs/mdbc-rs --timeout=300s
7

Optional. Verify the MongoDB Community resource status.

Ensure that the MongoDBCommunity resource deployment with MongoDBSearch was successful.

1echo "Waiting for MongoDBCommunity resource to reach Running phase..."
2kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
3  --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
8

Optional. View all the running pods in your namespace.

View all the running pods in your namespace pods for the MongoDB replica set members, the MongoDB Controllers for Kubernetes Operator, and the Search nodes.

1echo; echo "MongoDBCommunity resource"
2kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get mdbc/mdbc-rs
3echo; echo "MongoDBSearch resource"
4kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get mdbs/mdbc-rs
5echo; echo "Pods running in cluster ${K8S_CTX}"
6kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get pods
1MongoDBCommunity resource
2NAME      PHASE     VERSION
3mdbc-rs   Running   8.2.0
4
5MongoDBSearch resource
6NAME      PHASE     AGE
7mdbc-rs   Running   5m11s
8
9Pods running in cluster kind-kind
10NAME                                           READY   STATUS    RESTARTS       AGE
11mdbc-rs-0                                      2/2     Running   1 (28s ago)    7m42s
12mdbc-rs-1                                      2/2     Running   1 (3m2s ago)   6m32s
13mdbc-rs-2                                      2/2     Running   1 (105s ago)   5m45s
14mdbc-rs-search-0                               1/1     Running   0              5m11s
15mongodb-kubernetes-operator-57c6f46b47-6kthd   1/1     Running   0              7m46s

Next Steps

Now that you've successfully deployed MongoDB Search and Vector Search to use with MongoDB Community Edition, proceed to add data into your MongoDB cluster, create MongoDB Search and Vector Search indexes, and run queries agaist your data. To learn more, see Use MongoDB Search and Vector Search.

On this page