Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/infomaniak/addon-backup


https://github.com/infomaniak/addon-backup

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        







# Add-on Swiss Backup 



A dedicated solution for all of your Jelastic nodes allowing the simple configuration of backup plans for

each of your containers. Using the reliability of the infrastructures dedicated to Swiss Backup, all your data is

encrypted (end-to-end) and replicated 3 times in 3 different geographic locations. You can easily restore a backup

on any node in your account.



Add-on user manual:



[Infomaniak's FAQ](https://faq.infomaniak.com/2420)



You have 90 free days of Swiss Backup product. You can easily create your account in the Infomaniak manager.



First step:










Choose Free storage space:










You can see your Swiss Backup credentials here and in your email:










## Backup Process



There are 2 types of backups possible.



### Back-up specific folders




When you select "Back-up specific folders" the field "Folders to back-up" appears. You can specify several folders (separate each path with a ","). You must enter the absolute path of each folder that you want to save.



Example : /root/admin/, /home/user1/, /jelastic/containers/



In this example 3 folders have been specified.



After specifying these folders, you must select a backup frequency.



### Snapshot of the whole container




When you select "Snapshot of the whole container", the field "Backup all file system" appears.

This allows you to save the entire file system of your container.

Please note that some files are excluded: /dev, /proc, /sys, /run

Any filesystem which isn’t specifically mounted as part of the root partition will be excluded, including virtual file systems.



### Backup frequency



2 backup frequencies are available:



    - Daily 

    

    - Hourly

    

Daily provides a backup of your files once a day at 08:00 p.m.



Hourly provides a backup of your files every hour (at the start of the hour at 1:00 p.m. for example)



### Backup retention



You can define how long to keep your backups (in years, months, days and hours).



Please don't set all parameters to 0 because forever backups can cause backup fails. 



Limit: year: 1 month: 12 days: 99



Important: For hourly routine i recommand 3 months of retention max, beyond this value some backups can fails.

Example:

If you backup every hour and you define a retention policy to 1 year, 2 months, 4 days, 2 hours, then every backup performed will be available for this defined period ( =10322 backups)

Note that the retention policy (deletion of the backups) is done all days at 10:30PM (UTC)



Example:



You back up your filesystem with the Hourly backup policy and you choose 1 year, 2 months, 4 days, 2 hours.

This means that every single backup will be available over a period of 1 year, 2 months, 4 days, 2 hours.



### Requirement 



You need to have at least one container lit with the add-on installed to see all your backups



## Restoration Process



When selecting "Restore your data" these fields will appear.










In the same way as for backups, you must specify your Swiss Backup username and password.



The drop-down list displays the containers in which associated backups are present.

Select the container for which you want to restore the data.










After selecting the container, the corresponding backup plan appears.










Just select the backup you want to restore, the directory where you want restore the backup and choose in which environment you want to restore your data.



## Restore specific folders from a snapshot (CLI)



All your backups correspond to IDS. You can include and exclude folders from your snapshots during a restore.

To see yours snapshots.

step 1 : ``` . /home/.config/swissbackup/openrc.sh ```



step 2 : ``` restic snapshots```



you can see :










Use --exclude and --include to restrict the restore to a subset of files in the snapshot. For example, to restore a single file:



step 3 : ```restore 79766175 --target /tmp/restore-work --include /work/foo```



There are case insensitive variants of --exclude and --include called --iexclude and --iinclude. These options will behave the same way but ignore the casing of paths.



## Backups modification 



If you want to modify the configuration of your backups, simply restart the add-on from the marketplace. The automation of the backups will be updated.



## Delete backups directly in your nodes (CLI)



First step : ``` . /home/.config/swissbackup/openrc.sh ```



Second step: ``` restic snapshots (see all your backups) ```



Third step: to delete one backup : ```restic forget IdBackup --prune ```



To delete all backups of one file except one (security feature): ```restic forget --tag folders --keep-last 1 --prune```










## Modify backups routines in your nodes (CLI)



How to modify the backups schedule



Schedule of the backups is defined by a cronjob.

To change when the backup operations are perfomed, edit the cronjob following these steps :

As root user, run the command ``` crontab -l ``` to display the current schedules.

The line containing retention-all.sh corresponds to the backup task

The line containing purge.sh corresponds to the backup retention task, meaning when the cleanup will be done according to the retention policy you chose when you install the add-on.



Example :










Edit the schedule using the command ``` crontab -e ```

For more information about cronjobs, visit https://crontab.guru

Backups are performed using the tool restic. For more information about restic, visit https://restic.net/



You can modify the line composed of the script rentention-all.sh or retention.sh, these scripts correspond to the launching of your backups.

help for cron : https://crontab.guru/



Important: The design of the crons was thought to cause no problems between multiple backups and deletions, I advise you to harmonize the time of backups as well as the time of deletions



## Remove backup routine and uninstall add-on



### Remove backup routine 



To delete the backup routine from your container. This step delete automatisation of your backup.

To uninstall the add-on it is mandatory to delete the backup routine before.










### Uninstall add-on 



After deletion of backup routine click on "Désinstaller" to completely uninstall add-on on container.