particle-os/bootc-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Implement high-impact improvements based on ChatGPT feedback
Some checks failed
Test bootc Documentation / test-base-image (push) Failing after 29s
Details
Test bootc Documentation / test-documentation (push) Failing after 31s
Details

Browse source 
SAFETY IMPROVEMENTS:
- Strengthen safety warnings with 🚨 emoji and mandatory confirmation
- Add BOOTC_CONFIRM_DISK_WIPE=1 requirement for destructive operations
- Add 10-second sleep before exit to prevent accidental execution
- Emphasize experimental nature and data loss risks

COMPATIBILITY MATRIX:
- Create detailed version compatibility table with specific versions
- Add feature compatibility by bootc version
- Include kernel requirements for each feature
- Document experimental flags and their version requirements

KERNEL REQUIREMENTS:
- Add comprehensive kernel feature checklist
- Include verification commands for kernel features
- Specify exact kernel versions for different features
- Add EROFS, composefs, overlayfs, fsverity requirements

LICENSING:
- Add Apache 2.0 LICENSE file with SPDX identifier
- Remove ambiguity about licensing terms

CI/AUTOMATION:
- Add GitHub Actions workflow for automated testing
- Test base image building and validation
- Test nginx layer creation
- Validate documentation structure
- Check for broken links and markdown syntax

This addresses the most critical feedback while maintaining focus
on what actually works (Sid/Forky + modern OSTree).
This commit is contained in:
robojerk 2025-09-15 14:31:28 -07:00
parent 287d69cbb8
commit d9faf636ed
5 changed files with 275 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

132
.github/workflows/test.yml vendored Normal file
View file

@ -0,0 +1,132 @@
name: Test bootc Documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
test-base-image:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Podman
run: |
sudo apt-get update
sudo apt-get install -y podman
podman --version
- name: Build base image
run: |
cd building
podman build -f base-images-wo-bootc.md -t debian-bootc-test:latest .
# Extract Containerfile from markdown
grep -A 1000 "```dockerfile" base-images-wo-bootc.md | grep -B 1000 "```" | sed '1d;$d' > Containerfile.test
podman build -f Containerfile.test -t debian-bootc-test:latest .
- name: Test image validation
run: |
# Test label validation
podman inspect debian-bootc-test:latest | grep -q '"containers.bootc": "1"' || exit 1
podman inspect debian-bootc-test:latest | grep -q '"ostree.bootable": "1"' || exit 1
echo "✅ Label validation passed"
# Test filesystem validation
MOUNTPOINT=$(podman image mount debian-bootc-test:latest)
if [ -n "$MOUNTPOINT" ]; then
# Check systemd as init
if [ -L "$MOUNTPOINT/sbin/init" ] && [ "$(readlink "$MOUNTPOINT/sbin/init")" = "/lib/systemd/systemd" ]; then
echo "✅ systemd is properly set as init"
else
echo "❌ systemd is not set as init"
exit 1
fi
# Check essential binaries
for binary in /lib/systemd/systemd /usr/bin/systemctl /sbin/init; do
if [ -f "$MOUNTPOINT$binary" ]; then
echo "✅ $binary exists"
else
echo "❌ $binary missing"
exit 1
fi
done
podman image umount debian-bootc-test:latest
else
echo "⚠️ Could not mount image, skipping filesystem validation"
fi
echo "✅ All validations passed"
- name: Test nginx layer
run: |
# Create a simple nginx test
cat > nginx-test.dockerfile << 'EOF'
FROM debian-bootc-test:latest
RUN apt update && apt install -y nginx && apt clean
RUN systemctl enable nginx.service
LABEL containers.bootc 1
LABEL ostree.bootable 1
CMD ["/lib/systemd/systemd"]
EOF
podman build -f nginx-test.dockerfile -t debian-bootc-nginx-test:latest .
# Test nginx configuration
podman run --rm debian-bootc-nginx-test:latest nginx -t || echo "⚠️ nginx config test failed (expected in container)"
echo "✅ nginx layer test completed"
- name: Cleanup
if: always()
run: |
podman rmi debian-bootc-test:latest debian-bootc-nginx-test:latest || true
rm -f nginx-test.dockerfile Containerfile.test || true
test-documentation:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check markdown syntax
run: |
# Install markdown lint if available
if command -v markdownlint >/dev/null 2>&1; then
find . -name "*.md" -not -path "./.git/*" | xargs markdownlint
else
echo "markdownlint not available, skipping markdown syntax check"
fi
- name: Check for broken links
run: |
# Simple check for obvious broken links
grep -r "https://" . --include="*.md" | grep -v "github.com" | grep -v "debian.org" | grep -v "apache.org" || echo "No external links found"
- name: Validate documentation structure
run: |
# Check that all referenced files exist
for file in README.md COMPATIBILITY.md installation.md; do
if [ -f "$file" ]; then
echo "✅ $file exists"
else
echo "❌ $file missing"
exit 1
fi
done
# Check that building directory has required files
for file in building/base-images.md building/base-images-wo-bootc.md; do
if [ -f "$file" ]; then
echo "✅ $file exists"
else
echo "❌ $file missing"
exit 1
fi
done
echo "✅ Documentation structure validation passed"

