Move to TOML configuration for defaults

This change migrates away from using `UserDefaults`, instead providing a
TOML configuration mechanism for user configurable settings. Users will
have to migrate any custom defaults configured via `UserDefaults` into a
toml configuration file in `~/.config/container/`.
- Addresses discussion #1336

Author: noah-thor

BUILDING.md

@@ -80,10 +80,11 @@ to prepare your build environment.
     >
     > **Note:** If you have already run `swift package edit`, whether intentionally or by accident, follow the steps in the next section to restore the normal `containerization` dependency. Otherwise, the modified `Package.swift` file will not work, and the project may fail to build.
 
-5. If you want `container` to use any changes you made in the `vminit` subproject of Containerization, update the system property to use the locally built init filesystem image:
+5. If you want `container` to use any changes you made in the `vminit` subproject of Containerization, set the init image in your runtime configuration file at `~/.config/container/runtime-config.toml`:
 
-    ```bash
-    container system property set image.init vminit:latest 
+    ```toml
+    [image]
+    initImage = "vminit:latest"
     ```
 
 6. Build `container`.
@@ -101,11 +102,7 @@ to prepare your build environment.
 
 To revert to using the Containerization dependency from your `Package.swift`:
 
-1. If you were using the local init filesystem, revert the system property to its default value:
-
-    ```bash
-    container system property clear image.init
-    ```
+1. If you were using the local init filesystem, remove the `init` override from your `~/.config/container/runtime-config.toml` (or delete the `[image]` section if no other image settings are present).
 
 2. Use the Swift package manager to restore the normal `containerization` dependency and update your `Package.resolved` file. If you are using Xcode, revert your `Package.swift` change instead of using `swift package unedit`.
 
@@ -133,14 +130,20 @@ To test changes that require the `container-builder-shim` project:
 
 1. Clone the [container-builder-shim](https://github.com/apple/container-builder-shim) repository and navigate to its directory.
 
-2. After making the necessary changes, build the custom builder image, set it as the active builder image, and remove the existing `buildkit` container so the new image will be used:
+2. After making the necessary changes, build the custom builder image, set it as the active builder image in `~/.config/container/runtime-config.toml`, and remove the existing `buildkit` container so the new image will be used:
 
 ```bash
 container build -t builder .
-container system property set image.builder builder:latest
 container rm -f buildkit
 ```
 
+Add the following to your `~/.config/container/runtime-config.toml`:
+
+```toml
+[image]
+builder = "builder:latest"
+```
+
 3. Run the `container` build as usual:
 
 ```bash

Package.resolved

@@ -77,8 +77,10 @@ let package = Package(
                 .product(name: "ContainerizationArchive", package: "containerization"),
                 .product(name: "ContainerizationExtras", package: "containerization"),
                 .product(name: "ContainerizationOS", package: "containerization"),
+                .product(name: "TOML", package: "swift-toml"),
                 "ContainerBuild",
                 "ContainerLog",
+                "ContainerPersistence",
                 "ContainerResource",
             ],
             path: "Tests/CLITests"
