Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix dracut. Document it. #13291

Closed
wants to merge 12 commits into from
Closed

Fix dracut. Document it. #13291

wants to merge 12 commits into from

Conversation

nabijaczleweli
Copy link
Contributor

@nabijaczleweli nabijaczleweli commented Apr 4, 2022 •
edited
Loading

Motivation and Context

@behlendorf: as promised in #13017 (comment)

Description

Uh, well. In order to write documentation I had to actually test whether the magic half of dracut was depending on, well, worked. Turns out it didn't. Which, well, means it didn't. Which explains why it's consistently kinda nondescriptly ass and we keep (kept?) getting people whose basic setups were failing. It's honestly a miracle and an incredible accident this'd worked at all.

Also, the non-systemd path (zfs-mount.sh) needs either removing or fixing; I haven't the slightest how you'd adjust network key loading. I don't even know if it works because I don't have a system or even distribution I could test it with. Well, I'm not building Gentoo I guess?

How Has This Been Tested?

Thoroughly. See commit messages. As far as the new manual goes, here's the dracut.bootup(7)-style flowchart:
image
image

And PDF: job_1958-stdin___jaczleweli_PDF.pdf (I don't usually target postscript in ZFS manuals, but, well, this looks shockingly alright in landscape)

Closes #13291

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
  • Documentation (a change to man pages or other documentation)

Checklist:

  • My code follows the OpenZFS code style requirements.
  • I have updated the documentation accordingly.
  • I have read the contributing document.
  • I have added tests to cover my changes. – none apply
  • I have run the ZFS Test Suite with this change applied. – CI take my hand
  • All commit messages are properly formatted and contain Signed-off-by.

@nabijaczleweli
contrib: dracut: parse-zfs: drop initqueue-finished for i/f
43e054f 
The switch was released in dracut 009 in March 2011,
we can safely get rid of the compatibility hook

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib: dracut: parse-zfs: stop pretending we support FILESYSTEM=
b480e0e 
It was added in the original ae26d04 ("Add dracut support") commit
in 2011, and was then broken a bit later with the advent of
dracut-zfs-generator, or maybe earlier as part of other churn

Either way, it's broken, and has been in 2.0+ as well, and no-one
complained. Stop pretending we support it at all

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib; dracut: centralise root= parsing, actually support root=s
9cad5c3 
So far, everything parsed root= manually, which meant that while
zfs-parse.sh was updated, and supposedly supported + -> ' ' conversion,
it meant nothing

Instead, centralise parsing, and allow:
  root=
  root=zfs
  root=zfs:
  root=zfs:AUTO

  root=ZFS=data/set
  root=zfs:data/set
  root=zfs:ZFS=data/set (as a side-effect; allowed but undocumented)

  rootfstype=zfs AND root=data/set <=> root=data/set
  rootfstype=zfs AND root=         <=> root=zfs:AUTO

So rootfstype=zfs /also/ behaves as expected, and + decoding works

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib; dracut: flatten zfs-load-key, simplify zfs-env-bootfs
b5dac9f 
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib: dracut: zfs-lib: simplify ask_for_password
9c72a52 
The only user is mount-zfs.sh (non-systemd systems),
so reduce it to what it needs

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib: dracut: zfs-lib: remove find_bootfs
d803855 
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib: dracut: inline single-use import_pool, move single-use ask_f…
dbd1654 
…or_password

Also don't set ROOTFS_MOUNTED; the final mention was removed in dracut
011 from July 2011

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib: dracut: don't require essentials to be under the same encroot
9ab38bc 
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib: dracut: zfs-{rollback,snapshot}-bootfs: order after key loading
fc6c639 
This fixes at least one race I got with an encrypted root

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib: dracut: zfs-needshutdown: don't list
1de8b9f 
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@behlendorf behlendorf self-requested a review April 5, 2022 00:12
@behlendorf behlendorf added Type: Documentation Indicates a requested change to the documentation Component: Dracut dracut integration labels Apr 5, 2022
@behlendorf
Copy link
Contributor

Thanks! The flow chart is great to see. Let's see if we can get some additional eyes on this. cc: @Rudd-O @c0d3z3r0 @prometheanfire

@prometheanfire
Copy link
Contributor

I love this, where was this 2-3 years ago lol

@nabijaczleweli
Add dracut.zfs.7
99d52f2 
Thorough documentation with a dracut.bootup(7)-style flowchart,
dracut.cmdline(7)-style cmdline listing,
and per-file docs like the old README

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
contrib: dracut: remove getargbool polyfill
0630249 
It was originally released in dracut 008 in February 2011;
we can probably drop it now

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli nabijaczleweli mentioned this pull request Apr 8, 2022
Closed
@nabijaczleweli
Copy link
Contributor Author

1.5-week bump

behlendorf
behlendorf approved these changes Apr 20, 2022
View reviewed changes
Copy link
Contributor

@behlendorf behlendorf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going over the commits everything here looks reasonable. I haven't manually tested it myself, but this is a nice step forward and the documentation is much appreciated. I'm going to go ahead and integrate it, if any unexpected issues arise we can investigate them as they're reported.

@behlendorf behlendorf added the Status: Accepted Ready to integrate (reviewed, tested) label Apr 20, 2022
behlendorf pushed a commit that referenced this pull request Apr 20, 2022
@nabijaczleweli @behlendorf
contrib: dracut: parse-zfs: stop pretending we support FILESYSTEM=
2c74617 
It was added in the original ae26d04 ("Add dracut support") commit
in 2011, and was then broken a bit later with the advent of
dracut-zfs-generator, or maybe earlier as part of other churn

Either way, it's broken, and has been in 2.0+ as well, and no-one
complained. Stop pretending we support it at all

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes #13291
behlendorf pushed a commit that referenced this pull request Apr 20, 2022
@nabijaczleweli @behlendorf
contrib; dracut: centralise root= parsing, actually support root=s
245529d 
So far, everything parsed root= manually, which meant that while
zfs-parse.sh was updated, and supposedly supported + -> ' ' conversion,
it meant nothing

Instead, centralise parsing, and allow:
  root=
  root=zfs
  root=zfs:
  root=zfs:AUTO

  root=ZFS=data/set
  root=zfs:data/set
  root=zfs:ZFS=data/set (as a side-effect; allowed but undocumented)

  rootfstype=zfs AND root=data/set <=> root=data/set
  rootfstype=zfs AND root=         <=> root=zfs:AUTO

So rootfstype=zfs /also/ behaves as expected, and + decoding works

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes #13291
behlendorf pushed a commit that referenced this pull request Apr 20, 2022
@nabijaczleweli @behlendorf
contrib; dracut: flatten zfs-load-key, simplify zfs-env-bootfs
fec2c61 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes #13291
behlendorf pushed a commit that referenced this pull request Apr 20, 2022
@nabijaczleweli @behlendorf
contrib: dracut: zfs-lib: simplify ask_for_password
5d31169 
The only user is mount-zfs.sh (non-systemd systems),
so reduce it to what it needs

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes #13291
behlendorf pushed a commit that referenced this pull request Apr 20, 2022
@nabijaczleweli @behlendorf
contrib: dracut: zfs-lib: remove find_bootfs
dac0b07 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes #13291
behlendorf pushed a commit that referenced this pull request Apr 20, 2022
@nabijaczleweli @behlendorf
contrib: dracut: inline single-use import_pool, move single-use ask_f…
eaf1e06 
…or_password

Also don't set ROOTFS_MOUNTED; the final mention was removed in dracut
011 from July 2011

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes #13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: don't require essentials to be under the same encroot
f4338be 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-{rollback,snapshot}-bootfs: order after key loading
227339d 
This fixes at least one race I got with an encrypted root

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-needshutdown: don't list
4b03bf9 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
Add dracut.zfs.7
ec83e6f 
Thorough documentation with a dracut.bootup(7)-style flowchart,
dracut.cmdline(7)-style cmdline listing,
and per-file docs like the old README

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: remove getargbool polyfill
18eb512 
It was originally released in dracut 008 in February 2011;
we can probably drop it now

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: parse-zfs: drop initqueue-finished for i/f
92558c1 
The switch was released in dracut 009 in March 2011,
we can safely get rid of the compatibility hook

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: parse-zfs: stop pretending we support FILESYSTEM=
b0b6a02 
It was added in the original ae26d04 ("Add dracut support") commit
in 2011, and was then broken a bit later with the advent of
dracut-zfs-generator, or maybe earlier as part of other churn

Either way, it's broken, and has been in 2.0+ as well, and no-one
complained. Stop pretending we support it at all

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib; dracut: centralise root= parsing, actually support root=s
3e3583b 
So far, everything parsed root= manually, which meant that while
zfs-parse.sh was updated, and supposedly supported + -> ' ' conversion,
it meant nothing

Instead, centralise parsing, and allow:
  root=
  root=zfs
  root=zfs:
  root=zfs:AUTO

  root=ZFS=data/set
  root=zfs:data/set
  root=zfs:ZFS=data/set (as a side-effect; allowed but undocumented)

  rootfstype=zfs AND root=data/set <=> root=data/set
  rootfstype=zfs AND root=         <=> root=zfs:AUTO

So rootfstype=zfs /also/ behaves as expected, and + decoding works

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib; dracut: flatten zfs-load-key, simplify zfs-env-bootfs
ad25a6d 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-lib: simplify ask_for_password
fa0bf0e 
The only user is mount-zfs.sh (non-systemd systems),
so reduce it to what it needs

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-lib: remove find_bootfs
d135905 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: inline single-use import_pool, move single-use ask_f…
ee1959b 
…or_password

Also don't set ROOTFS_MOUNTED; the final mention was removed in dracut
011 from July 2011

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: don't require essentials to be under the same encroot
d479d1a 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-{rollback,snapshot}-bootfs: order after key loading
ab24fe2 
This fixes at least one race I got with an encrypted root

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-needshutdown: don't list
298a016 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
Add dracut.zfs.7
657f622 
Thorough documentation with a dracut.bootup(7)-style flowchart,
dracut.cmdline(7)-style cmdline listing,
and per-file docs like the old README

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: remove getargbool polyfill
a347aad 
It was originally released in dracut 008 in February 2011;
we can probably drop it now

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: parse-zfs: drop initqueue-finished for i/f
a72476b 
The switch was released in dracut 009 in March 2011,
we can safely get rid of the compatibility hook

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: parse-zfs: stop pretending we support FILESYSTEM=
8cdadc5 
It was added in the original ae26d04 ("Add dracut support") commit
in 2011, and was then broken a bit later with the advent of
dracut-zfs-generator, or maybe earlier as part of other churn

Either way, it's broken, and has been in 2.0+ as well, and no-one
complained. Stop pretending we support it at all

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib; dracut: centralise root= parsing, actually support root=s
32fcec3 
So far, everything parsed root= manually, which meant that while
zfs-parse.sh was updated, and supposedly supported + -> ' ' conversion,
it meant nothing

Instead, centralise parsing, and allow:
  root=
  root=zfs
  root=zfs:
  root=zfs:AUTO

  root=ZFS=data/set
  root=zfs:data/set
  root=zfs:ZFS=data/set (as a side-effect; allowed but undocumented)

  rootfstype=zfs AND root=data/set <=> root=data/set
  rootfstype=zfs AND root=         <=> root=zfs:AUTO

So rootfstype=zfs /also/ behaves as expected, and + decoding works

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib; dracut: flatten zfs-load-key, simplify zfs-env-bootfs
a32f759 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-lib: simplify ask_for_password
aa65884 
The only user is mount-zfs.sh (non-systemd systems),
so reduce it to what it needs

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-lib: remove find_bootfs
8e3ad6c 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: inline single-use import_pool, move single-use ask_f…
1f4584d 
…or_password

Also don't set ROOTFS_MOUNTED; the final mention was removed in dracut
011 from July 2011

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: don't require essentials to be under the same encroot
48f40f6 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-{rollback,snapshot}-bootfs: order after key loading
ee10ee4 
This fixes at least one race I got with an encrypted root

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: zfs-needshutdown: don't list
b5ee452 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
Add dracut.zfs.7
5b78daa 
Thorough documentation with a dracut.bootup(7)-style flowchart,
dracut.cmdline(7)-style cmdline listing,
and per-file docs like the old README

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
andrewc12 pushed a commit to andrewc12/openzfs that referenced this pull request Sep 23, 2022
@nabijaczleweli @andrewc12
contrib: dracut: remove getargbool polyfill
57a6b50 
It was originally released in dracut 008 in February 2011;
we can probably drop it now

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#13291
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@behlendorf behlendorf behlendorf approved these changes

Assignees
No one assigned
Labels
Component: Dracut dracut integration Status: Accepted Ready to integrate (reviewed, tested) Type: Documentation Indicates a requested change to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@nabijaczleweli @behlendorf @prometheanfire @Rudd-O @thesamesam