Merge openRC and systemd daemon #218

Schievel1 · 2022-08-31T22:27:52Z

Improvement with this PR

While systemd's mount services are a charming solution, they are somewhat limited and inflexible. (See #213, #211, #215)
With the daemon we wrote for openRC, we had all the flexibility a shell has, so it was easier to solve the newly arising problems with timeshift version 22.06.
So this removes the .path mount service of systemd, installs the daemon grub-btrfsd (formerly known as the openrc daemon) by default on all systems and changes the systemd service so that it runs the grub-btrfsd daemon instead.

I also changed the daemon itself. It now does not poll anymore and instead watches completely with inotifywait. It works with timeshift (version 22.06 and newer) and with snapper.

Thanks @Megver83 for contributing to this and also his ideas in #210

Before we merge this, I need to do this:

test with openrc + timeshift
test with openrc + snapper
test with systemd + timeshift
test with systemd + snapper

If someone is interested in testing this out:

Install the new dependency inotify-tools. (sudo apt-get install inotify-tools , sudo emerge inotify-tools, however you install software on your distro. Inotify is a linux kernel utility, so the package inotify-tools should be available on nearly all linux distros)

Clone my repository:

git clone https://github.com/Schievel1/grub-btrfs.git

Go into the directory

cd grub-btrfs

Checkout the branch update-daemon

git checkout update-daemon

Run sudo make install, with the appropriate options:

sudo make install  # for systemd, as this is the default option

sudo make SYSTEMD=false OPENRC=true install # for openrc

After installation run

sudo grub-mkconfig -o /boot/grub/grub.cfg

For configuration of the service/ daemon check out the Readme at https://github.com/Schievel1/grub-btrfs/tree/update-daemon

Warning: By default the service is configured to use snapper with the snapshots directory `/.snapshots`, look up the readme @ https://github.com/Schievel1/grub-btrfs/tree/update-daemon on how to configure it for timeshift.

Also check out the nice manpages with man grub-btrfs and man grub-btrfsd and maybe read a bit and point out mistakes I made. (as english is not my native language)

Schievel1 · 2022-09-02T20:47:40Z

I noticed on my systemd laptop that the directory /run/timeshift initially does not exist. Only when timeshift is started this directory is created.
On my openRC PC this directory does exist, though.
This causes the daemon to trying to reestablish the inotify watch every second. Even thougt I don't think this is a performance problem, I changed that time to 3 seconds.
I think one can prevent this from happening by creating that directory.

Signed-off-by: Jaeger <Pascal.Jaeger@bode-kassel.com>

Fix #213, Fix #211, Fix #215

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>

Schievel1 · 2022-09-02T21:09:35Z

I think this is almost ready by now. I am just playing around with logging options and such.
I am gonna test this out with systemd & snapper tomorrow, then sleep a week over this, then maybe merge it.

Against spamming the syslog

danboid · 2022-09-03T12:21:19Z

I have tried @Schievel1 's repo but it doesn't work for me using timeshift under Debian Testing. I installed the systemd service, started and enabled it, created a new snapshot then rebooted but GRUB doesn't get updated.

Your installation instructions are incomplete and I suspect you are making some presumptions about peoples default or existing timeshift / BTRFS config. I've had a quick look at grub-btrfsd and one command that I can see its using that isn't installed by default under Debian is inotifywait which Debian and Ubuntu users can install by installing inotify-tools.

Do your scripts depend upon any other non standard commands except inotify? grub-btrfsd.service still didn't work after installing inotify-tools and rebooting.

btrfs subvol list /
ID 256 gen 29395 top level 5 path @
ID 257 gen 29400 top level 5 path @home
ID 278 gen 27561 top level 256 path var/lib/portables
ID 279 gen 27562 top level 256 path var/lib/machines
ID 294 gen 29379 top level 5 path timeshift-btrfs/snapshots/2022-09-03_13-10-33/@
ID 295 gen 29381 top level 5 path timeshift-btrfs/snapshots/2022-09-03_13-10-33/@home

