Add backup script

See merge request !407

.gitignore

@@ -58,3 +58,6 @@ applications/venv-manager/*.clab.yaml
 
 #debug
 __debug_bin
+
+#misc
+*/mongo_backup_*.tar

README.md

@@ -19,6 +19,7 @@ to get all submodules.
 - [Contributing](CONTRIBUTING.md)
 - [License](LICENSE)
 - [CI Status](#ci-status)
+- [Development Tutorial](#development-tutorial)
 
 # Overview
 
@@ -122,3 +123,20 @@ Information about how to use the CLI is provided in the `cli` folder, see [here]
 | ------ | ------ |
 | [![coverage report](https://code.fbi.h-da.de/danet/gosdn/badges/master/coverage.svg)](https://code.fbi.h-da.de/danet/gosdn/-/commits/master) | [![coverage report](https://code.fbi.h-da.de/danet/gosdn/badges/develop/coverage.svg)](https://code.fbi.h-da.de/danet/gosdn/-/commits/develop) |
 | [![pipeline status](https://code.fbi.h-da.de/danet/gosdn/badges/master/pipeline.svg)](https://code.fbi.h-da.de/danet/gosdn/-/commits/master) | [![pipeline status](https://code.fbi.h-da.de/danet/gosdn/badges/develop/pipeline.svg)](https://code.fbi.h-da.de/danet/gosdn/-/commits/develop) |
+
+# Development Tutorial
+
+TBD
+
+## Backup and restore your mongodb
+
+If you are using the mongodb provided via the `docker-compose.yaml`, you can easily backup and restore your data via two scripts.
+
+```bash
+./scripts/backup_mongo_volume.sh $(suffix_of_backup)
+```
+```bash
+./scripts/restore_mongo_volume.sh $(suffix_of_backup)
+```
+
+Keep in mind that a restore will restart the mongodb container.

scripts/backup_mongo_volume.sh

+#!/bin/sh
+
+file_suffix=$1
+
+docker-compose pause mongo
+docker run --rm --volumes-from gosdn-mongo-1 -v $(pwd)/docker_volume_backup:/backup ubuntu bash -c 'cd /data/db/ && tar cvf /backup/mongo_backup_'"$file_suffix"'.tar .'
+docker-compose unpause mongo

scripts/restore_mongo_volume.sh

+#!/bin/sh
+
+file_suffix=$1
+
+docker-compose pause mongo
+docker run --rm --volumes-from gosdn-mongo-1 -v $(pwd)/docker_volume_backup:/backup ubuntu bash -c 'rm -r /data/db/* && cd /data/db && tar xvf /backup/mongo_backup_'"$file_suffix"'.tar --strip 1'
+docker-compose restart mongo