NucleicandClaude Opus 4.8
11b9825e09
Switch the containerization dependency from the github URL to a vendored copy (third_party/containerization, upstream commit 6b7b42ca) referenced by path, so we can carry a small local patch that upstream lacks: LinuxContainer.Configuration gains a `vmExtensions` field forwarded into VMConfiguration.extensions. Upstream already supports VMConfiguration.extensions + the VZInstanceExtension hook, but LinuxContainer — our only entry point — never forwarded them, so there was no way to attach a device (e.g. a memory balloon) to a container's VM. Tests/, docs/, examples/, images/ and the corresponding test targets are trimmed for footprint (we never build the dependency's tests). See PATCHES.md for the full diff vs. upstream and the re-vendoring procedure. Also adds the ContainerizationExtras product to NucleicCore (AddressAllocator, named in the configureVZ signature). Co-Authored-By: Claude Opus 4.8 <[email protected]>
38 lines
2.3 KiB
Markdown
38 lines
2.3 KiB
Markdown
# Vendored `containerization` — Nucleic patches
|
|
|
|
This is a **vendored copy** of [apple/containerization](https://github.com/apple/containerization)
|
|
at upstream commit `6b7b42ca3efeee8c706070e4355e6a807c5336ae`, referenced by the root `Package.swift`
|
|
via `.package(path: "third_party/containerization")` instead of the github URL.
|
|
|
|
It is vendored (not pulled) because we carry a local patch upstream doesn't have. Keeping it
|
|
in-tree means the patch can't be lost to a dependency re-resolve.
|
|
|
|
## What's changed vs. upstream
|
|
|
|
1. **`Sources/Containerization/LinuxContainer.swift` — forward VM extensions.**
|
|
`LinuxContainer.Configuration` gains a `vmExtensions: [any Sendable]` field, and
|
|
`LinuxContainer` assigns it into `VMConfiguration.extensions` when it builds the VM config.
|
|
Upstream already supports `VMConfiguration.extensions` + the `VZInstanceExtension` hook
|
|
(`configureVZ`/`didCreate`), but `LinuxContainer` — the only entry point we use — never forwarded
|
|
it, so there was no way to attach a device (e.g. a virtio memory balloon) to a container's VM.
|
|
Search for the marker comment `[Nucleic vendored patch]` to find both edit sites.
|
|
|
|
Nucleic uses this to attach a `VZVirtioTraditionalMemoryBalloonDeviceConfiguration` and drive its
|
|
target at runtime for automatic VM memory reclamation — see `MemoryBalloon.swift` /
|
|
`ContainerEngine` in NucleicCore.
|
|
|
|
2. **Trimmed for footprint (no behavior change).** `Tests/`, `docs/`, `examples/`, and `images/`
|
|
were dropped, and the corresponding `.testTarget(...)` entries removed from `Package.swift`. The
|
|
library/executable targets we build are untouched.
|
|
|
|
## Re-vendoring a newer upstream commit
|
|
|
|
1. `git clone` upstream (or copy `.build/checkouts/containerization` after bumping the URL pin
|
|
temporarily), check out the desired commit.
|
|
2. `rsync -a --exclude=.git --exclude=.build --exclude=.swiftpm --exclude=Tests/ --exclude=docs/ \
|
|
--exclude=examples/ --exclude=images/ <upstream>/ third_party/containerization/`
|
|
3. Remove the `.testTarget(...)` blocks from `third_party/containerization/Package.swift`.
|
|
4. Re-apply patch #1 (the `vmExtensions` field + the `vmConfig.extensions = …` forward).
|
|
5. Update the commit hash above and in the root `Package.swift` comment.
|
|
6. `swift build` and run the balloon tests.
|