# systemctl status grub-btrfsd.service
× grub-btrfsd.service - Regenerate grub-btrfs.cfg
     Loaded: loaded (/lib/systemd/system/grub-btrfsd.service; enabled; preset: >
     Active: failed (Result: exit-code) since Sat 2022-09-03 13:11:06 BST; 11mi>
   Duration: 19ms
    Process: 662 ExecStart=/usr/bin/grub-btrfsd /.snapshots --syslog (code=exit>
   Main PID: 662 (code=exited, status=1/FAILURE)
        CPU: 2ms

What does it expect of /.snapshots? That dir does not exist by default after installing timeshift under Debian.

Schievel1 · 2022-09-03T12:29:04Z

Thanks for testing that out.

Yes that's correct, you need inotify for grub-btrfsd.
Sorry I didn't mention this in this PR, it is listed as a dependency in the readme though.

https://packages.debian.org/bullseye/inotify-tools

The service is configured to use snapper by default, have you edited it with
"sudo systemctl edit --full grub-btrfsd" to use timeshift?

danboid · 2022-09-03T12:33:32Z

Thanks for testing that out.

Yes that's correct, you need inotify for grub-btrfsd. Sorry I didn't mention this in this PR, it is listed as a dependency in the readme though.

https://packages.debian.org/bullseye/inotify-tools

The service is configured to use snapper by default, have you edited it with "sudo systemctl edit --full grub-btrfsd" ?

No. What do I need to change within grub-btrfsd to make it work with timeshift?

EDIT

Oh this is covered in the README...

danboid · 2022-09-03T12:49:22Z

Well its partly covered but it doesn't tell the user what path timeshift systemd users should be using or how to find out the correct path. I happen to know that it should be /run/timeshift/ but grub-btrfsd still doesn't successfully start for me:

$ sudo systemctl status grub-btrfsd
× grub-btrfsd.service - Regenerate grub-btrfs.cfg
     Loaded: loaded (/etc/systemd/system/grub-btrfsd.service; enabled; preset: enabled)
     Active: failed (Result: exit-code) since Sat 2022-09-03 13:46:59 BST; 2s ago
   Duration: 2ms
    Process: 1647 ExecStart=/usr/bin/grub-btrfsd /run/timeshift/ --syslog (code=exited, status=1/FAILURE)
   Main PID: 1647 (code=exited, status=1/FAILURE)
        CPU: 1ms

danboid · 2022-09-03T12:51:29Z

My grub-btrfsd config:

[Unit]
Description=Regenerate grub-btrfs.cfg

[Service]
Type=simple
LogLevelMax=notice
# Set the possible paths for `grub-mkconfig`
Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
# Load environment variables from the configuration
EnvironmentFile=/etc/default/grub-btrfs/config
# Start the daemon, usage of it is:
# grub-btrfsd [-h, --help] [-t, --timeshift-auto] [-l, --log-file LOG_FILE] SNAPSHOTS_DIR
# SNAPSHOTS_DIR         Snapshot directory to watch, without effect when --timeshift-auto
# Optional arguments:
# -t, --timeshift-auto  Automatically detect Timeshifts snapshot directory
# -l, --log-file        Specify a logfile to write to
# -v, --verbose         Let the log of the daemon be more verbose
# -s, --syslog          Write to syslog
ExecStart=/usr/bin/grub-btrfsd /run/timeshift/ --syslog

[Install]
WantedBy=multi-user.target

danboid · 2022-09-03T13:07:53Z

# /usr/bin/grub-btrfsd /run/timeshift/ --syslog
$grub-btrfsd starting up...$
$[!] No directory found at /run/timeshift/$
$[!] Please specify a valid snapshot directory$

Correct! /run/timeshift only appears when I have timeshift running. You say you've tested this as working with systemd and timeshift? Under which OS?

Schievel1 · 2022-09-03T13:16:13Z

Thanks for posting that service-file here, that you configured. With more information it is always easier to do troubleshooting.

No, the order of arguments is [optional flags] (mendatory arguments) as usual. So you wanna put "ExecStart=/usr/bin/grub-btrfsd --timeshift-auto --syslog (path to snapshots dir) into that line. But since you activated --timeshift-auto you can omit the snapshots dir argument. It just gets ignored.

danboid · 2022-09-03T13:18:04Z

Thanks for posting that service-file here, that you configured. With more information it is always easier to do troubleshooting.

No, the order of commands is [optional flags] as usual. So you wanna put "ExecStart=/usr/bin/brfsd --timeshift-auto --syslog into that line. But since you activated --timeshift-auto you can omit the argument.

Looks like you made a typo there - /usr/bin/brfsd. You meant /usr/bin/grub-btrfsd ofc.

Schievel1 · 2022-09-03T13:20:40Z

Thanks for posting that service-file here, that you configured. With more information it is always easier to do troubleshooting.

No, the order of commands is [optional flags] as usual. So you wanna put "ExecStart=/usr/bin/brfsd --timeshift-auto --syslog into that line. But since you activated --timeshift-auto you can omit the argument.

Looks like you made a typo there - /usr/bin/brfsd

waves hands frantically
Yes I'm at my cell phone here :D

Schievel1 · 2022-09-03T13:22:52Z

The line that says ExecStart=/usr/bin/grub-btrfsd /.snapshots should be edited into ExecStart=/usr/bin/grub-btrfsd --timeshift-auto. When done, the service should be restarted with

You're right, I forgot to put the "--syslog" there, will fix that later

danboid · 2022-09-03T13:23:51Z

It's still not working. I'm using:

ExecStart=/usr/bin/grub-btrfsd --syslog --timeshift-auto /run/timeshift/

danboid · 2022-09-03T13:25:15Z

The good news is that at least the service is running now but GRUB isn't getting updated when I create or delete snapshots.

systemctl status grub-btrfsd
● grub-btrfsd.service - Regenerate grub-btrfs.cfg
     Loaded: loaded (/etc/systemd/system/grub-btrfsd.service; enabled; preset: enabled)
     Active: active (running) since Sat 2022-09-03 14:22:41 BST; 1min 42s ago
   Main PID: 656 (grub-btrfsd)
      Tasks: 2 (limit: 19041)
     Memory: 1.3M
        CPU: 26ms
     CGroup: /system.slice/grub-btrfsd.service
             ├─656 /bin/sh /usr/bin/grub-btrfsd --syslog --timeshift-auto /run/timeshift/
             └─680 inotifywait -q -q -e create -e delete /run/timeshift

danboid · 2022-09-03T13:44:12Z

You're not expecting the user to edit or uncomment all the required variables within the config file before they install and use grub-btrfs are you?

I ask because I see lines like this in grub-btrfsd:

${GRUB_BTRFS_MKCONFIG:-grub-mkconfig} -o ${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub.cfg

I can see GRUB_BTRFS_MKCONFIG is defined in config but its commented out by default, as are all the other variables in that file. The same file mentions defaults but I'm not sure where it would pull them in from if not the config file or the script itself? The users local GRUB config files?

Schievel1 · 2022-09-03T13:50:11Z

Hm now this is becoming interesting. Maybe a versioning thing. Could you stop the service with systemctl, then go I to that directory you made when doing the git clone and run "sudo ./grub-btrfsd -t -v"

This is like running the service but you get the direct output. -v sets verbose mode for more information.
Then fire up timeshift and make a snapshot. Let's see what the scripts outputs then.

danboid · 2022-09-03T14:14:01Z

It seemed to update GRUB when I removed an existing snapshot but it didn't update GRUB when I created a new snapshot

# ./grub-btrfsd -t -v
$grub-btrfsd starting up...$
Arguments:$
Snapshot directory: $
Timestift autodetection: true$
Logfile: 0$
Snapshot dir watchtimeout: 15$
$Entering infinite while$
Watching /run/timeshift for timeshift to start$
Setting up watches.
Watches established.
/run/timeshift/ CREATE,ISDIR 4169
$detected Timeshift startup, PID is: 4169$
$new snapshots directory is /run/timeshift/4169/backup/timeshift-btrfs/snapshots$
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
/run/timeshift/4169/backup/timeshift-btrfs/snapshots/ DELETE,ISDIR 2022-09-03_14-25-56
$Detected snapshot creation/ deletion, recreating Grub menu$
Detecting snapshots ...
No snapshots found.
If you think an error has occurred, please file a bug report at "https://github.com/Antynea/grub-btrfs"
Unmount /tmp/grub-btrfs.K4vQtphkVq .. Success
$Grub submenu recreated$
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.

danboid · 2022-09-03T14:23:41Z

Strange! It didn't work first time I tried it but then I deleted the snapshot and made a new one and it worked.

# ./grub-btrfsd -t -v
$grub-btrfsd starting up...$
Arguments:$
Snapshot directory: $
Timestift autodetection: true$
Logfile: 0$
Snapshot dir watchtimeout: 15$
$Entering infinite while$
detected running Timeshift at daemon startup, PID is: 4169$
new snapshots directory is /run/timeshift/4169/backup/timeshift-btrfs/snapshots$
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
/run/timeshift/4169/backup/timeshift-btrfs/snapshots/ DELETE,ISDIR 2022-09-03_15-12-11
$Detected snapshot creation/ deletion, recreating Grub menu$
Detecting snapshots ...
No snapshots found.
If you think an error has occurred, please file a bug report at "https://github.com/Antynea/grub-btrfs"
Unmount /tmp/grub-btrfs.MROzaRjwjG .. Success
$Grub submenu recreated$
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
/run/timeshift/4169/backup/timeshift-btrfs/snapshots/ CREATE,ISDIR 2022-09-03_15-21-21
$Detected snapshot creation/ deletion, recreating Grub menu$
Detecting snapshots ...
Found snapshot: 2022-09-03 15:21:21 | timeshift-btrfs/snapshots/2022-09-03_15-21-21/@ | ondemand | N/A |
Found 1 snapshot(s)
submenu 'Debian GNU/Linux snapshots' {
    configfile "${prefix}/grub-btrfs.cfg"
}
Unmount /tmp/grub-btrfs.remebZmqat .. Success
$Grub submenu recreated$
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
/run/timeshift/4169/backup/timeshift-btrfs/snapshots/ DELETE,ISDIR 2022-09-03_15-21-21
$Detected snapshot creation/ deletion, recreating Grub menu$
Detecting snapshots ...
No snapshots found.
If you think an error has occurred, please file a bug report at "https://github.com/Antynea/grub-btrfs"
Unmount /tmp/grub-btrfs.4qSgRmeqLt .. Success
$Grub submenu recreated$
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
/run/timeshift/4169/backup/timeshift-btrfs/snapshots/ CREATE,ISDIR 2022-09-03_15-22-02
$Detected snapshot creation/ deletion, recreating Grub menu$
Detecting snapshots ...
Found snapshot: 2022-09-03 15:22:02 | timeshift-btrfs/snapshots/2022-09-03_15-22-02/@ | ondemand | N/A |
Found 1 snapshot(s)
submenu 'Debian GNU/Linux snapshots' {
    configfile "${prefix}/grub-btrfs.cfg"
}
Unmount /tmp/grub-btrfs.m4S4nPzKVK .. Success
$Grub submenu recreated$
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.
$Watching /run/timeshift/4169/backup/timeshift-btrfs/snapshots for new snapshots...$
Setting up watches.
Watches established.

danboid · 2022-09-03T14:28:10Z

Its still not working. Because I was seeing lines like:

/run/timeshift/4169/backup/timeshift-btrfs/snapshots/ CREATE,ISDIR 2022-09-03_15-22-02
$Detected snapshot creation/ deletion, recreating Grub menu$
Detecting snapshots ...
Found snapshot: 2022-09-03 15:22:02 | timeshift-btrfs/snapshots/2022-09-03_15-22-02/@ | ondemand | N/A |
Found 1 snapshot(s)
submenu 'Debian GNU/Linux snapshots' {
    configfile "${prefix}/grub-btrfs.cfg"
}
Unmount /tmp/grub-btrfs.m4S4nPzKVK .. Success
$Grub submenu recreated$

In the log I presumed GRUB was getting updated but its not, after rebooting to check. It looks like $prefix isn't getting set.

Schievel1 · 2022-09-03T14:29:04Z

The daemon is running fine, the line that says
"Detected snapshot creation/ deletion, recreating Grub menu$"
indicates that. The output after that, that is saying "detecting snapshots" is from grub-btrfs, not grub-btrfsd.

What's the output when you run grub-btrfs? Command is "sudo /etc/grub.d/41_snapshots-btrfs"

But thanks for posting that and testing it. It didn't occur to me that saying "grub menu recreated" in the log regardless if it really worked isn't a good idea :D

danboid · 2022-09-03T14:32:55Z

# /etc/grub.d/41_snapshots-btrfs
Detecting snapshots ...
Found snapshot: 2022-09-03 15:25:02 | timeshift-btrfs/snapshots/2022-09-03_15-25-02/@ | ondemand | N/A |
Found 1 snapshot(s)
submenu 'Debian GNU/Linux snapshots' {
    configfile "${prefix}/grub-btrfs.cfg"
}
Unmount /tmp/grub-btrfs.quIzKOow1n .. Success

danboid · 2022-09-03T14:39:08Z

Where is ${prefix} set?

Schievel1 · 2022-09-03T15:03:56Z

I think right now we are starting to troubleshoot an issue with grub-btrfs, not with the daemon, which this PR is about.
The daemon is starting grub-btrfs fine, otherwise it would not say anything about snapshots found or not.

Could you rollback to 4.11 and run /etc/grub.d/41_snapshots-btrfs manually? If the problem is still there, file an issue.

// hm, wait a sec. Maybe this IS a problem with the daemon. maybe we are triggering the grub-btrfs script too fast sometimes?
Edit grub-btrfsd, the on in the directory from GitHub, on line 191 it says "sleep 5".
Could you change that to "sleep 15" maybe and then run grub-btrfsd with "sudo ./grub-btrfsd -t -v" again, and make a snapshot. (You ran that with sudo before, didn't you?)

Thanks again for testing this out, I really appreciate it. That's always the problem with those timings. "It works on my machine" is just a recipe for desaster

danboid · 2022-09-03T16:13:19Z

Increasing the sleep to 15 hasn't fixed it.

Schievel1 · 2022-09-03T17:57:56Z

Increasing the sleep to 15 hasn't fixed it.

But when you make a snapshot and run /etc/grub.d/41_snapshots-btrfs it works every time?

That just plain strange, the daemon does run the script, and it does not run it any different than you would run it manually

/ btw instead of rebooting every time to check if the snaps appear in the grub menu what I do is "cat /boot/grub/ | grep 2022" and the check with the time if the snapshot appears in there

danboid · 2022-09-03T18:00:55Z

Increasing the sleep to 15 hasn't fixed it.

But when you make a snapshot and run /etc/grub.d/41_snapshots-btrfs it works every time?

That just plain strange, the daemon does run the script, and it does not run it any different than you would run it manually

I didn't say that no. All I said was that the debug output printed when running grub-btrfsd manually made it look like it was updating grub when in fact it was not.

Schievel1 · 2022-09-03T18:09:54Z

Increasing the sleep to 15 hasn't fixed it.

But when you make a snapshot and run /etc/grub.d/41_snapshots-btrfs it works every time?

That just plain strange, the daemon does run the script, and it does not run it any different than you would run it manually

I didn't say that no. All I said was that the debug output printed when running grub-btrfsd manually made it look like it was updating grub when in fact it was not.

Oh. Alright I got that wrong.
So the problem is not the daemon but it's rather the script itself.
Have you rolled back to whatever version you were using before and checked if that still works? Because I haven't changed the grub-btrfs script much in this PR (only added some error messages at the beginning) I assume even the older version is not working.

danboid · 2022-09-03T18:16:09Z

I already have have a proven working (but systemd only) solution based on the existing main grub-btrfs repo so the problem is definitely in your repo.

Schievel1 · 2022-09-03T18:41:56Z

Ok I just found something, can you do a "cat /boot/grub/grub.cfg" and post the last ~30 lines here?

/and sorry I gotta ask that again even though I saw that your prompt was a # : you are sure you ran all that as root/ with sudo?

danboid · 2022-09-03T18:45:18Z

#
# DO NOT EDIT THIS FILE
#
# It is automatically generated by grub-mkconfig using templates
# from /etc/grub.d and settings from /etc/default/grub
#

### BEGIN /etc/grub.d/00_header ###
if [ -s $prefix/grubenv ]; then
  set have_grubenv=true
  load_env
fi
if [ "${next_entry}" ] ; then
   set default="${next_entry}"
   set next_entry=
   save_env next_entry
   set boot_once=true
else
   set default="0"
fi

if [ x"${feature_menuentry_id}" = xy ]; then
  menuentry_id_option="--id"
else
  menuentry_id_option=""
fi

export menuentry_id_option

if [ "${prev_saved_entry}" ]; then
  set saved_entry="${prev_saved_entry}"
  save_env saved_entry
  set prev_saved_entry=
  save_env prev_saved_entry
  set boot_once=true
fi

function savedefault {
  if [ -z "${boot_once}" ]; then
    saved_entry="${chosen}"
    save_env saved_entry
  fi
}
function load_video {
  if [ x$feature_all_video_module = xy ]; then
    insmod all_video
  else
    insmod efi_gop
    insmod efi_uga
    insmod ieee1275_fb
    insmod vbe
    insmod vga
    insmod video_bochs
    insmod video_cirrus
  fi
}

if [ x$feature_default_font_path = xy ] ; then
   font=unicode
else
insmod part_gpt
insmod btrfs
search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
    font="/@/usr/share/grub/unicode.pf2"
fi

if loadfont $font ; then
  set gfxmode=auto
  load_video
  insmod gfxterm
  set locale_dir=$prefix/locale
  set lang=en_GB
  insmod gettext
fi
terminal_output gfxterm
if [ "${recordfail}" = 1 ] ; then
  set timeout=30
else
  if [ x$feature_timeout_style = xy ] ; then
    set timeout_style=menu
    set timeout=5
  # Fallback normal timeout code in case the timeout_style feature is
  # unavailable.
  else
    set timeout=5
  fi
fi
### END /etc/grub.d/00_header ###

### BEGIN /etc/grub.d/05_debian_theme ###
insmod part_gpt
insmod btrfs
search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
insmod png
if background_image /@/usr/share/desktop-base/homeworld-theme/grub/grub-4x3.png; then
  set color_normal=white/black
  set color_highlight=black/white
else
  set menu_color_normal=cyan/blue
  set menu_color_highlight=white/blue
fi
### END /etc/grub.d/05_debian_theme ###

### BEGIN /etc/grub.d/10_linux ###
function gfxmode {
	set gfxpayload="${1}"
}
set linux_gfx_mode=
export linux_gfx_mode
menuentry 'Debian GNU/Linux' --class debian --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-simple-c0260040-eb10-4dff-a562-aa7d8b1d68d1' {
	load_video
	insmod gzio
	if [ x$grub_platform = xxen ]; then insmod xzio; insmod lzopio; fi
	insmod part_gpt
	insmod btrfs
	search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
	echo	'Loading Linux 5.18.0-4-amd64 ...'
	linux	/@/boot/vmlinuz-5.18.0-4-amd64 root=UUID=c0260040-eb10-4dff-a562-aa7d8b1d68d1 ro rootflags=subvol=@  quiet splash
	echo	'Loading initial ramdisk ...'
	initrd	/@/boot/initrd.img-5.18.0-4-amd64
}
submenu 'Advanced options for Debian GNU/Linux' $menuentry_id_option 'gnulinux-advanced-c0260040-eb10-4dff-a562-aa7d8b1d68d1' {
	menuentry 'Debian GNU/Linux, with Linux 5.18.0-4-amd64' --class debian --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-5.18.0-4-amd64-advanced-c0260040-eb10-4dff-a562-aa7d8b1d68d1' {
		load_video
		insmod gzio
		if [ x$grub_platform = xxen ]; then insmod xzio; insmod lzopio; fi
		insmod part_gpt
		insmod btrfs
		search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
		echo	'Loading Linux 5.18.0-4-amd64 ...'
		linux	/@/boot/vmlinuz-5.18.0-4-amd64 root=UUID=c0260040-eb10-4dff-a562-aa7d8b1d68d1 ro rootflags=subvol=@  quiet splash
		echo	'Loading initial ramdisk ...'
		initrd	/@/boot/initrd.img-5.18.0-4-amd64
	}
	menuentry 'Debian GNU/Linux, with Linux 5.18.0-4-amd64 (recovery mode)' --class debian --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-5.18.0-4-amd64-recovery-c0260040-eb10-4dff-a562-aa7d8b1d68d1' {
		load_video
		insmod gzio
		if [ x$grub_platform = xxen ]; then insmod xzio; insmod lzopio; fi
		insmod part_gpt
		insmod btrfs
		search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
		echo	'Loading Linux 5.18.0-4-amd64 ...'
		linux	/@/boot/vmlinuz-5.18.0-4-amd64 root=UUID=c0260040-eb10-4dff-a562-aa7d8b1d68d1 ro single rootflags=subvol=@ 
		echo	'Loading initial ramdisk ...'
		initrd	/@/boot/initrd.img-5.18.0-4-amd64
	}
	menuentry 'Debian GNU/Linux, with Linux 5.10.0-17-amd64' --class debian --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-5.10.0-17-amd64-advanced-c0260040-eb10-4dff-a562-aa7d8b1d68d1' {
		load_video
		insmod gzio
		if [ x$grub_platform = xxen ]; then insmod xzio; insmod lzopio; fi
		insmod part_gpt
		insmod btrfs
		search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
		echo	'Loading Linux 5.10.0-17-amd64 ...'
		linux	/@/boot/vmlinuz-5.10.0-17-amd64 root=UUID=c0260040-eb10-4dff-a562-aa7d8b1d68d1 ro rootflags=subvol=@  quiet splash
		echo	'Loading initial ramdisk ...'
		initrd	/@/boot/initrd.img-5.10.0-17-amd64
	}
	menuentry 'Debian GNU/Linux, with Linux 5.10.0-17-amd64 (recovery mode)' --class debian --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-5.10.0-17-amd64-recovery-c0260040-eb10-4dff-a562-aa7d8b1d68d1' {
		load_video
		insmod gzio
		if [ x$grub_platform = xxen ]; then insmod xzio; insmod lzopio; fi
		insmod part_gpt
		insmod btrfs
		search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
		echo	'Loading Linux 5.10.0-17-amd64 ...'
		linux	/@/boot/vmlinuz-5.10.0-17-amd64 root=UUID=c0260040-eb10-4dff-a562-aa7d8b1d68d1 ro single rootflags=subvol=@ 
		echo	'Loading initial ramdisk ...'
		initrd	/@/boot/initrd.img-5.10.0-17-amd64
	}
	menuentry 'Debian GNU/Linux, with Linux 5.10.0-16-amd64' --class debian --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-5.10.0-16-amd64-advanced-c0260040-eb10-4dff-a562-aa7d8b1d68d1' {
		load_video
		insmod gzio
		if [ x$grub_platform = xxen ]; then insmod xzio; insmod lzopio; fi
		insmod part_gpt
		insmod btrfs
		search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
		echo	'Loading Linux 5.10.0-16-amd64 ...'
		linux	/@/boot/vmlinuz-5.10.0-16-amd64 root=UUID=c0260040-eb10-4dff-a562-aa7d8b1d68d1 ro rootflags=subvol=@  quiet splash
		echo	'Loading initial ramdisk ...'
		initrd	/@/boot/initrd.img-5.10.0-16-amd64
	}
	menuentry 'Debian GNU/Linux, with Linux 5.10.0-16-amd64 (recovery mode)' --class debian --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-5.10.0-16-amd64-recovery-c0260040-eb10-4dff-a562-aa7d8b1d68d1' {
		load_video
		insmod gzio
		if [ x$grub_platform = xxen ]; then insmod xzio; insmod lzopio; fi
		insmod part_gpt
		insmod btrfs
		search --no-floppy --fs-uuid --set=root c0260040-eb10-4dff-a562-aa7d8b1d68d1
		echo	'Loading Linux 5.10.0-16-amd64 ...'
		linux	/@/boot/vmlinuz-5.10.0-16-amd64 root=UUID=c0260040-eb10-4dff-a562-aa7d8b1d68d1 ro single rootflags=subvol=@ 
		echo	'Loading initial ramdisk ...'
		initrd	/@/boot/initrd.img-5.10.0-16-amd64
	}
}

