diff --git a/api/extensions.json b/api/extensions.json index cab0df8..f596da4 100644 --- a/api/extensions.json +++ b/api/extensions.json @@ -347,12 +347,32 @@ "shortDescription": "Support for bootable OS containers (bootc) and generating disk images", "license": "Apache-2.0", "categories": ["Containers"], - "keywords": ["bootc"], + "keywords": ["bootc", "bootable", "OS", "disk"], "versions": [ + { + "version": "0.2.0", + "preview": false, + "lastUpdated": "2024-02-05T00:00:00Z", + "ociUri": "ghcr.io/containers/podman-desktop-extension-bootc:0.2.0", + "files": [ + { + "assetType": "icon", + "data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/0.2.0/icon.png" + }, + { + "assetType": "README", + "data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/0.2.0/README.md" + }, + { + "assetType": "LICENSE", + "data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/0.2.0/LICENSE" + } + ] + }, { "version": "0.1.0", "preview": false, - "lastUpdated": "2024-12-29T00:00:00Z", + "lastUpdated": "2024-01-29T00:00:00Z", "ociUri": "ghcr.io/containers/podman-desktop-extension-bootc:0.1.0", "files": [ { @@ -372,7 +392,7 @@ { "version": "preview", "preview": true, - "lastUpdated": "2024-12-29T00:00:00Z", + "lastUpdated": "2024-01-29T00:00:00Z", "ociUri": "ghcr.io/containers/podman-desktop-extension-bootc:latest", "files": [ { diff --git a/api/extensions/redhat/bootc/0.2.0/LICENSE b/api/extensions/redhat/bootc/0.2.0/LICENSE new file mode 100644 index 0000000..f4f87bd --- /dev/null +++ b/api/extensions/redhat/bootc/0.2.0/LICENSE @@ -0,0 +1,203 @@ + + 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. + \ No newline at end of file diff --git a/api/extensions/redhat/bootc/0.2.0/README.md b/api/extensions/redhat/bootc/0.2.0/README.md new file mode 100644 index 0000000..626af32 --- /dev/null +++ b/api/extensions/redhat/bootc/0.2.0/README.md @@ -0,0 +1,220 @@ +# BootC (Bootable Container) Extension for Podman Desktop + +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) +- [Read Before Using](#read-before-using) +- [Extension Features](#extension-features) +- [Use Case](#use-case) +- [Requirements](#requirements) +- [Installation](#installation) +- [Usage](#usage) +- [Contributing](#contributing) + +## Technology + +The **Bootable Container (bootc)** extension utilizes [bootc-image-builder](https://github.com/osbuild/bootc-image-builder) in order to create bootable container OS images. + +Within [bootc-image-builder](https://github.com/osbuild/bootc-image-builder) the tool uses [bootc](https://containers.github.io/bootc/) as a basis for conversion to achieve the bootable container OS as well as libraries such as [libostree](https://ostreedev.github.io/ostree/) and [ostree-rs-ext](https://github.com/ostreedev/ostree-rs-ext). + +The **ONLY** currently supported base image is [`quay.io/centos-bootc/fedora-bootc`](https://centos.github.io/centos-bootc). More are to be supported in the future! + +## 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/fedora-bootc:eln +# Change your root password for a "test login" +RUN echo "root:root" | chpasswd +``` + +Want to make it even better? + +[Read our Containerfile Guide!](/docs/containerfile_guide.md) We also explain how to add your first "run-on-boot" application! + +## Extension Features + +* Create bootable container images +* One-click launching of VM's +* Built-in Podman Desktop UI additions to help differentiate bootc to normal containers (bootc badges in images) +* Custom icon to help indicate bootc containers + +## Use Case + +Go from a a [bootc](https://containers.github.io/bootc/) compatible Containerfile: + +```Dockerfile +FROM quay.io/centos-bootc/fedora-bootc:eln +RUN echo "root:root" | chpasswd +``` + +To a bootable container OS image format: + +* `qcow2`: QEMU Disk Images +* `ami`: Amazon Machine Images +* `raw`: RAW disk image an MBR or GPT partition table +* `iso`: Unattended installation method (USB Sticks / Install-on-boot) + +## Requirements + +Disclaimer: This is **EXPERIMENTAL** and all features are subject to change as we develop the extension. + +### Requirement 1. Software and hardware requirements + +**Hardware:** +* macOS Silicon + +Note: Windows & Linux not supported, but coming soon + +**Software:** +* [Podman Desktop 1.7.0+](https://github.com/containers/podman-desktop) +* [Podman 4.9.0+](https://github.com/containers/podman) (should be automatically installed by Podman Desktop already) + +### Requirement 2. Rootful mode on Podman Machine + +Make sure your `podman machine` has rootful mode enabled. + +This can be done 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](/docs/img/rootful_setup.png) + +## Installation + +This extension can be installed through the **Extensions** page of Podman Desktop. +To install go to *Settings > Extensions*. Copy and paste +`ghcr.io/containers/podman-desktop-extension-bootc` into the *Name of the image* field +and click *Install extension from the OCI image*. + +[![](/docs/img/install_extension.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/install_extension.mp4) + +## Usage + +1. **Build your bootc-enabled Containerfile:** + +> In our example, we are going to change the root password for testing purposes when accessing the OS. + +```Dockerfile +FROM quay.io/centos-bootc/fedora-bootc:eln + +# Change the root password +RUN echo "root:root" | chpasswd +``` + +[![](/docs/img/build_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/build_container.mp4) + +2. **Push the image:** + +> IMPORTANT NOTE: This must be a **PUBLICALLY** accessible registry, this will be fixed in the future to use a local container storage + +[![](/docs/img/push_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/push_container.mp4) + +3. **Build the image:** + +> Build the disk image, this takes approximatley 2-5 minutes depending on the performance of your machine. + +[![](/docs/img/press_build.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/press_build.mp4) + +4. **View the logs:** + +> You can now view the conversion process within the Containers section + +![](/docs/img/watch_logs.gif) + +5. **Launching the VM:** + +See our [Virtual Machine Guide](/docs/vm_guide.md) on how to launch the image! + +6. **(EXPERIMENTAL) Testing within a container:** + +> IMPORTANT NOTE: This does not represent a 1-1 conversion between container image to virtual machine image and is only meant for troubleshooting or developmental purposes. + +[![](/docs/img/within_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/within_container.mp4) + +You can also test your image within a container BEFORE converting by initiating the `init` boot sequence. + +**WARNINGS:** +* Depending on your host system, you may get startup errors such as `[FAILED] Failed to start sshd.service - OpenSSH server daemon` this is because your test container is being ran in the same network space as another SSH server (most likely the podman machine) +* Your systemd unit may not start up correctly if a system port is already in use. Make sure for example, that port "8080" is free on the host system before testing. + +#### Run the container with the following command or through the Podman Desktop UI: + +```sh +export IMAGE=yourcontainerimage +podman run \ + -it \ + --rm \ + --cap-add NET_ADMIN \ + --cap-add NET_RAW \ + --cap-add SYS_ADMIN \ + --cap-add SETUID \ + --cap-add SETGID \ + --cap-add mknod \ + --security-opt label=disable \ + --security-opt 'unmask=/proc/*' \ + --device=/dev/fuse \ + --network host \ + $IMAGE "/sbin/init" +``` + +#### Notes on parameters being passed: + +The majority of these `--cap-add` commands are for the ability of running a "container within a container". This allows you to run a container such as: `podman run -p 8080:8080 quay.io/bootc-extension/helloworld` within another container for developmental purposes. + +The rest have to do with enabling correct networking so you have correct DNS and networking resolution. + +```sh +# Allows the correct "simulated" networking from within the container +--cap-add NET_ADMIN \ +--cap-add NET_RAW \ + +# Disables SELinux, /proc errors +# allows the correct usage of the filesystem +--cap-add SYS_ADMIN \ +--cap-add SETUID \ +--cap-add SETGID \ +--cap-add mknod \ +--security-opt label=disable \ +--security-opt 'unmask=/proc/*' \ +--device=/dev/fuse \ + +# Allows the usage of the host networking / correct DNS resolution +--network host \ +``` + +## Contributing + +Want to help develop and contribute to the bootc extension? + +You can use `yarn watch --extension-folder` from the Podman Desktop directory to automatically rebuild and test the bootc extension: + +```sh +git clone https://github.com/containers/podman-desktop +git clone https://github.com/containers/podman-desktop-extension-bootc +cd podman-desktop +yarn watch --extension-folder ../podman-desktop-extension-bootc +``` \ No newline at end of file diff --git a/api/extensions/redhat/bootc/0.2.0/icon.png b/api/extensions/redhat/bootc/0.2.0/icon.png new file mode 100644 index 0000000..14a79b9 Binary files /dev/null and b/api/extensions/redhat/bootc/0.2.0/icon.png differ