Rework live image docs #355
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
This was referenced Feb 11, 2022
This should be the default now.
It's more privileged than necessary.
3 GiB doesn't seem to be enough anymore. See coreos/fedora-coreos-tracker#1055.
We've required a rootfs artifact since October 2020, so stop describing a two-artifact world. While we're here, also spell out RAM requirements for each case. Also explicitly recommend coreos.live.rootfs_url over the other options. It requires less RAM and avoids performance bottlenecks in the firmware's network stack when fetching the rootfs. See coreos/fedora-coreos-tracker#1055.
This was
linked to
issues
Feb 13, 2022
|
Upstream docs update in coreos/coreos-installer#776. |
It's confusing to give live iPXE its own page but put live PXE in the middle of the bare-metal instructions, since most of the docs are common to both methods.
We might as well document an example iPXE install script, based on the one in the live iPXE docs.
There are multiple live image tricks that need documenting, so give them their own page.
travier
reviewed
Feb 16, 2022
Stop conflating them with install docs. Since live-booting-ipxe.adoc now contains PXE and ISO instructions as well, rename it to live-booting.adoc, update the nav title, and add a redirect.
Get rid of the manual configuration cruft. De-emphasize the distinction between live and dest Ignition configs, since users won't have to care about that as much. Fixes #245.
In particular, --copy-network isn't limited to the ISO/PXE environment, but also works when running coreos-installer directly on bare metal.
|
Updated! |
travier
reviewed
Feb 17, 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.
Separate out bare-metal installation, live image quickstart instructions, and live image reference material into their own pages. Document live image customization and various other details. Do some cleanup.
Requires coreos/coreos-installer#776.