@@ -89,6 +91,7 @@ let package = Package(
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
                 .product(name: "Logging", package: "swift-log"),
                 .product(name: "SwiftProtobuf", package: "swift-protobuf"),
+                .product(name: "TOML", package: "swift-toml"),
                 .product(name: "Containerization", package: "containerization"),
                 .product(name: "ContainerizationOCI", package: "containerization"),
                 .product(name: "ContainerizationOS", package: "containerization"),
@@ -215,6 +218,7 @@ let package = Package(
                 .product(name: "SystemPackage", package: "swift-system"),
                 "ContainerImagesService",
                 "ContainerLog",
+                "ContainerPersistence",
                 "ContainerPlugin",
                 "ContainerVersion",
                 "ContainerXPC",
@@ -263,6 +267,7 @@ let package = Package(
                 "ContainerLog",
                 "ContainerNetworkService",
                 "ContainerNetworkServiceClient",
+                "ContainerPersistence",
                 "ContainerPlugin",
                 "ContainerResource",
                 "ContainerVersion",
@@ -379,6 +384,8 @@ let package = Package(
             dependencies: [
                 .product(name: "Logging", package: "swift-log"),
                 .product(name: "Containerization", package: "containerization"),
+                .product(name: "SystemPackage", package: "swift-system"),
+                .product(name: "TOML", package: "swift-toml"),
                 "CVersion",
                 "ContainerVersion",
             ]

Package.swift

@@ -19,6 +19,7 @@ import ContainerAPIClient
 import ContainerAPIService
 import ContainerLog
 import ContainerNetworkService
+import ContainerPersistence
 import ContainerPlugin
 import ContainerResource
 import ContainerXPC
@@ -37,6 +38,9 @@ extension APIServer {
         static let listenAddress = "127.0.0.1"
         static let localhostDNSPort = 1053
         static let dnsPort = 2053
+        private static let containerSystemConfig: ContainerSystemConfig = try! SystemRuntimeOptions.loadConfig(
+            configFile: SystemRuntimeOptions.configFileFromAppRoot(ApplicationRoot.url)
+        )
 
         @Flag(name: .long, help: "Enable debug logging")
         var debug = false
@@ -60,6 +64,7 @@ extension APIServer {
                 log.info("configuring XPC server")
                 var routes = [XPCRoute: XPCServer.RouteHandler]()
                 let pluginLoader = try initializePluginLoader(log: log)
+
                 try await initializePlugins(pluginLoader: pluginLoader, log: log, routes: &routes)
                 let containersService = try initializeContainersService(
                     pluginLoader: pluginLoader,
@@ -261,12 +266,17 @@ extension APIServer {
             routes[XPCRoute.getDefaultKernel] = harness.getDefaultKernel
         }
 
-        private func initializeContainersService(pluginLoader: PluginLoader, log: Logger, routes: inout [XPCRoute: XPCServer.RouteHandler]) throws -> ContainersService {
+        private func initializeContainersService(
+            pluginLoader: PluginLoader,
+            log: Logger,
+            routes: inout [XPCRoute: XPCServer.RouteHandler]
+        ) throws -> ContainersService {
             log.info("initializing containers service")
 
             let service = try ContainersService(
                 appRoot: appRoot,
                 pluginLoader: pluginLoader,
+                containerSystemConfig: Self.containerSystemConfig,
                 log: log,
                 debugHelpers: debug
             )

Sources/APIServer/APIServer+Start.swift

@@ -15,6 +15,7 @@
 //===----------------------------------------------------------------------===//
 
 import ContainerAPIClient
+import ContainerPersistence
 import Containerization
 import ContainerizationOCI
 import Foundation
@@ -27,12 +28,16 @@ struct BuildImageResolver: BuildPipelineHandler {
     let quiet: Bool
     let output: FileHandle
     let pull: Bool
+    let containerSystemConfig: ContainerSystemConfig
 
-    public init(_ contentStore: ContentStore, quiet: Bool = false, output: FileHandle = FileHandle.standardError, pull: Bool = false) throws {
+    public init(_ contentStore: ContentStore, quiet: Bool = false, output: FileHandle = FileHandle.standardError, pull: Bool = false, containerSystemConfig: ContainerSystemConfig)
+        throws
+    {
         self.contentStore = contentStore
         self.quiet = quiet
         self.output = output
         self.pull = pull
+        self.containerSystemConfig = containerSystemConfig
     }
 
     func accept(_ packet: ServerStream) throws -> Bool {
@@ -75,10 +80,10 @@ struct BuildImageResolver: BuildPipelineHandler {
             progress.start()
 
             if self.pull {
-                return try await ClientImage.pull(reference: ref, platform: platform, progressUpdate: progress.handler)
+                return try await ClientImage.pull(reference: ref, platform: platform, containerSystemConfig: containerSystemConfig, progressUpdate: progress.handler)
             }
             // Use fetch() which checks cache first, then pulls if needed
-            return try await ClientImage.fetch(reference: ref, platform: platform, progressUpdate: progress.handler)
+            return try await ClientImage.fetch(reference: ref, platform: platform, containerSystemConfig: containerSystemConfig, progressUpdate: progress.handler)
         }()
 
         let index: Index = try await img.index()

Sources/ContainerBuild/BuildImageResolver.swift

@@ -30,7 +30,9 @@ public actor BuildPipeline {
             [
                 try BuildFSSync(URL(filePath: config.contextDir)),
                 try BuildRemoteContentProxy(config.contentStore),
-                try BuildImageResolver(config.contentStore, quiet: config.quiet, output: config.terminal?.handle ?? FileHandle.standardError, pull: config.pull),
+                try BuildImageResolver(
+                    config.contentStore, quiet: config.quiet, output: config.terminal?.handle ?? FileHandle.standardError, pull: config.pull,
+                    containerSystemConfig: config.containerSystemConfig),
                 try BuildStdio(quiet: config.quiet, output: config.terminal?.handle ?? FileHandle.standardError),
             ]
     }

Sources/ContainerBuild/BuildPipelineHandler.swift

@@ -15,6 +15,7 @@
 //===----------------------------------------------------------------------===//
 
 import ContainerAPIClient
+import ContainerPersistence
 import Containerization
 import ContainerizationOCI
 import ContainerizationOS
@@ -254,6 +255,7 @@ public struct Builder: Sendable {
         public let cacheIn: [String]
         public let cacheOut: [String]
         public let pull: Bool
+        public let containerSystemConfig: ContainerSystemConfig
 
         public init(
             buildID: String,
@@ -273,7 +275,8 @@ public struct Builder: Sendable {
             exports: [BuildExport],
             cacheIn: [String],
             cacheOut: [String],
-            pull: Bool
+            pull: Bool,
+            containerSystemConfig: ContainerSystemConfig
         ) {
             self.buildID = buildID
             self.contentStore = contentStore
@@ -293,6 +296,7 @@ public struct Builder: Sendable {
             self.cacheIn = cacheIn
             self.cacheOut = cacheOut
             self.pull = pull
+            self.containerSystemConfig = containerSystemConfig
         }
     }
 }

Sources/ContainerBuild/Builder.swift

@@ -18,6 +18,8 @@ import ArgumentParser
 import ContainerAPIClient
 import ContainerBuild
 import ContainerImagesServiceClient
+import ContainerPersistence
+import ContainerPlugin
 import Containerization
 import ContainerizationError
 import ContainerizationOCI
@@ -40,6 +42,10 @@ extension Application {
             return config
         }
 
+        private static let containerSystemConfig: ContainerSystemConfig = try! SystemRuntimeOptions.loadConfig(
+            configFile: SystemRuntimeOptions.configFileFromAppRoot(ApplicationRoot.url)
+        )
+
         enum ProgressType: String, ExpressibleByArgument {
             case auto
             case plain
@@ -192,7 +198,8 @@ extension Application {
                                     memory: memory,
                                     log: log,
                                     dnsNameservers: dnsNameservers,
-                                    progressUpdate: progress.handler
+                                    progressUpdate: progress.handler,
+                                    containerSystemConfig: Self.containerSystemConfig,
                                 )
 
                                 // wait (seconds) for builder to start listening on vsock
@@ -351,7 +358,9 @@ extension Application {
                         return results
                     }()
                     group.addTask {
-                        [terminal, buildArg, secretsData, contextDir, hiddenDockerDir, label, noCache, target, quiet, cacheIn, cacheOut, pull, exports, imageNames, tempURL, log] in
+                        [
+                            terminal, buildArg, secretsData, contextDir, hiddenDockerDir, label, noCache, target, quiet, cacheIn, cacheOut, pull, exports, imageNames, tempURL, log,
+                        ] in
                         let config = Builder.BuildConfig(
                             buildID: buildID,
                             contentStore: RemoteContentStoreClient(),
@@ -370,7 +379,8 @@ extension Application {
                             exports: exports,
                             cacheIn: cacheIn,
                             cacheOut: cacheOut,
-                            pull: pull
+                            pull: pull,
+                            containerSystemConfig: Self.containerSystemConfig,
                         )
                         progress.finish()