1.0.0

[jglogan]

🎂 container is one year old!

Try out the new container machine feature and let us know what you think!

Note

The UserProperty-backed system settings have been replaced by a TOML configuration file.

Highlights

⌨️ denotes breaking CLI changes.

👩‍💻 denotes breaking API changes.

• Core
  • [container machine] for long-lived Linux environments with tight host integration.
  • ⌨️ A TOML configuration file replaces UserDefault-backed system properties, removing the container system property get and set subcommands.
  • ⌨️ Cleaned up structured (JSON, YAML, TOML) output shape for container, image, network, and volume ls and inpect.
  • Fixed container help subcommand...
  • Fixed output formatting for several commands
  • Add --stop-signal option for container run
  • 👩‍💻 Removed compatibility with application major version 0 XPC APIs. A subsequent release will introduce a version on the API itself so that clients and server can check compatibility.
• Network
  • Use XPC-connection-as-lease to fix IP address leaks
• Storage
  • Add container cp command
  • Fixed accounting errors in system df

What's Changed

• Tests/CLITests: drain stdout/stderr concurrently in CLITest.run by @mvanhorn in Tests/CLITests: drain stdout/stderr concurrently in CLITest.run #1471
• Build output should just be tags/paths. by @jglogan in Build output should just be tags/paths. #1478
• Use NetworkResource for network management in API server. by @jglogan in Use NetworkResource for network management in API server. #1421
• Use SystemPath for HostDNSResolver. by @jglogan in Use SystemPath for HostDNSResolver. #1480
• Update documents with note about container-to-host networking. by @jglogan in Update documents with note about container-to-host networking. #1482
• Sort networks by ID in API server list(). by @jglogan in Sort networks by ID in API server list(). #1487
• CLI: Support --shm-size by @dcantah in CLI: Support --shm-size #1488
• Improve integration test speed by @noah-thor in Improve integration test speed #1489
• Simplify the serial suite trait by @katiewasnothere in Simplify the serial suite trait #1497
• Switch NetworksService, VolumesService, EntityStore to FilePath. by @jglogan in Switch NetworksService, VolumesService, EntityStore to FilePath. #1493
• [scripts]: add prompt for updating container with unsigned package by @saehejkang in [scripts]: add prompt for updating container with unsigned package #1468
• Change PR build to generate coverage and comment it by @noah-thor in Change PR build to generate coverage and comment it #1474
• Deps: Bump CZ to 0.32.0 by @dcantah in Deps: Bump CZ to 0.32.0 #1498
• Move to TOML configuration for defaults by @noah-thor in Move to TOML configuration for defaults #1425
• docs: fix typos and polish README wording by @12ya in docs: fix typos and polish README wording #1499
• De-duplicate building during testing by @noah-thor in De-duplicate building during testing #1507
• Centralize utilities for configuration loading and path parsing by @noah-thor in Centralize utilities for configuration loading and path parsing #1448
• Use SystemPath for PacketFilter. by @chrisgeo in Use SystemPath for PacketFilter. #1518
• swift-configuration decoder by @noah-thor in swift-configuration decoder #1447
• Fix PR coverage comment never posting by @noah-thor in Fix PR coverage comment never posting #1541
• Use SystemPath for DirectoryWatcher. by @chrisgeo in Use SystemPath for DirectoryWatcher. #1522
• Adds XPC sessions with disconnect handlers. by @jglogan in Adds XPC sessions with disconnect handlers. #1524
• Use allocate with session to automatically clean up IPs. by @jglogan in Use allocate with session to automatically clean up IPs. #1544
• Use SystemPath for ContainerResource.Filesystem. by @chrisgeo in Use SystemPath for ContainerResource.Filesystem. #1523
• Add support for layered and plugin configurations by @noah-thor in Add support for layered and plugin configurations #1543
• Bump containerization to 0.32.1 by @JaewonHur in Bump containerization to 0.32.1 #1549
• Remove IP allocation from API server. by @jglogan in Remove IP allocation from API server. #1545
• Add variant Support by @ajemory in Add variant Support #1548
• ci: bump actions/labeler from 6.0.1 to 6.1.0 in the github-actions group by @dependabot[bot] in ci: bump actions/labeler from 6.0.1 to 6.1.0 in the github-actions group #1550
• Relax host-only network test. by @jglogan in Relax host-only network test. #1552
• Fix inconsistent volume createdAt JSON encoding by @realrajaryan in Fix inconsistent volume createdAt JSON encoding #1556
• Fix: image list align with other commands when use format should ignore quiet by @tico88612 in Fix: image list align with other commands when use format should ignore quiet #1553
• Reject conflicting DNS flags by @LeSingh1 in Reject conflicting DNS flags #1559
• Reject conflicting volume delete flags by @realrajaryan in Reject conflicting volume delete flags #1560
• Validate container system logs --last flag by @realrajaryan in Validate container system logs --last flag #1561
• Ensure read-only user config removed on every startup. by @jglogan in Ensure read-only user config removed on every startup. #1567
• Rename config file to config.toml. by @jglogan in Rename config file to config.toml. #1568
• Make inspect error handling for missing resources consistent by @realrajaryan in Make inspect error handling for missing resources consistent #1564
• Add container copy/cp command for host-container file transfer by @simone-panico in Add container copy/cp command for host-container file transfer #1190
• [images]: convert save to use FilePath by @saehejkang in [images]: convert save to use FilePath #1574
• [images]: fix image load error to write to stderr and use FilePath by @saehejkang in [images]: fix image load error to write to stderr and use FilePath #1570
• Reorganize runtime targets for scalable plugin support by @ajemory in Reorganize runtime targets for scalable plugin support #1577
• Add more tests for container copy by @JaewonHur in Add more tests for container copy #1579
• Update container copy to use FilePath by @JaewonHur in Update container copy to use FilePath #1580
• Add notes regarding --log-root to the command reference. by @jglogan in Add notes regarding --log-root to the command reference. #1582
• cli: Add support for --stop-signal by @dcantah in cli: Add support for --stop-signal #1462
• fix: clamp ProgressBar barLength to non-negative value to avoid crash by @ErwanLegrand in fix: clamp ProgressBar barLength to non-negative value to avoid crash #1525
• Adds vertical space between groups in help. by @jglogan in Adds vertical space between groups in help. #1585
• Refine custom init how-to and BUILDING documentation. by @jglogan in Refine custom init how-to and BUILDING documentation. #1586
• Improve readability of progress bar width computation. by @jglogan in Improve readability of progress bar width computation. #1584
• Bump containerization to 0.33.1 by @dkovba in Bump containerization to 0.33.1 #1601
• Use FilePath for app, install, and log roots. by @jglogan in Use FilePath for app, install, and log roots. #1558
• Support use of custom app root with system config in CLI commands by @katiewasnothere in Support use of custom app root with system config in CLI commands #1600
• Add shmSize to management flag's init by @katiewasnothere in Add shmSize to management flag's init #1603
• cli: resolve subcommand path in container help by @0xMH in cli: resolve subcommand path in container help #1587
• Add ability to configure integration test list at command line by @katiewasnothere in Add ability to configure integration test list at command line #1608
• Align JSON output with shape for container resource. by @jglogan in Align JSON output with shape for container resource. #1611
• Use ManagedResource for volumes in CLI commands by @katiewasnothere in Use ManagedResource for volumes in CLI commands #1607
• Fix potential integer math crash on PublishPort. by @jglogan in Fix potential integer math crash on PublishPort. #1612
• Reorganize Swift package targets for network plugin. by @jglogan in Reorganize Swift package targets for network plugin. #1615
• [how-to]: fix documentation example by @saehejkang in [how-to]: fix documentation example #1596
• Remove XPC compatibility code, simplify network model. by @jglogan in Remove XPC compatibility code, simplify network model. #1616
• Use FilePath for PublishSocket by @chrisgeo in Use FilePath for PublishSocket #1594
• Fix system df to count content blobs and deduplicate shared storage by @realrajaryan in Fix system df to count content blobs and deduplicate shared storage #1555
• Create ImageResource conforming to ManagedResource by @katiewasnothere in Create ImageResource conforming to ManagedResource #1619
• Use a consistent container CLI path in integration tests by @zdk in Use a consistent container CLI path in integration tests #1621
• Normalize JSON output for network and volume resources. by @jglogan in Normalize JSON output for network and volume resources. #1624
• Fix TestCLIVersion build-type check for release CI by @zdk in Fix TestCLIVersion build-type check for release CI #1627
• Add NOTICE entry for swift-configuration-toml by @katiewasnothere in Add NOTICE entry for swift-configuration-toml #1629
• kill: Wait for container to exit after sigkill by @dcantah in kill: Wait for container to exit after sigkill #1589
• Add an error message for dockerfile >= 16KB until [Bug]: "Transport became inactive" on 'container build' (0.5.0) – 16k limit on Container-files? #735 is resolved by @katiewasnothere in Add an error message for dockerfile >= 16KB until #735 is resolved #1634
• Write log/error output from commands to stderr. by @jglogan in Write log/error output from commands to stderr. #1632
• Add docs on using container system configurations by @katiewasnothere in Add docs on using container system configurations #1636
• Fix make test SIGSEGV on Swift 6.2 by @ajemory in Fix make test SIGSEGV on Swift 6.2 #1638
• Fix type in memory size format for config docs by @katiewasnothere in Fix type in memory size format for config docs #1639
• Use name instead of id in NetworkConfiguration. by @jglogan in Use name instead of id in NetworkConfiguration. #1648
• Make pre-commit hook installation and execution work in git worktrees by @harshitsinghbhandari in Make pre-commit hook installation and execution work in git worktrees #1643
• [Actions] Use commit sha for imported gh actions by @katiewasnothere in [Actions] Use commit sha for imported gh actions #1649
• Rearrange shape of JSON output for images by @katiewasnothere in Rearrange shape of JSON output for images #1652
• Fix --format yaml and toml output by @realrajaryan in Fix --format yaml and toml output #1653
• Update command ref and how to docs by @realrajaryan in Update command ref and how to docs #1654
• Auto-install hawkeye in ensure-hawkeye-exists.sh by @harshitsinghbhandari in Auto-install hawkeye in ensure-hawkeye-exists.sh #1644
• [images]: fix image load/save to use FilePathOps utility by @saehejkang in [images]: fix image load/save to use FilePathOps utility #1590
• Omit hash scheme from image.id. by @jglogan in Omit hash scheme from image.id. #1658
• Remove duplicated image name in image JSON output by @katiewasnothere in Remove duplicated image name in image JSON output #1655
• Conform containers to ManagedResource by @ajemory in Conform containers to ManagedResource #1656
• Increase CI timeout to 75 minutes by @realrajaryan in Increase CI timeout to 75 minutes #1663
• Add container machine for managing persistent Linux environments by @realrajaryan in Add container machine for managing persistent Linux environments #1662
• Add backward compat for ContainerConfig cpuOverhead. by @jglogan in Add backward compat for ContainerConfig cpuOverhead. #1665

