From ed87bf892a89a238d2098042b31773f0d439e162 Mon Sep 17 00:00:00 2001 From: Rounak Dhillon <162090200+RounakDhillon@users.noreply.github.com> Date: Mon, 24 Mar 2025 18:14:53 +0530 Subject: [PATCH] Docs: Docker Example Removal from Docker (#20396) Co-authored-by: Rounak Dhillon --- .../deployment/backup-restore-metadata.md | 68 ------------------- .../deployment/backup-restore-metadata.md | 68 ------------------- 2 files changed, 136 deletions(-) diff --git a/openmetadata-docs/content/v1.6.x/deployment/backup-restore-metadata.md b/openmetadata-docs/content/v1.6.x/deployment/backup-restore-metadata.md index 306423cf28f..2be4646de43 100644 --- a/openmetadata-docs/content/v1.6.x/deployment/backup-restore-metadata.md +++ b/openmetadata-docs/content/v1.6.x/deployment/backup-restore-metadata.md @@ -51,71 +51,3 @@ It's important that when you backup your database, you keep the snapshot safe in You can check these two examples on how to: - Use pipes to stream the result directly to S3 (or AWS blob storage) ([link](https://devcoops.com/pg_dump-to-s3-directly/?utm_content=cmp-true)). - Dump to a file and copy to storage ([link](https://gist.github.com/bbcoimbra/0914c7e0f96e8ad53dfad79c64863c87)). - -# Example with Docker - -Start a local instance of OpenMetadata using the `docker-compose` file provided in the repository. Then, we can use the following commands to backup the metadata: - -## MySQL - -### 1. Start a local docker deployment - -```shell -docker/run_local_docker.sh -``` - -Ingest some data... - -### 2. Backup and Restore - -```shell -BACKUP_FILE="backup_$(date +%Y%m%d%H%M).sql" -export COMPOSE_FILE="docker/development/docker-compose.yml" -# backup -docker compose exec ingestion mysqldump --no-tablespaces -u openmetadata_user -popenmetadata_password -h mysql -P 3306 openmetadata_db > $BACKUP_FILE -# create the restore database -docker compose exec mysql mysql -u root -ppassword -e "create database restore;" -docker compose exec mysql mysql -u root -ppassword -e "grant all privileges on restore.* to 'openmetadata_user'@'%';" -docker compose exec mysql mysql -u root -ppassword -e "GRANT SUPER, SYSTEM_VARIABLES_ADMIN, SESSION_VARIABLES_ADMIN ON *.* TO 'openmetadata_user'@'%';" -docker compose exec mysql mysql -u root -ppassword -e "flush privileges;" -# restore from the backup -docker compose exec -T ingestion mysql -u openmetadata_user -popenmetadata_password -h mysql -P 3306 restore < $BACKUP_FILE -``` - -### 3. Restart the docker deployment with the restored database - -```shell -export OM_DATABASE=restore -docker compose -f $DOCKER_COMPOSE_FILE up -d -``` - -## PostgreSQL - -### 1. Start a local docker deployment - -```shell -docker/run_local_docker.sh -d postgres -``` - -Ingest some data... - -### 2. Backup and Restore - -```shell -BACKUP_FILE="backup_$(date +%Y%m%d%H%M).sql" -export COMPOSE_FILE="docker/development/docker-compose-postgres.yml" -# backup -docker compose exec -e PGPASSWORD=openmetadata_password ingestion pg_dump -U openmetadata_user -h postgresql -d openmetadata_db > $BACKUP_FILE -# create the restore database -docker compose exec -e PGPASSWORD=openmetadata_password postgresql psql -U postgres -c "create database restore;" -docker compose exec -e PGPASSWORD=openmetadata_password postgresql psql -U postgres -c "ALTER DATABASE restore OWNER TO openmetadata_user;" -# restore from the backup -docker compose exec -e PGPASSWORD=openmetadata_password -T ingestion psql -U openmetadata_user -h postgresql -d restore < $BACKUP_FILE -``` - -### 3. Restart the docker deployment with the restored database - -```shell -export OM_DATABASE=restore -docker compose -f $DOCKER_COMPOSE_FILE up -d -``` diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/backup-restore-metadata.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/backup-restore-metadata.md index 306423cf28f..2be4646de43 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/backup-restore-metadata.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/backup-restore-metadata.md @@ -51,71 +51,3 @@ It's important that when you backup your database, you keep the snapshot safe in You can check these two examples on how to: - Use pipes to stream the result directly to S3 (or AWS blob storage) ([link](https://devcoops.com/pg_dump-to-s3-directly/?utm_content=cmp-true)). - Dump to a file and copy to storage ([link](https://gist.github.com/bbcoimbra/0914c7e0f96e8ad53dfad79c64863c87)). - -# Example with Docker - -Start a local instance of OpenMetadata using the `docker-compose` file provided in the repository. Then, we can use the following commands to backup the metadata: - -## MySQL - -### 1. Start a local docker deployment - -```shell -docker/run_local_docker.sh -``` - -Ingest some data... - -### 2. Backup and Restore - -```shell -BACKUP_FILE="backup_$(date +%Y%m%d%H%M).sql" -export COMPOSE_FILE="docker/development/docker-compose.yml" -# backup -docker compose exec ingestion mysqldump --no-tablespaces -u openmetadata_user -popenmetadata_password -h mysql -P 3306 openmetadata_db > $BACKUP_FILE -# create the restore database -docker compose exec mysql mysql -u root -ppassword -e "create database restore;" -docker compose exec mysql mysql -u root -ppassword -e "grant all privileges on restore.* to 'openmetadata_user'@'%';" -docker compose exec mysql mysql -u root -ppassword -e "GRANT SUPER, SYSTEM_VARIABLES_ADMIN, SESSION_VARIABLES_ADMIN ON *.* TO 'openmetadata_user'@'%';" -docker compose exec mysql mysql -u root -ppassword -e "flush privileges;" -# restore from the backup -docker compose exec -T ingestion mysql -u openmetadata_user -popenmetadata_password -h mysql -P 3306 restore < $BACKUP_FILE -``` - -### 3. Restart the docker deployment with the restored database - -```shell -export OM_DATABASE=restore -docker compose -f $DOCKER_COMPOSE_FILE up -d -``` - -## PostgreSQL - -### 1. Start a local docker deployment - -```shell -docker/run_local_docker.sh -d postgres -``` - -Ingest some data... - -### 2. Backup and Restore - -```shell -BACKUP_FILE="backup_$(date +%Y%m%d%H%M).sql" -export COMPOSE_FILE="docker/development/docker-compose-postgres.yml" -# backup -docker compose exec -e PGPASSWORD=openmetadata_password ingestion pg_dump -U openmetadata_user -h postgresql -d openmetadata_db > $BACKUP_FILE -# create the restore database -docker compose exec -e PGPASSWORD=openmetadata_password postgresql psql -U postgres -c "create database restore;" -docker compose exec -e PGPASSWORD=openmetadata_password postgresql psql -U postgres -c "ALTER DATABASE restore OWNER TO openmetadata_user;" -# restore from the backup -docker compose exec -e PGPASSWORD=openmetadata_password -T ingestion psql -U openmetadata_user -h postgresql -d restore < $BACKUP_FILE -``` - -### 3. Restart the docker deployment with the restored database - -```shell -export OM_DATABASE=restore -docker compose -f $DOCKER_COMPOSE_FILE up -d -```