You are looking at the documentation of a prior release. To read the documentation of the latest release, please visit here.

New to KubeDB? Please start here.


What is MongoDBDatabase

MongoDBDatabase is a Kubernetes Custom Resource Definitions (CRD). It provides a declarative way of implementing multitenancy inside KubeDB provisioned MongoDB server. You need to describe the target database, desired database configuration, the vault server reference for managing the user in a MongoDBDatabase object, and the KubeDB Schema Manager operator will create Kubernetes objects in the desired state for you.

MongoDBDatabase Specification

As with all other Kubernetes objects, an MongoDBDatabase needs apiVersion, kind, and metadata fields. It also needs a spec section.

kind: MongoDBDatabase
  name: demo-schema
  namespace: demo
      name: mongodb-server
      namespace: dev
      name: myDB
    name: vault
    namespace: dev
      - kind: ServiceAccount
        name: "tester"
        namespace: "demo"
    defaultTTL: "10m"
    maxTTL: "200h"
    initialized: false
        name: repository
        namespace: demo
      scriptPath: "etc/config"
        name: scripter
            - env:
              - name: "HAVE_A_TRY"
                value: "whoo! It works"
              name: cnt
              image: nginx
               - /bin/sh
               - -c
               - ls
  deletionPolicy: "Delete"


spec.database is a required field specifying the database server reference and the desired database configuration. You need to specify the following fields in spec.database,

  • serverRef refers to the mongodb instance where the particular schema will be applied.
  • config defines the initial configuration of the desired database.

KubeDB accepts the following fields to set in spec.database:

  • serverRef:

    • name
    • namespace
  • config:

    • name


spec.vaultRef is a required field that specifies which KubeVault server to use for user management. You need to specify the following fields in spec.vaultRef,

  • name specifies the name of the Vault server.
  • namespace refers to the namespace where the Vault server is running.


spec.accessPolicy is a required field that specifies the access permissions like which service account or cluster user have the access and for how long they can access through it. You need to specify the following fields in spec.accessPolicy,

  • subjects refers to the user or service account which is allowed to access the credentials.
  • defaultTTL specifies for how long the credential would be valid.
  • maxTTL specifies the maximum time-to-live for the credentials associated with this role.

KubeDB accepts the following fields to set in spec.accessPolicy:

  • subjects:

    • kind
    • name
    • namespace
  • defaultTTL

  • maxTTL


spec.init is an optional field, containing the information of a script or a snapshot using which the database should be initialized during creation. You can only specify either script or snapshot fields in spec.init,

  • script refers to the information regarding the .js file which should be used for initialization.
  • snapshot carries information about the repository and snapshot_id to initialize the database by restoring the snapshot.

KubeDB accepts the following fields to set in spec.init:

  • script:

    • scriptPath accepts a directory location at which the operator should mount the .js file.
    • volumeSource can be secret, configmap, emptyDir, nfs, persistantVolumeClaim, hostPath etc. The referred volume source should carry the .js file in it.
    • podTemplate specifies pod-related details, like environment variables, arguments, images etc.
  • snapshot:

    • repository refers to the repository cr which carries necessary information about the snapshot location .
    • snapshotId refers to the specific snapshot which should be restored .


spec.deletionPolicy is an optional field that gives flexibility whether to nullify (reject) the delete operation.

Next Steps

  • Learn about MongoDB CRD
  • Deploy your first MongoDB database with KubeDB by following the guide here.