VM Backup Plugin

[JTok 48]

This is a beta version of a plugin I am working on to replace the unraid-vmbackup script I have been maintaining here and here.

It is based off the latest version of the script (v1.3.1), and I will be maintaining both for now as there are some use-cases for the script that the plugin cannot currently replace. This is provided as-is with no guarantees.

 

That said, and without further ado, the current version of the plugin can be found here:

https://github.com/JTok/unraid.vmbackup/tree/v0.2.1

 

-JTok

 

Feel free to buy me a beer (or two 😋)

Edited February 20 by JTok
v0.2.1

[JTok 48]

Current version change log:

 

 

v0.2.1 - 2020/02/20
Pika Pika

- merged changes from unraid-vmbackup script v1.3.1.
- added seconds to logs.
- added option to use zstandard compression.
- added option to create a vm specific log in each vm's subfolder.
- added config drop-down selection to the top of each tab.
- updated method used to determine cpu thread count.

 

https://github.com/JTok/unraid.vmbackup/tree/v0.2.1

 

-JTok

Edited February 20 by JTok

[JTok 48]

RESERVED

[juan11perez 7]

Run the beta  plugin. Perfect!!

I did however pull it from your link as I couldnt find it in Community Applications,

 

Thank you very much.

[Ashe 8]

Works very well so far, well done. One request would be to allow unassigned devices to be used as the backup location, it only allows unraid shares at the moment.


Sent from my iPhone using Tapatalk

[JTok 48]

1 hour ago, Ashe said:

Works very well so far, well done. One request would be to allow unassigned devices to be used as the backup location, it only allows unraid shares at the moment.

 

You should be able to manually type any path that starts with /mnt/ even though the drop down list only shows shares.

 

 

If you need  a path that starts with something other than /mnt/:
Under the Danger Zone tab, at the very bottom. there is a setting called “Disable restrictive validation”. If you set it to ‘Yes’, it should allow you to chose any path.


Sent from my iPhone using Tapatalk

 

 

Edited December 19, 2019 by JTok
additional info

[bastl 170]

@JTok Big thanks in the first place for your work. Looks like the plugin works for me with a quick test on a single VM, normal backup+compression. A small issue I've found is when selecting the target path for the backup. It's basically not possible to read the dropdown menu items. I'am using the Black theme with Firefox. Same with Brave browser and Chrome on Unraid 6.8. Just to let you know.

[Ashe 8]

 
You should be able to manually type any path that starts with /mnt/ even though the drop down list only shows shares.

I tried manually typing the path but without changing the mode and it would not allow. Will try again. Thanks


Sent from my iPhone using Tapatalk

[JTok 48]

I tried manually typing the path but without changing the mode and it would not allow. Will try again. Thanks

Make sure the path you’re typing contains a trailing slash. I’m going to change that requirement in a future release, but I didn’t change it yet for the beta.


Sent from my iPhone using Tapatalk

[Ashe 8]

Make sure the path you’re typing contains a trailing slash. I’m going to change that requirement in a future release, but I didn’t change it yet for the beta.


Sent from my iPhone using Tapatalk

I'm sure the trailing Slash was there. Will try again and report back


Sent from my iPhone using Tapatalk

[JTok 48]

@JTok Big thanks in the first place for your work. Looks like the plugin works for me with a quick test on a single VM, normal backup+compression. A small issue I've found is when selecting the target path for the backup. It's basically not possible to read the dropdown menu items. I'am using the Black theme with Firefox. Same with Brave browser and Chrome on Unraid 6.8. Just to let you know.

Weird. I’ll check it out. Thanks


Sent from my iPhone using Tapatalk

[bastl 170]

@JTok Just one little thing I need is a big red button labled "BACKUP NOW"  😂

[DBJordan 3]

Very cool, can't wait to give it a whirl.

Quick question: do you plan to add restore capability at some point?

[Ashe 8]

I'm sure the trailing Slash was there. Will try again and report back


Sent from my iPhone using Tapatalk

