mirror of
https://github.com/apple/container.git
synced 2026-07-12 12:37:02 +00:00
Raj
b4c3ebfed8
- Closes #508. ## Type of Change - [ ] Bug fix - [x] New feature - [ ] Breaking change - [ ] Documentation update ## Motivation and Context Adds a `container volume prune` command that removes volumes with no container references and reports the amount of disk space reclaimed. This helps users clean up unused volumes and easily reclaim disk space. Also updates the `volume delete` documentation to clarify and highlight how the `--all` flag works. ## Testing - [x] Tested locally - [x] Added/updated tests - [x] Added/updated docs
99 lines
3.5 KiB
Swift
99 lines
3.5 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
// Copyright © 2025 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 ContainerXPC
|
|
import Containerization
|
|
import Foundation
|
|
|
|
public struct ClientVolume {
|
|
static let serviceIdentifier = "com.apple.container.apiserver"
|
|
|
|
public static func create(
|
|
name: String,
|
|
driver: String = "local",
|
|
driverOpts: [String: String] = [:],
|
|
labels: [String: String] = [:]
|
|
) async throws -> Volume {
|
|
let client = XPCClient(service: serviceIdentifier)
|
|
let message = XPCMessage(route: .volumeCreate)
|
|
message.set(key: .volumeName, value: name)
|
|
message.set(key: .volumeDriver, value: driver)
|
|
|
|
let driverOptsData = try JSONEncoder().encode(driverOpts)
|
|
message.set(key: .volumeDriverOpts, value: driverOptsData)
|
|
|
|
let labelsData = try JSONEncoder().encode(labels)
|
|
message.set(key: .volumeLabels, value: labelsData)
|
|
|
|
let reply = try await client.send(message)
|
|
|
|
guard let responseData = reply.dataNoCopy(key: .volume) else {
|
|
throw VolumeError.storageError("Invalid response from server")
|
|
}
|
|
|
|
return try JSONDecoder().decode(Volume.self, from: responseData)
|
|
}
|
|
|
|
public static func delete(name: String) async throws {
|
|
let client = XPCClient(service: serviceIdentifier)
|
|
let message = XPCMessage(route: .volumeDelete)
|
|
message.set(key: .volumeName, value: name)
|
|
|
|
_ = try await client.send(message)
|
|
}
|
|
|
|
public static func list() async throws -> [Volume] {
|
|
let client = XPCClient(service: serviceIdentifier)
|
|
let message = XPCMessage(route: .volumeList)
|
|
let reply = try await client.send(message)
|
|
|
|
guard let responseData = reply.dataNoCopy(key: .volumes) else {
|
|
return []
|
|
}
|
|
|
|
return try JSONDecoder().decode([Volume].self, from: responseData)
|
|
}
|
|
|
|
public static func inspect(_ name: String) async throws -> Volume {
|
|
let client = XPCClient(service: serviceIdentifier)
|
|
let message = XPCMessage(route: .volumeInspect)
|
|
message.set(key: .volumeName, value: name)
|
|
|
|
let reply = try await client.send(message)
|
|
|
|
guard let responseData = reply.dataNoCopy(key: .volume) else {
|
|
throw VolumeError.volumeNotFound(name)
|
|
}
|
|
|
|
return try JSONDecoder().decode(Volume.self, from: responseData)
|
|
}
|
|
|
|
public static func prune() async throws -> ([String], UInt64) {
|
|
let client = XPCClient(service: serviceIdentifier)
|
|
let message = XPCMessage(route: .volumePrune)
|
|
let reply = try await client.send(message)
|
|
|
|
guard let responseData = reply.dataNoCopy(key: .volumes) else {
|
|
return ([], 0)
|
|
}
|
|
|
|
let volumeNames = try JSONDecoder().decode([String].self, from: responseData)
|
|
let size = reply.uint64(key: .size)
|
|
return (volumeNames, size)
|
|
}
|
|
|
|
}
|