MongoDB

The MongoDB integration allows Plakar Control Plane to back up and restore the contents of a MongoDB server. Plakar connects to a running server and drives the MongoDB command line utilities, so a snapshot is a logical export of the server rather than a copy of its data files, and a reachable server is required for both backup and restore.

Inventory Management

Currently no managed inventory has the capability of discovering MongoDB resources. You need to set up a self-managed inventory before adding a MongoDB resource.

Adding MongoDB as a resource

When using a self-managed inventory, you must register your resources manually or import them from a CSV file.

To add a MongoDB server as a resource, use Database as the class and leave the subclass empty. For the endpoint, use the hostname or IP address of the MongoDB server. See resources documentation for more information on how to set up resources on a self-managed inventory.

Backup flow

flowchart TD
  subgraph MongoDB["MongoDB Server"]
    DB["Databases"]
  end

  subgraph Plakar["Plakar Control Plane"]
    Source["MongoDB
Source app"] Backup["Backup process
Encrypt & deduplicate"] end Store["Kloset Store"] Source -->|"mongodump"| DB DB --> Source Source --> Backup Backup --> Store

Restore flow

flowchart TD
  Store["Kloset Store"]

  subgraph Plakar["Plakar Control Plane"]
    Destination["MongoDB
Destination app"] Restore["Restore process"] end subgraph MongoDB["MongoDB Server"] DB["Databases"] end Store --> Restore Destination --> Restore Restore -->|"mongorestore"| DB

Shared configuration

The following settings are available when configuring both source and destination apps.

  • Password: Required. The password used to authenticate to MongoDB.
  • Port: The MongoDB server port. Defaults to 27017.
  • Use Tls: Use an encrypted TLS/SSL connection.
  • Username: Required. The username used to authenticate to MongoDB.