Skip to content

Commit 6dfc71b

Browse files
deboer-timdeboer-tim
committedFeb 15, 2024
feat: bootc 0.3.0 release
Signed-off-by: Tim deBoer <git@tdeboer.ca>
1 parent ea57fb5 commit 6dfc71b

File tree

4 files changed

+443
-0
lines changed

4 files changed

+443
-0
lines changed
 

‎api/extensions.json

+20
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,26 @@
349349
"categories": ["Containers"],
350350
"keywords": ["bootc", "bootable", "OS", "disk"],
351351
"versions": [
352+
{
353+
"version": "0.3.0",
354+
"preview": false,
355+
"lastUpdated": "2024-02-15T00:00:00Z",
356+
"ociUri": "ghcr.io/containers/podman-desktop-extension-bootc:0.3.0",
357+
"files": [
358+
{
359+
"assetType": "icon",
360+
"data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/0.3.0/icon.png"
361+
},
362+
{
363+
"assetType": "README",
364+
"data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/0.3.0/README.md"
365+
},
366+
{
367+
"assetType": "LICENSE",
368+
"data": "https://registry.podman-desktop.io/api/extensions/redhat/bootc/0.3.0/LICENSE"
369+
}
370+
]
371+
},
352372
{
353373
"version": "0.2.0",
354374
"preview": false,

‎api/extensions/redhat/bootc/0.3.0/LICENSE

+203
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
203+

‎api/extensions/redhat/bootc/0.3.0/README.md

+220
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
# BootC (Bootable Container) Extension for Podman Desktop
2+
3+
Want to create a bootable operating system from a Containerfile? Download this extension!
4+
5+
Easily go from container to VM / ISO-on-a-USB / RAW image!
6+
7+
## Topics
8+
9+
- [Technology](#technology)
10+
- [Read Before Using](#read-before-using)
11+
- [Extension Features](#extension-features)
12+
- [Use Case](#use-case)
13+
- [Requirements](#requirements)
14+
- [Installation](#installation)
15+
- [Usage](#usage)
16+
- [Contributing](#contributing)
17+
18+
## Technology
19+
20+
The **Bootable Container (bootc)** extension utilizes [bootc-image-builder](https://github.com/osbuild/bootc-image-builder) in order to create bootable container OS images.
21+
22+
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).
23+
24+
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!
25+
26+
## Read Before Using
27+
28+
Some concepts to grasp before using.
29+
30+
### **Think of it as an OS provisioning tool!**
31+
32+
You are "creating" an OS straight from a Containerfile, isn't that awesome?
33+
34+
**FIRST** realize that you are creating an OS with all your applications, developer tools, even games that you want.
35+
36+
**SECONDLY** ask yourself what applications you want to have running (perhaps on boot too!).
37+
38+
### Creating your first bootable OS Containerfile
39+
40+
Want a quick straight-to-the-point Hello World Containerfile?
41+
42+
```Dockerfile
43+
FROM quay.io/centos-bootc/fedora-bootc:eln
44+
# Change your root password for a "test login"
45+
RUN echo "root:root" | chpasswd
46+
```
47+
48+
Want to make it even better?
49+
50+
[Read our Containerfile Guide!](/docs/containerfile_guide.md) We also explain how to add your first "run-on-boot" application!
51+
52+
## Extension Features
53+
54+
* Create bootable container images
55+
* One-click launching of VM's
56+
* Built-in Podman Desktop UI additions to help differentiate bootc to normal containers (bootc badges in images)
57+
* Custom icon to help indicate bootc containers
58+
59+
## Use Case
60+
61+
Go from a a [bootc](https://containers.github.io/bootc/) compatible Containerfile:
62+
63+
```Dockerfile
64+
FROM quay.io/centos-bootc/fedora-bootc:eln
65+
RUN echo "root:root" | chpasswd
66+
```
67+
68+
To a bootable container OS image format:
69+
70+
* `qcow2`: QEMU Disk Images
71+
* `ami`: Amazon Machine Images
72+
* `raw`: RAW disk image an MBR or GPT partition table
73+
* `iso`: Unattended installation method (USB Sticks / Install-on-boot)
74+
75+
## Requirements
76+
77+
Disclaimer: This is **EXPERIMENTAL** and all features are subject to change as we develop the extension.
78+
79+
### Requirement 1. Software and hardware requirements
80+
81+
**Hardware:**
82+
* macOS Silicon
83+
84+
Note: Windows & Linux not supported, but coming soon
85+
86+
**Software:**
87+
* [Podman Desktop 1.7.0+](https://github.com/containers/podman-desktop)
88+
* [Podman 4.9.0+](https://github.com/containers/podman) (should be automatically installed by Podman Desktop already)
89+
90+
### Requirement 2. Rootful mode on Podman Machine
91+
92+
Make sure your `podman machine` has rootful mode enabled.
93+
94+
This can be done through the CLI to an already deployed VM:
95+
96+
```sh
97+
podman machine stop
98+
podman machine set --rootful
99+
podman machine start
100+
```
101+
102+
Or set when initially creating a Podman Machine via Podman Desktop:
103+
104+
![rootful setup](/docs/img/rootful_setup.png)
105+
106+
## Installation
107+
108+
This extension can be installed through the **Extensions** page of Podman Desktop.
109+
To install go to *Settings > Extensions*. Copy and paste
110+
`ghcr.io/containers/podman-desktop-extension-bootc` into the *Name of the image* field
111+
and click *Install extension from the OCI image*.
112+
113+
[![](/docs/img/install_extension.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/install_extension.mp4)
114+
115+
## Usage
116+
117+
1. **Build your bootc-enabled Containerfile:**
118+
119+
> In our example, we are going to change the root password for testing purposes when accessing the OS.
120+
121+
```Dockerfile
122+
FROM quay.io/centos-bootc/fedora-bootc:eln
123+
124+
# Change the root password
125+
RUN echo "root:root" | chpasswd
126+
```
127+
128+
[![](/docs/img/build_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/build_container.mp4)
129+
130+
2. **Push the image:**
131+
132+
> IMPORTANT NOTE: This must be a **PUBLICALLY** accessible registry, this will be fixed in the future to use a local container storage
133+
134+
[![](/docs/img/push_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/push_container.mp4)
135+
136+
3. **Build the image:**
137+
138+
> Build the disk image, this takes approximatley 2-5 minutes depending on the performance of your machine.
139+
140+
[![](/docs/img/press_build.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/press_build.mp4)
141+
142+
4. **View the logs:**
143+
144+
> You can now view the conversion process within the Containers section
145+
146+
![](/docs/img/watch_logs.gif)
147+
148+
5. **Launching the VM:**
149+
150+
See our [Virtual Machine Guide](/docs/vm_guide.md) on how to launch the image!
151+
152+
6. **(EXPERIMENTAL) Testing within a container:**
153+
154+
> 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.
155+
156+
[![](/docs/img/within_container.gif)](https://github.com/containers/podman-desktop-media/raw/bootc-extension/videos/within_container.mp4)
157+
158+
You can also test your image within a container BEFORE converting by initiating the `init` boot sequence.
159+
160+
**WARNINGS:**
161+
* 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)
162+
* 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.
163+
164+
#### Run the container with the following command or through the Podman Desktop UI:
165+
166+
```sh
167+
export IMAGE=yourcontainerimage
168+
podman run \
169+
-it \
170+
--rm \
171+
--cap-add NET_ADMIN \
172+
--cap-add NET_RAW \
173+
--cap-add SYS_ADMIN \
174+
--cap-add SETUID \
175+
--cap-add SETGID \
176+
--cap-add mknod \
177+
--security-opt label=disable \
178+
--security-opt 'unmask=/proc/*' \
179+
--device=/dev/fuse \
180+
--network host \
181+
$IMAGE "/sbin/init"
182+
```
183+
184+
#### Notes on parameters being passed:
185+
186+
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.
187+
188+
The rest have to do with enabling correct networking so you have correct DNS and networking resolution.
189+
190+
```sh
191+
# Allows the correct "simulated" networking from within the container
192+
--cap-add NET_ADMIN \
193+
--cap-add NET_RAW \
194+
195+
# Disables SELinux, /proc errors
196+
# allows the correct usage of the filesystem
197+
--cap-add SYS_ADMIN \
198+
--cap-add SETUID \
199+
--cap-add SETGID \
200+
--cap-add mknod \
201+
--security-opt label=disable \
202+
--security-opt 'unmask=/proc/*' \
203+
--device=/dev/fuse \
204+
205+
# Allows the usage of the host networking / correct DNS resolution
206+
--network host \
207+
```
208+
209+
## Contributing
210+
211+
Want to help develop and contribute to the bootc extension?
212+
213+
You can use `yarn watch --extension-folder` from the Podman Desktop directory to automatically rebuild and test the bootc extension:
214+
215+
```sh
216+
git clone https://github.com/containers/podman-desktop
217+
git clone https://github.com/containers/podman-desktop-extension-bootc
218+
cd podman-desktop
219+
yarn watch --extension-folder ../podman-desktop-extension-bootc
220+
```

‎api/extensions/redhat/bootc/0.3.0/icon.png

15.9 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.