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.

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

WIP: fcos translate.go: add warn on small or constrained root partition #378

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

prestist
Copy link
Collaborator

@prestist prestist commented Aug 4, 2022

#211

First naive approach, plan on refactoring before coping work to prior versions of fcos

r.AddOnWarn(path.New("json", "storage", "disks", i, "partitions", p, "sizeMiB", *partition.SizeMiB), common.ErrRootTooSmall)
} else {
for _, op := range disk.Partitions {
if op.Number > partition.Number {
Copy link
Contributor

Choose a reason for hiding this comment

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

We're currently performing this check for every partition after the root partition, not just the one immediately after it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OH can we assume that they are always in order?

Copy link
Contributor

Choose a reason for hiding this comment

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

What we don't want is to warn repeatedly for every additional partition. But you're right, we can't assume they're in order, either by starting offset or by partition number. And actually, we can't make assumptions about op.Number either, since it might be 0.

So we'll need an heuristic for figuring out the earliest partition start. If the startMiB is always specified, this is easy. Otherwise, the partition order is determined by a combination of sgdisk's heuristics (see the man page for the -n option) and the additional heuristics applied by partitions.go. And unfortunately, they have some information we don't, which is the overall size of the disk, and thus the size of the largest available block.

So we'll need to figure this out. If there are cases where we're not sure, it's better to not warn.

} else {
for _, op := range disk.Partitions {
if op.Number > partition.Number {
if op.StartMiB == nil {
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't match the logic described in #211 (comment).

@@ -37,6 +37,8 @@ var (
ErrNodeExists = errors.New("matching filesystem node has existing contents or different type")
ErrNoFilesDir = errors.New("local file paths are relative to a files directory that must be specified with -d/--files-dir")
ErrTreeNotDirectory = errors.New("root of tree must be a directory")
ErrRootTooSmall = errors.New("root should have 8GiB of space available")
ErrRootNotLastPartition = errors.New("root should be last partition number to allow for growth")
Copy link
Contributor

Choose a reason for hiding this comment

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

The message is misleading, since we allow and encourage adding partitions after the root.

@@ -37,6 +37,8 @@ var (
ErrNodeExists = errors.New("matching filesystem node has existing contents or different type")
ErrNoFilesDir = errors.New("local file paths are relative to a files directory that must be specified with -d/--files-dir")
ErrTreeNotDirectory = errors.New("root of tree must be a directory")
ErrRootTooSmall = errors.New("root should have 8GiB of space available")
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: available could be read to imply free space in the filesystem.

if partition.Label != nil {
for p, partition := range disk.Partitions {
if partition.Label != nil {
if *partition.Label == "root" {
Copy link
Contributor

Choose a reason for hiding this comment

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

Unnecessary nesting.

}
}
}
// Don't warn if wipeTable is set, matching later spec versions
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like we lost the original comment here. "matching later spec versions"?

{
Kind: report.Warn,
Message: common.ErrRootTooSmall.Error(),
Context: path.New("json", "storage", "disks", 0, "partitions", 0, "sizeMiB", 500),
Copy link
Contributor

Choose a reason for hiding this comment

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

This is specifying the 501st element of the sizeMiB array.

Partitions: []types.Partition{
{
Label: util.StrToPtr("root"),
SizeMiB: util.IntToPtr(10000),
Copy link
Contributor

Choose a reason for hiding this comment

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

This size is sufficient, so the test should pass.

},
},
},
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's also add tests where the root partition doesn't explicitly specify a size but is constrained by another partition which does/doesn't leave enough room.

{
Kind: report.Warn,
Message: common.ErrRootNotLastPartition.Error(),
Context: path.New("json", "storage", "disks", 0, "partitions", 0, "number", 4),
Copy link
Contributor

Choose a reason for hiding this comment

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

Likewise, this is the 5th element of the number array.

@prestist prestist force-pushed the warn-on-fs-too-small branch 6 times, most recently from b95add4 to 98397ca Compare August 22, 2022 20:44
Fixes coreos#211, the root partition needs a certain amount of space, with
recent changes butane has the opportunity to warn when those expectations
are not met. Add a warn when the root is too small, and additionally
add warn when the root is small and cannot expand.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants