Files
container/Sources/Services/MachineAPIService/Client/MachineSnapshot.swift
T
Raj b2994ac369 Add container machine for managing persistent Linux VMs (#1662)
## Type of Change
- [ ] Bug fix
- [x] New feature  
- [ ] Breaking change
- [ ] Documentation update

## Motivation and Context
`container` runs each workload in an ephemeral VM, so there's no
built-in way to keep a persistent Linux environment you can log into and
work in. `container machine` adds one.

A container machine is a lightweight, persistent, and integrated Linux
environments that feel like an extension of your Mac, created from
standard OCI images with a familiar UX. The login user matches your host
account with passwordless `sudo`, your home directory is mounted inside
the VM, and each machine keeps its filesystem and runs the image's own
init system (such as`systemd` or `openrc`).

```bash
container machine create alpine:3.22 --name my-machine
container machine run -n my-machine # interactive shell
container machine set -n my-machine cpus=4 memory=8G
```

Subcommands: `create`, `run`, `list` (`ls`), `inspect`, `set`,
`set-default`, `logs`, `stop`, `delete` (`rm`); `m` aliases `machine`.
Docs added to `docs/command-reference.md` (Machine Management) and
`docs/how-to.md` ("Use container machines").

## Testing
- [x] Tested locally
- [x] Added/updated tests
- [x] Added/updated docs

Signed-off-by: Raj Aryan Singh <rajaryan_singh@apple.com>
Co-authored-by: Jaewon Hur <jaewon_hur@apple.com>
Co-authored-by: John Logan <john_logan@apple.com>
Co-authored-by: Michael Crosby <michael_crosby@apple.com>
Co-authored-by: Eric Ernst <eric_ernst@apple.com>
Co-authored-by: Danny Canter <danny_canter@apple.com>
2026-06-08 11:38:49 -07:00

85 lines
3.2 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2026 Apple Inc. and the container project authors.
//
// 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
//
// https://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.
//===----------------------------------------------------------------------===//
import ContainerPersistence
import ContainerResource
import ContainerizationOCI
import Foundation
public struct MachineSnapshot: Codable, Sendable {
public var configuration: MachineConfiguration
public var status: RuntimeStatus
public var bootConfig: MachineConfig
public var startedDate: Date?
public var createdDate: Date?
public var containerId: String?
public var ipAddress: String?
public var diskSize: UInt64?
public var initialized: Bool
public var id: String { configuration.id }
public var platform: ContainerizationOCI.Platform { configuration.platform }
enum CodingKeys: String, CodingKey {
case configuration
case status
case startedDate
case createdDate
case containerId
case bootConfig
case ipAddress
case diskSize
case initialized
}
public init(
configuration: MachineConfiguration,
status: RuntimeStatus,
bootConfig: MachineConfig,
startedDate: Date? = nil,
createdDate: Date? = nil,
containerId: String? = nil,
ipAddress: String? = nil,
diskSize: UInt64? = nil,
initialized: Bool = false,
) {
self.configuration = configuration
self.status = status
self.bootConfig = bootConfig
self.startedDate = startedDate
self.createdDate = createdDate
self.containerId = containerId
self.ipAddress = ipAddress
self.diskSize = diskSize
self.initialized = initialized
}
public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
configuration = try container.decode(MachineConfiguration.self, forKey: .configuration)
status = try container.decode(RuntimeStatus.self, forKey: .status)
bootConfig = try container.decode(MachineConfig.self, forKey: .bootConfig)
startedDate = try container.decodeIfPresent(Date.self, forKey: .startedDate)
createdDate = try container.decodeIfPresent(Date.self, forKey: .createdDate)
containerId = try container.decodeIfPresent(String.self, forKey: .containerId)
ipAddress = try container.decodeIfPresent(String.self, forKey: .ipAddress)
diskSize = try container.decodeIfPresent(UInt64.self, forKey: .diskSize)
initialized = try container.decodeIfPresent(Bool.self, forKey: .initialized) ?? false
}
}