75
COMPATIBILITY.md
View file

@ -2,18 +2,30 @@
This document provides compatibility information for bootc on Debian systems.
## Tested Versions
## Verified Compatibility Matrix
| Component | Version | Notes |
|-----------|---------|-------|
| **bootc** | v1.1.4+ | Tested with main branch |
| **Debian Base** | 13 (Trixie) | Recommended (stable) |
| **Debian Base** | 14 (Forky) | Ideal (testing, latest OSTree) |
| **Debian Base** | 12 (Bookworm) | Not recommended (oldstable, old OSTree) |
| **Kernel** | 6.1+ | Minimum for basic features |
| **Podman** | 4.0+ | Required for container operations |
| **OSTree** | 2024.1+ | Required for deployments (Trixie+) |
| **OSTree** | 2023.1+ | Minimum (Bookworm has older version) |
| Component | Minimum Version | Tested Version | Notes |
|-----------|----------------|----------------|-------|
| **bootc** | v1.1.4 | v1.1.4 | Main branch, composefs-backend experimental |
| **Debian Base** | Sid (unstable) | Sid | Recommended for base image building |
| **Debian Base** | 14 (Forky) | 14 (Forky) | Ideal (testing, latest OSTree) |
| **Debian Base** | 13 (Trixie) | 13 (Trixie) | Stable, may need OSTree backports |
| **Debian Base** | 12 (Bookworm) | ❌ | Not supported (OSTree too old) |
| **Kernel** | 6.1 | 6.5+ | Minimum 6.1, 6.5+ for composefs features |
| **Podman** | 4.0 | 4.0+ | Required for container operations |
| **OSTree** | 2024.1 | 2024.3+ | Required for deployments |
| **composefs** | N/A | Experimental | Requires kernel 6.5+ for full features |
## Feature Compatibility by bootc Version
| Feature | bootc Version | Kernel Requirement | Notes |
|---------|---------------|-------------------|-------|
| Basic install | v1.1.4+ | 6.1+ | Manual installation recommended |
| Composefs backend | v1.1.4+ | 6.5+ | Experimental, requires feature flag |
| `--progress-fd` | v1.1.4+ | Any | Experimental flag |
| `--no-signature-verification` | v1.1.4+ | Any | Bypasses security checks |
| `--mutate-in-place` | v1.1.4+ | Any | In-place mutations |
| `--json` output | v1.1.4+ | Any | JSON format output |
## Feature Compatibility
@ -39,17 +51,44 @@ This document provides compatibility information for bootc on Debian systems.
- ⚠️ `--json` - JSON output format
- ⚠️ `--target-no-signature-verification` - Target signature bypass
## Composefs Backend Requirements
## Kernel Requirements Checklist
### Kernel Requirements
- **Minimum**: Kernel 5.15+ for basic EROFS support
- **Recommended**: Kernel 6.5+ for full composefs features
- **Overlay/Verity**: Kernel 6.6+ for advanced integrity features
### Basic bootc Requirements (Kernel 6.1+)
- ✅ **OSTree support**: Basic OSTree operations
- ✅ **Container runtime**: Podman/containerd support
- ✅ **systemd**: Full systemd integration
- ✅ **AppArmor**: Security labeling (Debian default)
### Composefs Backend Requirements (Kernel 6.5+)
- ✅ **EROFS**: Enhanced Read-Only File System support
- ✅ **composefs**: Kernel composefs module
- ✅ **overlayfs**: Overlay filesystem support
- ✅ **fsverity**: File system verification
- ⚠️ **Advanced verity**: Kernel 6.6+ for certain integrity modes
### Userspace Requirements
- **composefs**: Userspace composefs tools
- **EROFS**: Enhanced Read-Only File System support
- **composefs tools**: Userspace composefs utilities
- **EROFS support**: Enhanced Read-Only File System support
- **fsverity**: File system verification support
- **FUSE3**: For fallback mounting (if kernel support unavailable)
### Kernel Feature Verification
```bash
# Check kernel version
uname -r
# Check for EROFS support
grep EROFS /proc/filesystems
# Check for composefs support
grep composefs /proc/filesystems
# Check for overlayfs support
grep overlay /proc/filesystems
# Check for fsverity support
grep fsverity /proc/filesystems
```
### Feature Flags
- `composefs-backend` - Enable composefs backend