New Contributors

• @12ya made their first contribution in docs: fix typos and polish README wording #1499
• @chrisgeo made their first contribution in Use SystemPath for PacketFilter. #1518
• @LeSingh1 made their first contribution in Reject conflicting DNS flags #1559
• @ErwanLegrand made their first contribution in fix: clamp ProgressBar barLength to non-negative value to avoid crash #1525
• @0xMH made their first contribution in cli: resolve subcommand path in container help #1587
• @harshitsinghbhandari made their first contribution in Make pre-commit hook installation and execution work in git worktrees #1643

Full Changelog: 0.12.3...1.0.0

---

This discussion was created from the release 1.0.0.

[outcoldman]

Would be nice to actually have some technical overview between container run and container machine run, is the second one just some wrappers around container run to pass the cwd/uid? What is the difference if I will run some image with /sbin/init in it via container run vs container machine run, I would assume first one will have double init process, and second only one? Can I run multiple containers inside of the created container machine? I really have 0 clue what is the purpose of the machine vs container? Should container machine be just a flag instead of a whole subcommand?

[afbjorklund]

I didn't think that container needed a new API, but now that it has - the new one is actually better than the old API...

Now container machine is working a lot more like WSL and Lima, and that was the feature that was being asked for:

• Feature Discussion: `distro` subsystem #868