### END /etc/grub.d/10_linux ###

### BEGIN /etc/grub.d/20_linux_xen ###

### END /etc/grub.d/20_linux_xen ###

### BEGIN /etc/grub.d/30_os-prober ###
menuentry 'Windows Boot Manager (on /dev/nvme0n1p1)' --class windows --class os $menuentry_id_option 'osprober-efi-4E66-FF9B' {
	insmod part_gpt
	insmod fat
	search --no-floppy --fs-uuid --set=root 4E66-FF9B
	chainloader /EFI/Microsoft/Boot/bootmgfw.efi
}
### END /etc/grub.d/30_os-prober ###

### BEGIN /etc/grub.d/30_uefi-firmware ###
menuentry 'UEFI Firmware Settings' $menuentry_id_option 'uefi-firmware' {
	fwsetup
}
### END /etc/grub.d/30_uefi-firmware ###

### BEGIN /etc/grub.d/40_custom ###
# This file provides an easy way to add custom menu entries.  Simply type the
# menu entries you want to add after this comment.  Be careful not to change
# the 'exec tail' line above.
### END /etc/grub.d/40_custom ###

### BEGIN /etc/grub.d/41_custom ###
if [ -f  ${config_directory}/custom.cfg ]; then
  source ${config_directory}/custom.cfg
