feat: add migrate database from a source to a target databse

fix: gpg encrypt permission warning message, update Kubernetes deployment example
2025-12-06 13:39:41 +01:00 · 2024-08-30 19:58:12 +02:00
parent 8fb008151c
commit 662b73579d
18 changed files with 497 additions and 157 deletions
--- a/docs/how-tos/migrate.md
+++ b/docs/how-tos/migrate.md
@@ -0,0 +1,123 @@
+---
+title: Migrate database
+layout: default
+parent: How Tos
+nav_order: 9
+---
+
+# Migrate database
+
+To migrate the database, you need to add `migrate` command.
+
+{: .note }
+The Mysql backup has another great feature: migrating your database from a source database to another.
+
+As you know, to restore a database from a source to a target database, you need 2 operations: which is to start by backing up the source database and then restoring the source backed database to the target database.
+Instead of proceeding like that, you can use the integrated feature `(migrate)`, which will help you migrate your database by doing only one operation.
+
+
+### Docker compose
+```yml
+services:
+  mysql-bkup:
+    # In production, it is advised to lock your image tag to a proper
+    # release version instead of using `latest`.
+    # Check https://github.com/jkaninda/mysql-bkup/releases
+    # for a list of available releases.
+    image: jkaninda/mysql-bkup
+    container_name: mysql-bkup
+    command: migrate
+    volumes:
+      - ./backup:/backup
+    environment:
+      ## Target database
+      - DB_PORT=3306
+      - DB_HOST=mysql
+      - DB_NAME=database
+      - DB_USERNAME=username
+      - DB_PASSWORD=password
+      ## Source database
+      - SOURCE_DB_HOST=mysql2
+      - SOURCE_DB_PORT=3306
+      - SOURCE_DB_NAME=sourcedb
+      - SOURCE_DB_USERNAME=jonas
+      - SOURCE_DB_PASSWORD=password
+    # mysql-bkup container must be connected to the same network with your database
+    networks:
+      - web
+networks:
+  web:
+```
+
+### Migrate database using Docker CLI
+
+
+```
+## Target database
+DB_PORT=3306
+DB_HOST=mysql
+DB_NAME=targetdb
+DB_USERNAME=targetuser
+DB_PASSWORD=password
+
+## Source database
+SOURCE_DB_HOST=mysql2
+SOURCE_DB_PORT=3306
+SOURCE_DB_NAME=sourcedb
+SOURCE_DB_USERNAME=sourceuser
+SOURCE_DB_PASSWORD=password
+```
+
+```shell
+ docker run --rm --network your_network_name \
+ --env-file your-env
+ -v $PWD/backup:/backup/ \
+ jkaninda/mysql-bkup migrate -d database_name
+```
+
+## Kubernetes
+
+```yaml
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: migrate-db
+spec:
+  ttlSecondsAfterFinished: 100
+  template:
+    spec:
+      containers:
+      - name: mysql-bkup
+        # In production, it is advised to lock your image tag to a proper
+        # release version instead of using `latest`.
+        # Check https://github.com/jkaninda/mysql-bkup/releases
+        # for a list of available releases.
+        image: jkaninda/mysql-bkup
+        command:
+        - /bin/sh
+        - -c
+        - migrate -d targetdb
+        resources:
+          limits:
+            memory: "128Mi"
+            cpu: "500m"
+        env:
+        ## Target DB
+          - name: DB_HOST
+            value: "postgres-target"
+          - name: DB_USERNAME
+            value: "mysql"
+          - name: DB_PASSWORD
+            value: "password"
+          ## Source DB
+          - name: SOURCE_DB_HOST
+            value: "postgres-source"
+          - name: SOURCE_DB_NAME
+            value: "sourcedb"
+          - name: SOURCE_DB_USERNAME
+            value: "postgres"
+          # Please use secret!
+          - name: SOURCE_DB_PASSWORD
+            value: "password"
+      restartPolicy: Never
+```