It doesn't pretend to run containers, that you can do just fine in the "machine" being created (by installing Docker in it).

I would probably have called them Linux Machines (Lima) instead of Container Machines, and coma is a bit unfortunate?

alias coma='container machine run'

The full command looks a bit unwieldy?

[afbjorklund]

It also needed the example to go in, to explain why alpine "works" (without init) but ubuntu did not (without adding systemd).

• [Request]: Create examples/ directory with container machine demonstration. #1675
  https://github.com/apple/container/tree/main/examples/

The vanilla "alpine" image doesn't work properly either, since it doesn't have "sudo" and it doesn't have openrc - but it starts...

coma --uid=0 apk add sudo openrc alpine-conf
coma sudo setup-interfaces -a # /etc/network

[egernst]

Good documentation/example suggestions @afbjorklund — appreciate it!

[subpop]

@subpop There is no default VM. Each machine you make runs in its own VM just as the containers do. If you ignore all of the UX additions Eric mentioned the easiest notable change is just that the filesystem sticks around between runs much like you'd be used to from a traditional VM experience

Yea, I realized that. I'm exploring this more. It's looking wonderful!

[pantheraleo-7]

FWIW: for sudo needs, the --root flag works perfectly for single command runs

[jfmatth]

Congrats on 1.0. Saw the talk at SCALE this year, interesting.

[pantheraleo-7]

[afbjorklund]

You can use --env (and --env-file), to add what environment variables you want to include from the host.

$ coma --env TERM --env LANG

[afbjorklund]

They are not set up for single command runs either, it is just that the variable is expanded by the host shell.

[subpop]

You need to escape the $ to pass it into the guest environment.

link@links-imac ~ % container machine run -n alma10 echo \$TERM
dumb
link@links-imac ~ % container machine run -n alma10 echo $TERM
xterm-ghostty

[pantheraleo-7]

oopsie. nuked the noise.

[pantheraleo-7]

on second thought, this looks like a good feature request - setting up terminfo, locale, etc of the host terminal in the container machine.