No, I stand corrected you were quite right, trailing Slash did work fine.


Sent from my iPhone using Tapatalk

[JTok 48]

@JTok Just one little thing I need is a big red button labled "BACKUP NOW" 

yeah! That’s on my radar! When testing, it was a little frustrating at times without one.


Sent from my iPhone using Tapatalk

[JTok 48]

Very cool, can't wait to give it a whirl.
Quick question: do you plan to add restore capability at some point?

I hadn’t really thought about it, but I probably should lol.

I’ll put that on my to-do list, but that’s probably a post-beta feature right now.



Sent from my iPhone using Tapatalk

[Ruthalas 3]

3 hours ago, JTok said:

 

I hadn’t really thought about it, but I probably should lol.

I’ll put that on my to-do list, but that’s probably a post-beta feature right now.



Sent from my iPhone using Tapatalk

I second that request (for restore functionality).
No hurry, but that would be a valuable addition.

[Derek_ 10]

19 hours ago, bastl said:

@JTok Just one little thing I need is a big red button labled "BACKUP NOW"  😂

Green. Make it green   Red means bad things

[Derek_ 10]

13 hours ago, Ruthalas said:

I second that request (for restore functionality).
No hurry, but that would be a valuable addition.

Yeah, it would be good. Initially though just information about how to do it manually is good enough.

[DBJordan 3]

Here's my draft at manual instructions, feel free to use them as a starting point. I just backed up one VM as a test in this case.

1. Stop all VMs.

2. Take a peek at what VMs you're using and where you're backing them up. Here's my config:

This means I should be able to find a directory here:

/mnt/user/Saidin/backuptest/Forsaken

3. Open a command shell.

4. Now you need to copy your VM vdisk and VM xml to the right location. If you're truly restoring, you'll need to make some directories as well. I'm assuming you're using the default location for domain disks, /domains share.

root@Truesource:/# mkdir /mnt/user/domains/Forsaken
root@Truesource:/# cp /mnt/user/Saidin/backuptest/Forsaken/20191220_1017_vdisk1.img /mnt/user/domains/Forsaken/vdisk1.img 
root@Truesource:/# cp /mnt/user/Saidin/backuptest/Forsaken/20191220_1017_Forsaken.xml /etc/libvirt/qemu/Forsaken.xml 

5. Start your VM.

 

 

Edited May 28 by DBJordan
Minor corrections.

[JTok 48]

New release with some minor functional changes and a few bug fixes. This was mostly background stuff with the exception of adding a "Backup Now" button.

 

 

v0.1.7 - 2019/12/22
Ms. Frizzle

- fixed minor issues.
- fixed paths requiring trailing slashes.
- fixed backup location drop-down color when using black theme.
- added additional logging.
- added donate button.
- added backup now button.
- changed backup location drop-down start folder to /mnt/.
- updated help.
- updated readme.

 

https://github.com/JTok/unraid.vmbackup/tree/v0.1.7

 

-JTok

[DZMM 215]

Will this eventually get added to CA so it will update automatically?

[JTok 48]

Will this eventually get added to CA so it will update automatically?

unRAID should still detect updates in the plugin screen without it being part of CA (assuming I didn’t mess something up). And the CA update plugin should also still do automatic updates from what I can tell.

 

That said, I've been in contact with Squid about adding it, so that should get done soon.

 

Edited December 22, 2019 by JTok

[DZMM 215]

54 minutes ago, JTok said:

unRAID should still detect updates in the plugin screen without it being part of CA (assuming I didn’t mess something up). And the CA update plugin should also still do automatic updates from what I can tell.

 

That said, I've been in contact with Squid about adding it, so that should get done soon.

 

hmm it didn't for me, but maybe I was too quick - dunno.  Thanks again for making this into a plugin.

[Jaster 4]

Hi,

 

Great Job - I've been using your script for a while and it save me a lot of time. Thanks for that!

 

Could you add an option to not backup/stop running vm's?

Would it be possible to set up different amount of days/backups for each vm?