-
Notifications
You must be signed in to change notification settings - Fork 29
docs: adds information regarding using bootc extension offline #2129
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
base: main
Are you sure you want to change the base?
Conversation
📝 WalkthroughWalkthroughAdded an Offline / Airplane Mode entry and a new offline workflows section to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Pre-merge checks✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~305-~305: Ensure spelling is correct
Context: ...module:latest ``` ### Pre-pulling base bootc images You can also pre-pull the base ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: linter, formatter, and tests / windows-2022
- GitHub Check: e2e tests
🔇 Additional comments (5)
README.md (5)
19-19: Verify anchor link matches section heading.The navigation entry references
#offline--airplane-mode(lowercase "airplane"), while the heading at line 260 uses "Offline / airplane mode". Ensure the anchor link format correctly matches GitHub's heading ID generation.Confirm that the navigation link resolves to the correct section heading.
260-264: Section structure and overview are clear.The new section appropriately explains the offline workflow use case and immediately highlights the ISO build limitation, which is important for users planning their workflow.
266-279: BIB image pre-pulling commands are well-documented.The commands appropriately cover the main builder options (CentOS, RHEL 9, RHEL 10) with helpful comments and clear subscription requirements noted.
281-303: Example images are comprehensively documented with helpful descriptions.The six example images cover common use cases (web server, VPN, container management, guest agent, WiFi, kernel modules) with clear registry references and descriptive comments.
324-329: Offline workflow steps are clear and logically sequenced.The four-step workflow (pull online → build image → go offline → build disk images) properly guides users through the offline scenario and aligns with earlier constraints about format support.
| ### Pre-pulling base bootc images | ||
|
|
||
| You can also pre-pull the base image(s) you plan to build your own Containerfile's offline. | ||
|
|
||
| ```sh | ||
| # CentOS | ||
| podman pull quay.io/centos-bootc/centos-bootc:stream9 | ||
| podman pull quay.io/centos-bootc/centos-bootc:stream10 | ||
|
|
||
| # Fedora | ||
| podman pull quay.io/fedora/fedora-bootc:42 | ||
| podman pull quay.io/fedora/fedora-bootc:43 | ||
| podman pull quay.io/fedora/fedora-bootc:44 | ||
|
|
||
| # RHEL (requires Red Hat subscription) | ||
| podman pull registry.redhat.io/rhel9/rhel-bootc:latest | ||
| podman pull registry.redhat.io/rhel10/rhel-bootc:latest | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix grammar error: remove possessive apostrophe on line 307.
Line 307 uses possessive "'s" incorrectly in "Containerfile's offline." Should be "Containerfile" without the possessive apostrophe.
Apply this diff to fix the grammar:
-You can also pre-pull the base image(s) you plan to build your own Containerfile's offline.
+You can also pre-pull the base image(s) you plan to use for your own Containerfile offline.The base image references (CentOS, Fedora, RHEL) are comprehensive and accurate.
🧰 Tools
🪛 LanguageTool
[grammar] ~305-~305: Ensure spelling is correct
Context: ...module:latest ``` ### Pre-pulling base bootc images You can also pre-pull the base ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In README.md around lines 305 to 322, remove the incorrect possessive apostrophe
on line 307 by changing "Containerfile's offline" to "Containerfile offline"
(i.e., delete the apostrophe), then save the file.
### What does this PR do? Adds some information on how to use bootc while offline, specifically how to download any and all required images in order to use it. ### Screenshot / video of UI <!-- If this PR is changing UI, please include screenshots or screencasts showing the difference --> N/A, documentation. ### What issues does this PR fix or reference? <!-- Include any related issues from Podman Desktop repository (or from another issue tracker). --> Part of podman-desktop#2098 ### How to test this PR? Read through the docs! :) Pull the images, turn yourself offline, and then run / try to build them. <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <[email protected]>
17390f4 to
5fe22e6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~305-~305: Ensure spelling is correct
Context: ...module:latest ``` ### Pre-pulling base bootc images You can also pre-pull the base ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: linter, formatter, and tests / macos-14
- GitHub Check: e2e tests
- GitHub Check: linter, formatter, and tests / windows-2022
🔇 Additional comments (3)
README.md (3)
19-19: Navigation entry added correctly. The link formatting to the new offline section is correct and follows existing markdown conventions.Also applies to: 19-19
260-264: Comprehensive offline workflow documentation. The new section is well-structured with clear instructions for pre-pulling images from appropriate registries, and the warning about ISO builds not working offline is important and appropriate.Also applies to: 266-330
260-330: Verify no unintended duplication of offline content.The AI-generated summary indicates that offline documentation content may appear in multiple locations within the diff. Please confirm that the offline section at lines 260–330 is the only instance and that no unintended duplication was introduced by reviewing the complete diff and searching for duplicate offline-related sections.
|
|
||
| ### Pre-pulling base bootc images | ||
|
|
||
| You can also pre-pull the base image(s) you plan to build your own Containerfile's offline. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix grammar error: remove possessive apostrophe and clarify sentence.
Line 307 uses an incorrect possessive apostrophe and the sentence structure is awkward. The phrase "build your own Containerfile's offline" should be clarified.
Apply this diff:
-You can also pre-pull the base image(s) you plan to build your own Containerfile's offline.
+You can also pre-pull the base image(s) you plan to use for your own Containerfile offline.Also applies to: 307-307
🤖 Prompt for AI Agents
In README.md around line 307, the sentence incorrectly uses a possessive
apostrophe ("Containerfile's") and reads awkwardly; remove the possessive and
rephrase to clarify intent, e.g., change the line to something like: "You can
also pre-pull the base image(s) you plan to use when building your Containerfile
so you can build offline." Make sure the updated sentence removes the
apostrophe, uses "use when building" (or similar wording) for clarity, and
preserves the note about pre-pulling images for offline builds.
docs: adds information regarding using bootc extension offline
What does this PR do?
Adds some information on how to use bootc while offline, specifically
how to download any and all required images in order to use it.
Screenshot / video of UI
N/A, documentation.
What issues does this PR fix or reference?
Part of #2098
How to test this PR?
Read through the docs! :) Pull the images, turn yourself offline, and
then run / try to build them.
Signed-off-by: Charlie Drage [email protected]