elif [ -z "${config_directory}" -a -f  $prefix/custom.cfg ]; then
  source $prefix/custom.cfg
fi
### END /etc/grub.d/41_custom ###

### BEGIN /etc/grub.d/41_snapshots-btrfs ###
### END /etc/grub.d/41_snapshots-btrfs ###

Schievel1 · 2022-09-03T18:51:11Z

Ok great. Can you do "sudo grub-mkconfig -o /boot/grub/grub.cfg"
then post the output of "cat /boot/grub/grub.cfg" here again?

Last few lines is enough

danboid · 2022-09-03T18:57:14Z

### BEGIN /etc/grub.d/41_custom ###
if [ -f  ${config_directory}/custom.cfg ]; then
  source ${config_directory}/custom.cfg
elif [ -z "${config_directory}" -a -f  $prefix/custom.cfg ]; then
  source $prefix/custom.cfg
fi
### END /etc/grub.d/41_custom ###

### BEGIN /etc/grub.d/41_snapshots-btrfs ###
submenu 'Debian GNU/Linux snapshots' {
    configfile "${prefix}/grub-btrfs.cfg"
}
### END /etc/grub.d/41_snapshots-btrfs ###

Schievel1 · 2022-09-03T18:58:34Z

It's working now, isn't it?

danboid · 2022-09-03T19:03:16Z

