diff --git a/static/api/extensions.json b/static/api/extensions.json index 96ad036..e8caf40 100644 --- a/static/api/extensions.json +++ b/static/api/extensions.json @@ -468,6 +468,27 @@ "categories": ["Containers"], "keywords": ["bootc", "bootable", "OS", "disk"], "versions": [ + { + "version": "1.6.0", + "podmanDesktopVersion": "^1.14.0", + "preview": false, + "lastUpdated": "2024-12-19T00:00:00Z", + "ociUri": "ghcr.io/podman-desktop/podman-desktop-extension-bootc:1.6.0", + "files": [ + { + "assetType": "icon", + "data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/1.6.0/icon.png" + }, + { + "assetType": "README", + "data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/1.6.0/README.md" + }, + { + "assetType": "LICENSE", + "data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/1.6.0/LICENSE" + } + ] + }, { "version": "1.5.0", "podmanDesktopVersion": "^1.12.0", diff --git a/static/api/extensions/redhat/bootc/1.6.0/LICENSE b/static/api/extensions/redhat/bootc/1.6.0/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/static/api/extensions/redhat/bootc/1.6.0/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/static/api/extensions/redhat/bootc/1.6.0/README.md b/static/api/extensions/redhat/bootc/1.6.0/README.md new file mode 100644 index 0000000..b229c8e --- /dev/null +++ b/static/api/extensions/redhat/bootc/1.6.0/README.md @@ -0,0 +1,269 @@ +# BootC (Bootable Container) Extension for Podman Desktop + +![](https://raw.githubusercontent.com/containers/podman-desktop-extension-bootc/main/docs/img/logo.png) + +Want to create a bootable operating system from a Containerfile? Download this extension! + +Easily go from container to VM / ISO-on-a-USB / RAW image! + +## Topics + +- [Technology](#technology) +- [Bootable Container Images](#bootable-container-images) +- [Read Before Using](#read-before-using) +- [Example Images](#example-images) +- [Use Case](#use-case) +- [Requirements](#requirements) +- [Installation](#installation) +- [Usage](#usage) +- [Preferences](#preferences) +- [Known Issues](#known-issues) +- [Contributing](#contributing) + +## Technology + +The **Bootable Container (bootc)** extension uses [bootc-image-builder](https://github.com/osbuild/bootc-image-builder) in order to build bootable *container* disk images. + +Once a machine is created from the disk image, it can apply transactional updates "in place" from newly pushed container images (without creating a new disk image). For more information, see [bootc](https://containers.github.io/bootc/). + +## Bootable Container Images + +There are many projects at work at creating "bootc" images. Below is a non-exhaustive list of compatible images which are known to work with [`bootc-image-builder`](https://github.com/osbuild/bootc-image-builder). + +**CentOS:** + +- Containerfile: `FROM quay.io/centos-bootc/centos-bootc:stream9` +- Repo: [`quay.io/centos-bootc/centos-bootc:stream9`](https://quay.io/centos-bootc/centos-bootc) +- Example Images: [gitlab.com/fedora/bootc/examples](https://gitlab.com/fedora/bootc/examples) +- Documentation: [fedoraproject.org](https://docs.fedoraproject.org/en-US/bootc/) +- Notes: N/A + +**Fedora:** + +- Containerfile: `FROM quay.io/fedora/fedora-bootc:40` +- Repo: [`quay.io/fedora/fedora-bootc:40`](https://quay.io/fedora/fedora-bootc) +- Example Images: [gitlab.com/fedora/bootc/examples](https://gitlab.com/fedora/bootc/examples) +- Documentation: [fedoraproject.org](https://docs.fedoraproject.org/en-US/bootc/) +- Notes: Must select "XFS", "EXT4" or "BTRFS" for the root filesystem when building in the GUI. [Read more here.](https://docs.fedoraproject.org/en-US/bootc/default-rootfs-type/) + +**RHEL:** + +- Containerfile: `FROM registry.redhat.io/rhel9/rhel-bootc:9.4` +- Repo: [`registry.redhat.io/rhel9/rhel-bootc:9.4`](https://catalog.redhat.com/search?gs&q=bootc) +- Documentation: [Red Hat Customer Portal](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/using_image_mode_for_rhel_to_build_deploy_and_manage_operating_systems/index#doc-wrapper) + + +The images can then be added to your Containerfile: + +```Dockerfile +FROM quay.io/centos-bootc/centos-bootc:stream9 +``` + +### Learning more + +If you want to learn more about bootable containers, please refer to the [Fedora Getting Started Guide](https://docs.fedoraproject.org/en-US/bootc/getting-started/) where you can find a number of videos, demos, best practices and detailed information. + +## Read Before Using + +Some concepts to grasp before using. + +### **Think of it as an OS provisioning tool!** + +You are "creating" an OS straight from a Containerfile, isn't that awesome? + +**FIRST** realize that you are creating an OS with all your applications, developer tools, even games that you want. + +**SECONDLY** ask yourself what applications you want to have running (perhaps on boot too!). + +### Creating your first bootable OS Containerfile + +Want a quick straight-to-the-point Hello World Containerfile? + +```Dockerfile +FROM quay.io/centos-bootc/centos-bootc:stream9 +# Change your root password for a "test login" that +# allows to log in on a virtual/physical console +# NOTE: While some base images may set `PermitRootLogin prohibit-password` +# for OpenSSH, not all will. +# This is VERY dangerous and only meant for Hello World purposes. +RUN echo "root:root" | chpasswd +``` + +After creating your image you can now login and explore your bootable OS. + +## Example images + +Want to view more example images Such as [`httpd`](https://gitlab.com/bootc-org/examples/-/tree/main/httpd) and [`nvidia`](https://gitlab.com/bootc-org/examples/-/tree/main/nvidia)? + +All of our maintained example images are on the [gitlab.com/fedora/bootc/examples](https://gitlab.com/fedora/bootc/examples) repo. + +You can also pull our example image based on the [`httpd`](https://gitlab.com/bootc-org/examples/-/tree/main/httpd) example: + +![](https://raw.githubusercontent.com/containers/podman-desktop-media/bootc-extension/gifs/clicking_pull.gif) + +After building, read our [Virtual Machine Guide](https://github.com/containers/podman-desktop-extension-bootc/blob/main/docs/vm_guide.md) on how to launch your image and access your HTTP server. + +## Use Case + +Go from a [bootc](https://containers.github.io/bootc/) compatible derived container build to a disk image format: + +* `qcow2`: QEMU Disk Images +* `ami`: Amazon Machine Images +* `raw`: RAW disk image an MBR or GPT partition table +* `anaconda-iso`: Unattended installation method (USB sticks / install-on-boot) +* `vmdk`: Usable in vSphere +* `vhd`: Virtual Hard Disk + +The list above is what is supported by the underlying `bootc-image-builder` technology. The list can [be found here](https://github.com/osbuild/bootc-image-builder?tab=readme-ov-file#-image-types). + +## Requirements + +### Prerequisites: Software and hardware requirements + +**OS:** + +Compatible on Windows, macOS & Linux + +**Software:** +* [Podman Desktop 1.10.0+](https://github.com/containers/podman-desktop) +* [Podman 5.0.1+](https://github.com/containers/podman) + +### Podman Machine (macOS / Windows) + +Podman Machine is required for macOS and Windows in order to run Podman as well as utilize filesystem privileges to build a disk image. + +Podman Machine requirements: +* **Rootful mode enabled** +* *At least* 6GB of RAM allocated in order to build the disk image + +Rootful mode can be enabled through the CLI to an already deployed VM: + +```sh +podman machine stop +podman machine set --rootful +podman machine start +``` + +Or set when initially creating a Podman Machine via Podman Desktop: + +![rootful setup](https://raw.githubusercontent.com/containers/podman-desktop-extension-bootc/main/docs/img/rootful_setup.png) + +### Escalated Privileges (Linux) + +During the build process, **you will be asked to enter your credentials** so that the bootc extension may run a `sudo podman run` underlying CLI command. + +Podman Desktop is ran as the logged-in user. However, bootc-image-builder requires escalated / sudo privileges to run a rootful container. + +You can find more information about what specific commands are being ran from the console logs of Podman Desktop. + + +## Installation + +This extension can be installed through the **Extensions** section of Podman Desktop within the **Catalog** tab: + +1. Go to **Extensions** in the navbar. +2. Click on the **Catalog** tab. +3. Install the extension. + +![](https://raw.githubusercontent.com/containers/podman-desktop-media/bootc-extension/gifs/catalog_install.gif) + +### Nightly version + +A version of the extension using the latest commit changes can be installed via the **Install custom...** button with the following link: + +``` +ghcr.io/containers/podman-desktop-extension-bootc:nightly +``` + +## Usage + +1. **Build your bootc-enabled Containerfile:** + +> In the example below, we are going to change the root password for testing purposes when accessing the OS. + +```Dockerfile +FROM quay.io/centos-bootc/centos-bootc:stream9 + +# Change the root password +# CAUTION: This is NOT recommended and is used only for testing / hello world purposes +RUN echo "root:root" | chpasswd +``` + +![](https://raw.githubusercontent.com/containers/podman-desktop-media/bootc-extension/gifs/build_image.gif) + +2. **Build the disk image:** + +> Build the disk image, this takes approximatley 2-5 minutes depending on the performance of your machine. + +![](https://raw.githubusercontent.com/containers/podman-desktop-media/bootc-extension/gifs/bootc_building.gif) + +3. **Launching the VM:** + +> See our [Virtual Machine Guide](https://github.com/containers/podman-desktop-extension-bootc/blob/main/docs/vm_guide.md) on how to launch the image! + +![](https://raw.githubusercontent.com/containers/podman-desktop-media/bootc-extension/gifs/os_booting.gif) + +## Preferences + +Preferences such as the default `bootc-builder-image` as well as timeouts can be adjusted within the **Preferences** section of Podman Desktop. + +![](https://raw.githubusercontent.com/containers/podman-desktop-extension-bootc/main/docs/img/preferences.png) + +## Known issues + +**Unable to build cross-arch images on macOS and Windows:** + +This is a [known issue](https://github.com/containers/podman-desktop-extension-bootc/issues/808) when attempting to build cross-architecture images using Podman Machine on macOS and Windows. For example, building an x86 image on macOS with Apple Silicon (ARM). + +The issue stems from a missing [openat2](https://www.mail-archive.com/qemu-devel@nongnu.org/msg1064233.html) system call in QEMU, which has now been patched upstream. While waiting for the patch to be incorporated into Podman Machine, Fedora packages have been created to address the issue. + +Your Podman Machine might not have the required QEMU patch to build cross-architecture images. + +**macOS only**: + +1. Delete your current Podman Machine via **Settings > Resources > Podman**. +2. Disable Rosetta under **Settings > Preferences > Extension: Podman > Rosetta**. +3. Create a new Podman Machine. + +**Windows and macOS**: + +1. Start your Podman Machine. +2. SSH into the Podman Machine: + +```sh +podman machine ssh +``` + +3. Override the QEMU binaries: + +If your host machine is x86 (AMD64), run: + +```sh +rpm-ostree override replace https://download.copr.fedorainfracloud.org/results/michaelvogt/qemu-user-with-openat2/fedora-40-x86_64/08033635-qemu/qemu-user-8.2.6-3.mvo1.fc40.x86_64.rpm +rpm-ostree override replace https://download.copr.fedorainfracloud.org/results/michaelvogt/qemu-user-with-openat2/fedora-40-x86_64/08033635-qemu/qemu-user-static-aarch64-8.2.6-3.mvo1.fc40.x86_64.rpm +``` + +If your host machine is ARM (ARM64), run: + +```sh +rpm-ostree override replace https://download.copr.fedorainfracloud.org/results/michaelvogt/qemu-user-with-openat2/fedora-40-aarch64/08033635-qemu/qemu-user-8.2.6-3.mvo1.fc40.aarch64.rpm +rpm-ostree override replace https://download.copr.fedorainfracloud.org/results/michaelvogt/qemu-user-with-openat2/fedora-40-aarch64/08033635-qemu/qemu-user-static-x86-8.2.6-3.mvo1.fc40.aarch64.rpm +``` + +4. Restart your Podman Machine: + +```sh +podman machine stop +podman machine start +``` + +To undo the fix, either delete and re-create the Podman Machine, or: + +```sh +podman machine ssh +rpm-ostree override reset --all +``` + +## Contributing + +Want to help develop and contribute to the bootc extension? View our [CONTRIBUTING](https://github.com/containers/podman-desktop-extension-bootc/blob/main/CONTRIBUTING.md) document. diff --git a/static/api/extensions/redhat/bootc/1.6.0/icon.png b/static/api/extensions/redhat/bootc/1.6.0/icon.png new file mode 100644 index 0000000..9b82827 Binary files /dev/null and b/static/api/extensions/redhat/bootc/1.6.0/icon.png differ