In this guide, we will evaluate procedures to backup from Mongo and PostgreSQL databases. This procedure requires that the end-user is comfortable with the common interfacing with the Kubernetes and understands basics of the kubernetes operations.
there is an actively developed guide for backups using Velero for EF-CX solution on kubernetes. This procedure is only valid for manual backup, and doesn't ascertain the continued approach for backup. Velero based backups are considered more appropriate for continuous and effective back solutions. Please refer to Kubernetes Backup/Restore using Velero
Backups
In order to save backups on your local system, create a folder under $HOME/backups
mkdir -p $HOME/backups/{mongo,postgresql}
Mongo Backup
In order to take backup from the current mongo databases, follow these steps
step-1 Run the mongoDB client POD
kubectl run --namespace ef-external --tty -i mongo-mongodb-client --env="MONGODB_ROOT_PASSWORD=$MONGODB_ROOT_PASSWORD" --image docker.io/bitnami/mongodb:6.0.2-debian-11-r1 --command -- sleep infinity
wait for the mongo-client pod to run. Sample run given below
#kubectl get pods -n ef-external mongo-mongodb-client
NAME READY STATUS RESTARTS AGE
mongo-mongodb-client 1/1 Running 0 16s
step-2 Exec into the mongo client pod
kubectl -n ef-external exec -i -t mongo-mongodb-client -- bash
step-3 take the backup of all databases from the current host
mongodump --host "mongo-mongodb" --gzip --out /tmp/mongo-backup-$(date +%Y-%m-%d)
Please note that the path of the backup has to under /tmp folder. the above command will create a folder under /tmp with the date in YYYY-MM-DD appended e-g /tmp/mongo-backup-2023-09-12
exit out of the mongo-client pod
exit
step-4 retrieve the backup file from the POD to actual storage
kubectl -n ef-external cp mongo-mongodb-client:/tmp/mongo-backup-2023-09-12 $HOME/backups/mongo/mongo-backup-2023-09-12
if the above command does not work, replace the mongo-backup-$(date +%Y-%m-%d) with the actual path e-g /tmp/mongo-backup-2023-09-12 as the time/date inside the pod might have a different folder name created
PostgreSQL Backup
For PostgreSQL backups, please follow along these steps.
step-1 export the admin username/password pair for postgresql-client pod
export POSTGRES_ADMIN_PASSWORD=$(kubectl get secret --namespace ef-external ef-postgresql -o jsonpath="{.data.postgres-password}" | base64 -d)
and for sa user ( default user for EF-CX component using PostgreSQL database )
export POSTGRES_PASSWORD=$(kubectl get secret --namespace ef-external ef-postgresql -o jsonpath="{.data.password}" | base64 -d)
step-2 launch the postgresql client
kubectl run ef-postgresql-client --tty -i --namespace ef-external --image docker.io/bitnami/postgresql:14.5.0-debian-11-r21 --env="PGPASSWORD=$POSTGRES_PASSWORD" --command -- sleep infinity
step-3 verify the pod is running
# kubectl -n ef-external get pods "ef-postgresql-client"
NAME READY STATUS RESTARTS AGE
ef-postgresql-client 1/1 Running 15 (15d ago) 120d
step-4 exec into the postgresql-client pod
kubectl -n ef-external exec -it ef-postgresql-client -- bash
step-5 Evolve the pod Env script
execute the environment setup for postgresql-client ( Only needed when the postgresql is running in non-HA mode , like no pgpool and multiple replicas of postgresql are running )
/opt/bitnami/scripts/postgresql/entrypoint.sh /bin/bash
the above step will output something like below:
I have no name!@ef-postgresql-client:/$ /opt/bitnami/scripts/postgresql/entrypoint.sh /bin/bash
postgresql 14:55:10.29
postgresql 14:55:10.29 Welcome to the Bitnami postgresql container
postgresql 14:55:10.30 Subscribe to project updates by watching https://github.com/bitnami/containers
postgresql 14:55:10.30 Submit issues and feature requests at https://github.com/bitnami/containers/issues
postgresql 14:55:10.30
postgres@ef-postgresql-client:/$
step-6 list databases to take backups.
psql --host ef-postgresql -U sa -d licenseManager -p 5432 -q -A -t -c "SELECT datname FROM pg_database"
identify the databases in the first column of the output in previous step and continue with their backup
step-7 Archive the backup
take backup of the keycloak_db and licenseManager Databases.
# keycloak_db database
pg_dump --host ef-postgresql -U sa -F c -b -v -f "/tmp/licenseManager.backup" "licenseManager"
#licenseManager database
pg_dump --host ef-postgresql -U sa -F c -b -v -f "/tmp/keycloak_db.backup" "keycloak_db"
exit the postgresql-client pod
exit; exit
step-8 Restore the backup onto the host
On the host System. once all the databases from the postgresql are backed up succcessfully, exit out of the postgresql client pod and recove the files onto your host system to be further saved at a secure location.
kubectl -n ef-external cp ef-postgresql-client:/tmp/keycloak_db.backup $HOME/backups/postgresql/keycloak_db.backup
kubectl -n ef-external cp ef-postgresql-client:/tmp/licenseManager.backup $HOME/backups/postgresql/licenseManager.backup
Please repeat step7 and step-8 for all required databases if other databases' backup are also required.
Restore
PostgreSQL Restore
step-1 Admin and sa Password
export the admin username/password pair for postgresql-client pod
export POSTGRES_ADMIN_PASSWORD=$(kubectl get secret --namespace ef-external ef-postgresql -o jsonpath="{.data.postgres-password}" | base64 -d)
and for sa user ( default user for EF-CX component using PostgreSQL database )
export POSTGRES_PASSWORD=$(kubectl get secret --namespace ef-external ef-postgresql -o jsonpath="{.data.password}" | base64 -d)
step-2 launch the postgresql client
kubectl run ef-postgresql-client --tty -i --namespace ef-external --image docker.io/bitnami/postgresql:14.5.0-debian-11-r21 --env="PGPASSWORD=$POSTGRES_PASSWORD" --command -- sleep infinity
step-3 verify the pod is running
# kubectl -n ef-external get pods "ef-postgresql-client"
NAME READY STATUS RESTARTS AGE
ef-postgresql-client 1/1 Running 15 (15d ago) 120d
step-4 Copy the dump files from host
Copy all the backup files from the host. Here we are restoring only 2 backups for keycloak_db and licensemanage databases
# keycloak_db database
kubectl -n ef-external cp $HOME/backups/postgresql/keycloak_db.backup ef-postgresql-client:/tmp/keycloak_db.backup
#licenseManager database
kubectl -n ef-external cp $HOME/backups/postgresql/licenseManager.backup ef-postgresql-client:/tmp/licenseManager.backup
step-5exec into the postgresql-client pod
once the pod is running, exec into the postgresql-client pod
kubectl -n ef-external exec -it ef-postgresql-client -- bash
step-6 evolve the env script.
execute the environment setup for postgresql-client ( Only needed when the postgresql is running in non-HA mode , like no pgpool and multiple replicas of postgresql are running )
/opt/bitnami/scripts/postgresql/entrypoint.sh /bin/bash
the above step will output something like below:
I have no name!@ef-postgresql-client:/$ /opt/bitnami/scripts/postgresql/entrypoint.sh /bin/bash
postgresql 14:55:10.29
postgresql 14:55:10.29 Welcome to the Bitnami postgresql container
postgresql 14:55:10.30 Subscribe to project updates by watching https://github.com/bitnami/containers
postgresql 14:55:10.30 Submit issues and feature requests at https://github.com/bitnami/containers/issues
postgresql 14:55:10.30
postgres@ef-postgresql-client:/$
step-7 restore
Restore all databases one by one by running
For keyclock_db;
pg_restore --host ef-postgresql -U sa -d "keycloak_db" -v "/tmp/keycloak_db.backup"
For licenseManager databases, DROP the existing database
dropdb --host ef-postgresql -U sa "licenseManager"
Create the licenseManager Databases with 'sa' user
createdb --host ef-postgresql -U sa "licenseManager"
verify the database is created successfully by running
psql --host ef-postgresql -U sa keycloak_db -p 5432 -t -c "SELECT datname FROM pg_database"
it will display something like below:
postgres@ef-postgresql-client:/tmp$ psql --host ef-postgresql -U sa keycloak_db -p 5432 -t -c "SELECT datname FROM pg_database"
postgres
template1
template0
keycloak_db
superset
Restore the "lienceManager" Database by running
pg_restore --host ef-postgresql -U sa -d "licenseManager" -v "/tmp/licenseManager.backup"
Exit the postgresql-client pod.
exit
Mongo Restore
step-1 Start the client pod
Run the mongoDB client POD
kubectl run --namespace ef-external --tty -i mongo-mongodb-client --env="MONGODB_ROOT_PASSWORD=$MONGODB_ROOT_PASSWORD" --image docker.io/bitnami/mongodb:6.0.2-debian-11-r1 --command -- sleep infinity
wait for the mongo-client pod to run. Sample run given below
#kubectl get pods -n ef-external mongo-mongodb-client
NAME READY STATUS RESTARTS AGE
mongo-mongodb-client 1/1 Running 0 16s
step-2 copy the dump from host
copy the backup into the mongo-client pod
kubectl -n ef-external cp /root/backups/mongo mongo-mongodb-client:/tmp/
step-3 exec into the client pod
Exec into the mongo client pod
kubectl -n ef-external exec -i -t mongo-mongodb-client -- bash
step-4 restore
restore the backup of all databases from the current host
mongorestore --host "mongo-mongodb" --gzip --verbose /tmp/mongo
step-5 Verify the restore
login into the mongodb and verify the databases
mongosh --host "mongo-mongodb"
and run
test> show dbs
step-6 exit the mongo client pod
exit out of the mongo-client pod
exit
/*<![CDATA[*/ div.rbtoc1769167667436 {padding: 0px;} div.rbtoc1769167667436 ul {list-style: disc;margin-left: 0px;} div.rbtoc1769167667436 li {margin-left: 0px;padding-left: 0px;} /*]]>*/ Backups Mongo Backup step-1 Run the mongoDB client POD step-2 Exec into the mongo client pod step-3 take the backup of all databases from the current host step-4 retrieve the backup file from the POD to actual storage PostgreSQL Backup step-1 export the admin username/password pair for postgresql-client pod step-2 launch the postgresql client step-3 verify the pod is running step-4 exec into the postgresql-client pod step-5 Evolve the pod Env script step-6 list databases to take backups. step-7 Archive the backup step-8 Restore the backup onto the host Restore PostgreSQL Restore step-1 Admin and sa Password step-2 launch the postgresql client step-3 verify the pod is running step-4 Copy the dump files from host step-5exec into the postgresql-client pod step-6 evolve the env script. step-7 restore Mongo Restore step-1 Start the client pod step-2 copy the dump from host step-3 exec into the client pod step-4 restore step-5 Verify the restore step-6 exit the mongo client pod