What makes you say that? Yes,I can see a snapshot in GRUB but we've just manually updated GRUB so the scripts are still broken.

Why don't you install Debian in a VM so you can cut out the middle man?

danboid · 2022-09-03T19:11:43Z

Note that you'll want to use the Calamares GUI installer on the desktop of the Debian Live install iso's to get BTRFS installed with separate subvols for / and /home configured by default. The text old and old style Debian GUI installers don't do this.

https://cdimage.debian.org/debian-cd/current-live/amd64/iso-hybrid/

Schievel1 · 2022-09-03T19:12:34Z

What makes you say that? Yes,I can see a snapshot in GRUB but we've just manually updated GRUB so the scripts are still broken.

Why don't you install Debian in a VM so you can cut out the middle man?

I think what happened here is when you removed the grub-btrfs you had before, the menu from grub.cfg got removed.
To be fair, in the readme it says
"NOTE: All distros

Generate your grub menu after installation for the changes to take effect.
For example:
On Arch Linux or Gentoo use grub-mkconfig -o /boot/grub/grub.cfg.
On Fedora use grub2-mkconfig -o /boot/grub2/grub.cfg
On Debian-like distribution update-grub is an alias to grub-mkconfig ..."

Sorry I forgot to mention that in the PR.
Just give it a try again, the daemon worked before and it calls the script exactly like you do when you do it manually.

