jcwillox / hass-auto-backup

🗃️ Improved Backup Service for Home Assistant that can Automatically Remove Backups and Supports Generational Backup Schemes.
https://jcwillox.github.io/hass-auto-backup
MIT License
366 stars 27 forks source link

Documentation error regarding full backup ? #116

Open typxxi opened 1 year ago

typxxi commented 1 year ago

The problem

I am not sure if it is a mistake or not.

I had found this documentation and was wondering why the hell I had gotten only partial backups even though the script had said somewhere it would do full backups until it was too late cause when I had to restore I had to realize that I had only daily partial backups which did not help me to restore a previous SSD stage easily.

https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup

This is the first section of multiple and below the first table you will find the section Create a full backup

service: auto_backup.backup data: name: "Full Backup" keep_days: 2

I guess based on the following section that the service should rather be service: auto_backup.backup_full

instead of

service: auto_backup.backup

Not sure, but I need a solution to create full backups each day cause I want to be able to restore it as easily as if I would do a full backup manually.

thanks

What version of Auto Backup has the issue?

independent

What version of Home Assistant are you running?

independent

What type of installation are you running?

Home Assistant OS

If you're running HA OS/Supervised, what version of the Supervisor are you running?

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

No response

Additional information

No response

typxxi commented 1 year ago

I have tried and replaced the service with that full backup which then did not like the parameter folder included cause it is not supported. Went back to the usual one but and after it had run and created a backup successfully then - when I try to restore - I get the message if I want to restore a partial backup. No , I wanted the usual full backup

Now I will add the service: auto_backup.backup_full and remove include_folders:

Hope that will create a full backup

typxxi commented 1 year ago

After playing around I think I have found the key point.

If you create a new automation from a blue print the automation shows:

By default all backups are full backups, besides the 3-hourly backups which only include the configuration.

Therefore I expected to get a FULL BACKUP.

Due to the fact that I was not aware of what the second line in the System - Backup list meant (where HOME ASSISTANT would in reality mean PARTIAL BACKUP) I was not aware that all the month with the autobackup I only had gotten partial backups.

This has been caused by the last line of the switches which I had turned all off except daily, but the last one is the trigger to stop the Backup Action code from being executed which then created a partial backup with

service: auto_backup.backup
data:
  name: "{{ name }}"
  password: "{{ password }}"
  keep_days: "{{ keep_days }}"
  include_folders:
    - config

The last switch is the Use Backup Action for Hourly Backups Only which I turned off cause I did not use hourly backups and though it would not be needed which had caused all the issues I had in the past 3 days which I finally figured out somehow - hopefully.

The second line is the important one Use Backup Action for Hourly Backups Only Otherwise, it will be used for all backup types cause then a code will be excecuted which is hidden that turn the Backup from a FULL to a PARTIAL without saying that.

1

I recommend to rename the Backup second line title from Home Assistant to at least 'Partial Backup - Home Assistant' cause then I had seen the difference instantly to my usual backups 'Full Backup'

2

I also suggest to change the description
By default all backups are full backups, besides the 3-hourly backups which only include the configuration. by adding a second line with the warning **ALSO CHANGING THE LAST TOGGLE SWITCH to OFF WILL SWITCH FROM FULL BACKUP TO PARTIAL BACKUP ONLY.**

Would have saved me a lot of time cause I had always remembered FULL BACKUP by default due to the description not being aware that the one switch hourly backup could turn it on.

Might also be caused due to the confusion regarding the switch HOURLY BACKUP which is called that way in the first line in bigger letters where in the second line it seems to declare it as a 3 hourly backup and not an hourly backup.

And in the top description it was referring to a 3 hourly backup which I had ignored cause I was only aware of an hourly backup, which instead meant a 3 hourly backup.

3 suggestion therefore

Might be time to consolidate this line and the switch to hourly backup or 3 hourly backup but not mixing them together but at the end meaning the same.

Therefore I would call it 3 hourly backup everywhere