backup-mongodb-s3

Simple script for backing up a MongoDB database to an S3 (minio) bucket.

Configuration

• Supports custom S3 endpoints (e.g. minio)
• Uses piping instead of tmp file
• Compression is done with gzip
• Creates bucket if it's not created
• Can be run in Kubernetes or Docker

Configuration

# Required environment variables
MONGODB_URI='mongodb://root:password@mongodb:27017/?authSource=admin'
MINIO_ENDPOINT='http://localhost:9000'
MINIO_ACCESS_KEY='minioadmin'
MINIO_SECRET_KEY='minioadmin'

# Optional variables
MINIO_BUCKET='mongodb-backups'
MINIO_PATH='mongodb-dumps'
MONGODB_READ_PREFERENCE='secondaryPreferred'
RETENTION_PERIOD='7d'
MINIO_COMMAND='mc'
DISCORD_WEBHOOK_URL=''
COLLECTIONS='db.collection1:day:_parent db.collection2:month db.collection3'

Strategies

The script supports different backup strategies for creating partial backups of specific collections. If no collections are defined, a full dump of the mongodb instance will be created (all databases and collections).

The strategies are defined in the COLLECTIONS environment variable as a space-separated list of db.collection:STRATEGY:FIELD pairs. Both :FIELD and :STRATEGY are optional and will default to full and _id respectively.

Supported strategies:

• full: full backup of the collection
• day: [yesterday 00:00, today 00:00)
• week: [Monday of last week 00:00, Monday of this week 00:00)
• month: [1st day of last month 00:00, 1st day of this month 00:00)

The FIELD defines the field used for filtering the documents in the collection (default is _id). This can be changed if a collection references another object which should be used as the filter field (e.g. _parent).

Cron backup with kubernetes

cronjob.yaml:

apiVersion: batch/v1
kind: CronJob
metadata:
  name: backup-mongodb
spec:
  schedule: {{ .Values.backup.mongodb.schedule }}
  timeZone: {{ .Values.backup.mongodb.timeZone }}
  concurrencyPolicy: Replace
  jobTemplate:
    spec:
      parallelism: 1
      template:
        spec:
          restartPolicy: Never
          imagePullSecrets:
            - name: registry-vs
          containers:
            - name: backup-mongodb-s3
              image: {{ .Values.backup.mongodb.image }}
              imagePullPolicy: Always
              env:
                - name: MONGODB_URI
                  valueFrom:
                    secretKeyRef:
                      name: {{ .Values.backup.mongodb.existingSecret }}
                      key: MONGO_URI
                - name: MINIO_BUCKET
                  value: {{ .Values.backup.mongodb.bucket }}
                - name: MINIO_PATH
                  value: {{ .Values.backup.mongodb.path }}
                - name: MINIO_ENDPOINT
                  valueFrom:
                    secretKeyRef:
                      name: {{ .Values.backup.mongodb.existingSecret }}
                      key: minio-endpoint
                - name: MINIO_ACCESS_KEY
                  valueFrom:
                    secretKeyRef:
                      name: {{ .Values.backup.mongodb.existingSecret }}
                      key: minio-access-key
                - name: MINIO_SECRET_KEY
                  valueFrom:
                    secretKeyRef:
                      name: {{ .Values.backup.mongodb.existingSecret }}
                      key: minio-secret-key
                - name: DISCORD_WEBHOOK_URL
                  valueFrom:
                    secretKeyRef:
                      name: {{ .Values.backup.mongodb.existingSecret }}
                      key: discord-webhook-url
                      optional: true
                - name: RETENTION_PERIOD
                  value: {{ .Values.backup.mongodb.keep | quote }}

When not using Helm, replace the placeholders {{ ... }} with appropriate values.