variants: Document the image-layout options
#1896
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
webern
approved these changes
Jan 11, 2022
variants/README.md
Outdated
| Though we've done so here for sake of demonstration, resizing the "data" disk image isn't necessary as it expands to fill the disk on boot. | ||
| `partition-plan` is the strategy used for image partitioning, with the options being "split" (the default) or "unified". | ||
| The "split" partition strategy has separate volumes for "OS" and "data", while "unified" has "OS" and "data" on a single volume. | ||
| See the documentation for the [defaults](https://github.com/bottlerocket-os/bottlerocket/blob/4cb75aea3715de3ec91cf54d9a4699e11b5f3c24/tools/buildsys/src/manifest.rs#L260) and [additional details](https://github.com/bottlerocket-os/bottlerocket/blob/4cb75aea3715de3ec91cf54d9a4699e11b5f3c24/tools/buildsys/src/manifest.rs#L76). |
There was a problem hiding this comment.
This should be a markdown link instead of a GitHub "permalink". I think it will always be that particular version of the file that this link goes to.
etungsten
approved these changes
Jan 11, 2022
zmrow
force-pushed
the
image-layout-docs
branch
from
db9a48c
to
ab942fd
Compare
|
^ Per @webern 's request, the above push changes the link to a markdown link rather than permalink. |
webern
approved these changes
Jan 12, 2022
arnaldo2792
reviewed
Jan 12, 2022
This adds some additional documentation to the README for the new `image-layout` section of a variant's `Cargo.toml`.
zmrow
force-pushed
the
image-layout-docs
branch
from
ab942fd
to
9fdce88
Compare
|
^ Updates the wording per @arnaldo2792 |
arnaldo2792
approved these changes
Jan 12, 2022
bcressey
approved these changes
Jan 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
Testing done:
Used these options in #1895 ! :)
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.