I thank you for your testing again, while this is not really a problem with the PR itself, we learned a lot along the way:

put better instructions in the readme for the ExecStart line
forgot to mention --syslog on the ExecStart line in the readme
I see I can probably generate a warning that the user should run grub-mkconfig when the script is run without a submenu entry in grub.cfg, but let's keep that for another PR later.

Note that you'll want to use the Calamares GUI installer on the desktop of the Debian Live install iso's to get BTRFS installed with separate subvols for / and /home configured by default. The text old and old style Debian GUI installers don't do this.

https://cdimage.debian.org/debian-cd/current-live/amd64/iso-hybrid/

Thanks for that. I will definitely look into that, once we support Debian we support like half of the Linux distros out there. For now I don't think the grub from Debian is acting much different than the grub from arch. (Gentoo is a different story with its USE flags though)
Honestly I don't think this issue you are having is Debian related

danboid · 2022-09-03T19:20:24Z

I think what happened here is when you removed the grub-btrfs you had before, the menu from grub.coffee got removed. To be fair, in the readme it says "NOTE: All distros

Not quite. I removed my custom systemd services for updating GRUB and I removed the extra /etc/fstab mount point I had created to get that working, then I did a sudo make install in your repo so I expect it will have overwritten a few of the files installed on my disk from doing a sudo make install of the main grub-btrfs repo.

