Getting Started

MariaDB Backup to S3 is a utility service that exports a MariaDB database and uploads the backup to an S3-compatible object storage bucket. Run it as a one-off instance whenever you need a point-in-time snapshot, or schedule it alongside your MariaDB deployment for regular backups. Available in Eyevinn Open Source Cloud.

Prerequisites

  • If you have not already done so, sign up for an OSC account.
  • A running MariaDB instance in OSC (or any externally hosted MariaDB/MySQL server).
  • An S3-compatible bucket (AWS S3, MinIO, etc.) with write access.

Step 1: Store credentials as secrets

Navigate to the MariaDB Backup to S3 service, open the Service Secrets tab, and create secrets for your sensitive values. At minimum create one for the MariaDB connection URL:

  • mariadburl — the full MariaDB connection URL, e.g. mysql://root:password@172.232.131.169:10504/mydb

If your S3 bucket uses access-key authentication, also create:

  • awsaccesskeyid — your AWS (or S3-compatible) access key ID
  • awssecretaccesskey — your AWS secret access key

Step 2: Create the backup instance

Click Create mariadb-backup-s3 and fill in:

Field Description Example
Name Identifier for this backup run mydb-backup-20250513
MariaDbUrl Connection URL to the MariaDB server {{secrets.mariadburl}}
cmdLineArgs Arguments passed to the backup command — include the S3 destination path --all-databases s3://my-bucket/backups/
awsAccessKeyId S3 access key ID (optional) {{secrets.awsaccesskeyid}}
awsSecretAccessKey S3 secret access key (optional) {{secrets.awssecretaccesskey}}
awsSessionToken Temporary session token (optional, for IAM role-based access)
awsRegion AWS region of the bucket (optional) eu-west-1

Click Create and the instance will run the backup. Once it completes the instance status will show as stopped — this is expected; the service exits after the backup finishes.

CLI Usage

npx -y @osaas/cli create birme-mariadb-backup-s3 mydb-backup \
  -o MariaDbUrl="{{secrets.mariadburl}}" \
  -o cmdLineArgs="--all-databases s3://my-bucket/backups/" \
  -o awsAccessKeyId="{{secrets.awsaccesskeyid}}" \
  -o awsSecretAccessKey="{{secrets.awssecretaccesskey}}" \
  -o awsRegion="eu-west-1"

Resources