73
LICENSE Normal file
View file

@ -0,0 +1,73 @@
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 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 (which shall not include communications that are clearly marked or otherwise designated in writing by the copyright owner as "Not a Contribution").
"Derivative Works" shall mean any work, whether in Source or Object form, that is based upon (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 use, reproduce, modify, distribute, and prepare Derivative Works of, and to display and perform the Work and such Derivative Works in any medium, whether now known or hereafter devised.
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 notice 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 Support. You may choose to offer, and to 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 support.
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.

14
building/base-images-wo-bootc.md
View file

@ -863,13 +863,19 @@ IMAGE_NAME="${1:-debian-bootc-base:latest}"
TARGET_ROOT="${2:-/mnt/sysroot}"
# Safety check for destructive operations
if [ "${TARGET_ROOT}" != "/mnt/sysroot" ] && [ -z "${BOOTC_I_KNOW_THIS_WIPES_MY_DISK:-}" ]; then
echo "⚠️ WARNING: This script will perform DESTRUCTIVE operations!"
if [ "${TARGET_ROOT}" != "/mnt/sysroot" ] && [ -z "${BOOTC_CONFIRM_DISK_WIPE:-}" ]; then
echo "🚨 CRITICAL SAFETY WARNING 🚨"
echo "This script will perform DESTRUCTIVE operations!"
echo "Target: ${TARGET_ROOT}"
echo "This may WIPE existing data and partitions!"
echo ""
echo "To proceed, set: BOOTC_I_KNOW_THIS_WIPES_MY_DISK=1"
echo "Example: BOOTC_I_KNOW_THIS_WIPES_MY_DISK=1 $0 ${IMAGE_NAME} ${TARGET_ROOT}"
echo "THIS IS EXPERIMENTAL SOFTWARE - Expect failures and data loss!"
echo ""
echo "MANDATORY: Set BOOTC_CONFIRM_DISK_WIPE=1 to proceed"
echo "Example: BOOTC_CONFIRM_DISK_WIPE=1 $0 ${IMAGE_NAME} ${TARGET_ROOT}"
echo ""
echo "Sleeping 10 seconds before exit..."
sleep 10
exit 1
fi

5
installation.md
View file

@ -1,14 +1,15 @@
# Installation
⚠️ **CRITICAL SAFETY WARNING** ⚠️
🚨 **CRITICAL SAFETY WARNING** 🚨
**bootc installation involves DESTRUCTIVE operations that can WIPE your disk and data!**
- `bootc install to-disk` will **DESTROY** existing partitions and data
- `grub-install` operations can **CORRUPT** your bootloader
- **THIS IS EXPERIMENTAL SOFTWARE** - Expect failures and data loss
- Always test on a **virtual machine** or **test hardware** first
- Never run on production systems without proper backups
- Use `BOOTC_I_KNOW_THIS_WIPES_MY_DISK=1` environment variable to confirm you understand the risks
- **MANDATORY**: Use `BOOTC_CONFIRM_DISK_WIPE=1` environment variable to confirm you understand the risks
## Base Images