Generate your grub menu after installation for the changes to take effect. For example: On Arch Linux or Gentoo use grub-mkconfig -o /boot/grub/grub.cfg. On Fedora use grub2-mkconfig -o /boot/grub2/grub.cfg On Debian-like distribution update-grub is an alias to grub-mkconfig ..."

Sorry I forgot to mention that in the PR.

Forgot to mention what in the PR?

If you can get it working in a Debian VM, installed as per my previous post then I'll test it again but your current code doesn't seem to work under Debian / systemd with timeshift.

Schievel1 · 2022-09-03T19:24:29Z

I think what happened here is when you removed the grub-btrfs you had before, the menu from grub.coffee got removed. To be fair, in the readme it says "NOTE: All distros

Not quite. I removed my custom systemd services for updating GRUB and I removed the extra /etc/fstab mount point I had created to get that working, then I did a sudo make install in your repo so I expect it will have overwritten a few of the files installed on my disk from doing a sudo make install of the main grub-btrfs repo.

I am not sure about that. How did all this alter the grub.cfg?
It should only be generated by grub-mkconf. I thought maybe apt was doing something with it.

Generate your grub menu after installation for the changes to take effect. For example: On Arch Linux or Gentoo use grub-mkconfig -o /boot/grub/grub.cfg. On Fedora use grub2-mkconfig -o /boot/grub2/grub.cfg On Debian-like distribution update-grub is an alias to grub-mkconfig ..."

