Added youki build and fromatting of scripts
This commit is contained in:
51
claude.md
51
claude.md
@@ -160,6 +160,47 @@ release:corex:https://github.com/threefoldtech/corex/releases/download/2.1.4/cor
|
||||
|
||||
**Service definitions:** YAML files in `config/zinit/` with `after:`, `needs:`, `wants:` dependencies
|
||||
|
||||
### 6. Kernel Versioning and S3 Upload
|
||||
|
||||
**Versioned Kernel Output:**
|
||||
- Standard kernel: `dist/vmlinuz.efi` (for compatibility)
|
||||
- Versioned kernel: `dist/vmlinuz-{VERSION}-{ZINIT_HASH}.efi`
|
||||
- Example: `vmlinuz-6.12.44-Zero-OS-a1b2c3d.efi`
|
||||
|
||||
**Version components:**
|
||||
- `{VERSION}`: Full kernel version from `KERNEL_VERSION` + `CONFIG_LOCALVERSION`
|
||||
- `{ZINIT_HASH}`: Short git commit hash from `components/zinit/.git`
|
||||
|
||||
**S3 Upload (optional):**
|
||||
- Controlled by `UPLOAD_KERNEL=true` environment variable
|
||||
- Uses MinIO client (`mcli` or `mc`) to upload to S3-compatible storage
|
||||
- Uploads versioned kernel to: `s3://{bucket}/{prefix}/kernel/{versioned_filename}`
|
||||
|
||||
**Kernel Index Generation:**
|
||||
After uploading, automatically generates and uploads index files:
|
||||
- `kernels.txt` - Plain text, one kernel per line, sorted reverse chronologically
|
||||
- `kernels.json` - JSON format with metadata (timestamp, count)
|
||||
|
||||
**Why index files?**
|
||||
- S3 web interfaces often don't support directory listings
|
||||
- Enables dropdown menus in web UIs without S3 API access
|
||||
- Provides kernel discovery for deployment tools
|
||||
|
||||
**JSON index structure:**
|
||||
```json
|
||||
{
|
||||
"kernels": ["vmlinuz-6.12.44-Zero-OS-abc1234.efi", ...],
|
||||
"updated": "2025-01-04T12:00:00Z",
|
||||
"count": 2
|
||||
}
|
||||
```
|
||||
|
||||
**Key functions:**
|
||||
- `get_git_commit_hash()` in `scripts/lib/common.sh` - Extracts git hash
|
||||
- `kernel_build_with_initramfs()` in `scripts/lib/kernel.sh` - Creates versioned kernel
|
||||
- `kernel_upload_to_s3()` in `scripts/lib/kernel.sh` - Uploads to S3
|
||||
- `kernel_generate_index()` in `scripts/lib/kernel.sh` - Generates and uploads index
|
||||
|
||||
## Critical Conventions
|
||||
|
||||
### Path Normalization
|
||||
@@ -394,8 +435,14 @@ rm -rf .build-stages/ # Reset stage markers
|
||||
**Firmware tagging:**
|
||||
- `FIRMWARE_TAG=20250908` - Firmware flist version tag
|
||||
|
||||
**RFS configuration:**
|
||||
**S3 upload control:**
|
||||
- `UPLOAD_KERNEL=true` - Upload versioned kernel to S3 (default: false)
|
||||
- `UPLOAD_MANIFESTS=true` - Upload RFS flists to S3 (default: false)
|
||||
- `KERNEL_SUBPATH=kernel` - S3 subpath for kernel uploads (default: kernel)
|
||||
|
||||
**S3 configuration:**
|
||||
- See `config/rfs.conf` for S3 endpoint, credentials, paths
|
||||
- Used by both RFS flist uploads and kernel uploads
|
||||
|
||||
## Documentation Hierarchy
|
||||
|
||||
@@ -466,6 +513,8 @@ Co-Authored-By: Claude <noreply@anthropic.com>
|
||||
- **Size too large:** Check cleanup stage, strip/UPX execution, package list
|
||||
- **Container issues:** Rootless setup, subuid/subgid, podman vs docker
|
||||
- **RFS mount fails:** S3 credentials, network readiness, flist manifest paths
|
||||
- **Kernel upload:** `UPLOAD_KERNEL=true`, requires `config/rfs.conf`, MinIO client (`mcli`/`mc`)
|
||||
- **Kernel index:** Auto-generated `kernels.txt`/`kernels.json` for dropdown UIs, updated on upload
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user