Sorry I forgot to mention that in the PR.

Forgot to mention what in the PR?

That you have to run grub-mkconfig once after installation.
I put it in now

danboid · 2022-09-03T19:26:16Z

That you have to run grub-mkconfig once after installation.

My systemd solution doesn't require this and I don't see why yours would either.

Schievel1 · 2022-09-03T19:46:03Z

That you have to run grub-mkconfig once after installation.

My systemd solution doesn't require this and I don't see why yours would either.

No it does. All of them do. Doesn't matter which daemon you have, it says
"NOTE: All distros

Generate your grub menu after installation for the changes to take effect."

In the readme for ages now.
You must have done it the first time you installed grub-btrfs. It just so happens that for your systemd solution you did not uninstall or install grub-btrfs, you just had it before.

You need to run grub-mkconf to generate those lines in grub.cfg:

### BEGIN /etc/grub.d/41_snapshots-btrfs ###
submenu 'Debian GNU/Linux snapshots' {
    configfile "${prefix}/grub-btrfs.cfg"
}
### END /etc/grub.d/41_snapshots-btrfs ###

This is the grub menu entry, which calls the submenu in /boot/grub/grub-btrfs.cfg.
The submenu itself is then generated by /etc/grub.d/41_snapshots-btrfs and ends up in /boot/grub/grub-btrfs.cfg
It doesn't matter which daemon you're using, this is pure core grub/ grub-btrfs functionality.

/ nuff said, is it working now?

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>

When a snapshot is created with `timeshift --create` an the commandline, sometimes the daemon is not fast enough between the first (/run/timeshift) inotifywait and the second (an the actual snapshot directory) inotifywait. Even without any `sleep` between them. So now the grub (sub)menu is always created once in its own process when the daemon sees a timeshift startup. Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>

This was referenced Aug 31, 2022

OpenRC scripts: add configuration file #210

Merged

add manpages #216

Closed

Schievel1 added 7 commits September 2, 2022 22:56

grub-btrfsd: Fix #211 for OpenRC-Daemon

d54f3d7

grub-btrfs: Give messages when the script exits

6280f95

grub-btrfsd: Update README.md, Fix #213

14c42b8

Signed-off-by: Jaeger <Pascal.Jaeger@bode-kassel.com>

grub-btrfsd: Merge openrc and systemd daemon

961675c

Fix #213, Fix #211, Fix #215

general: Formatted Readme a bit

8c8ee20

grub-btrfsd: add verbose and syslog options

9064d61

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>

grub-btrfsd: fix problem missing /run/timeshift

5805029

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>

Schievel1 requested a review from Antynea September 2, 2022 21:01

This was referenced Sep 2, 2022

Snapper mount missing in systemctl list-units -t mount #215

Closed

(Guide for) Configuring systemd to update grub after modifying timeshift snapshots #213

Closed

grub-btrfs.path for timeshift is not working anymore #211

Closed

grub-btrfsd: Change the LogLevel

44573e5

Against spamming the syslog

grub-btrfsd: better instructions for daemon config

4580c0f

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>

Schievel1 marked this pull request as ready for review October 20, 2022 06:11

Schievel1 added 3 commits October 21, 2022 08:26

grub-btrfsd: Error message when grub(-btrfs) fails

4c63b65

Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>

Merge branch 'master' into update-daemon

36cee77

Schievel1 merged commit a6e9caf into Antynea:master Oct 21, 2022

Merge openRC and systemd daemon #218

Merge openRC and systemd daemon #218

Conversation

Schievel1 commented Aug 31, 2022 • edited Loading

Improvement with this PR

Before we merge this, I need to do this:

If someone is interested in testing this out:

Warning: By default the service is configured to use snapper with the snapshots directory /.snapshots, look up the readme @ https://github.com/Schievel1/grub-btrfs/tree/update-daemon on how to configure it for timeshift.

Schievel1 commented Sep 2, 2022

Schievel1 commented Sep 2, 2022

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022

Schievel1 commented Sep 3, 2022

danboid commented Sep 3, 2022

danboid commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022

danboid commented Sep 3, 2022

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022

danboid commented Sep 3, 2022

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022

Schievel1 commented Sep 3, 2022

danboid commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022 • edited Loading

Schievel1 commented Sep 3, 2022 • edited Loading

danboid commented Sep 3, 2022

Schievel1 commented Sep 3, 2022 • edited Loading

Schievel1 commented Aug 31, 2022 •

edited

Loading

Warning: By default the service is configured to use snapper with the snapshots directory `/.snapshots`, look up the readme @ https://github.com/Schievel1/grub-btrfs/tree/update-daemon on how to configure it for timeshift.

danboid commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

danboid commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading

Schievel1 commented Sep 3, 2022 •

edited

Loading