mirror of
https://github.com/apple/container.git
synced 2026-07-16 14:37:07 +00:00
Kathryn Baldauf
046884df37
## Type of Change - [x] New feature ## Motivation and Context Related to https://github.com/apple/container/issues/1404. This PR adds the initial work to have volume resources conform to ManagedResource, in alignment with other resources such as networks (see [here](https://github.com/apple/container/pull/1421)). Further work is necessary to move the use of `VolumeResource` down to the APIServer (in the VolumesService) and in the volume client. Volumes do not currently have any plugin or runtime state, so that information is not included in the `VolumeResource`, but could be added later if needed. ## Testing - [x] Tested locally Signed-off-by: Kathryn Baldauf <k_baldauf@apple.com>
91 lines
3.1 KiB
Swift
91 lines
3.1 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 Foundation
|
|
|
|
/// A volume resource, representing a configured volume.
|
|
public struct VolumeResource: ManagedResource {
|
|
/// The volume's configuration — its persistent, intrinsic properties.
|
|
public let config: VolumeConfiguration
|
|
|
|
// MARK: ManagedResource
|
|
|
|
/// The unique identifier for this volume. Identical to ``VolumeConfiguration/name``.
|
|
public var id: String { config.name }
|
|
|
|
/// The user-assigned name for this volume. For volumes, name and ID are the same.
|
|
public var name: String { config.name }
|
|
|
|
/// The time at which this volume was created.
|
|
public var creationDate: Date { config.createdAt }
|
|
|
|
/// Key-value labels for this volume. If the underlying
|
|
/// ``VolumeConfiguration/labels`` dictionary contains values that fail
|
|
/// ``ResourceLabels`` validation, this returns an empty label set.
|
|
public var labels: ResourceLabels {
|
|
(try? ResourceLabels(config.labels)) ?? ResourceLabels()
|
|
}
|
|
|
|
/// Whether this is an anonymous volume (detected via the configuration's labels).
|
|
public var isAnonymous: Bool { config.isAnonymous }
|
|
|
|
// MARK: Initialization
|
|
|
|
/// Creates a volume resource.
|
|
///
|
|
/// - Parameters:
|
|
/// - config: The volume's intrinsic configuration.
|
|
public init(config: VolumeConfiguration) {
|
|
self.config = config
|
|
}
|
|
}
|
|
|
|
extension VolumeResource {
|
|
public static let volumeNamePattern = "^[A-Za-z0-9][A-Za-z0-9_.-]*$"
|
|
|
|
/// Returns `true` if `name` is a syntactically valid volume identifier.
|
|
public static func nameValid(_ name: String) -> Bool {
|
|
guard name.count <= 255 else { return false }
|
|
|
|
do {
|
|
let regex = try Regex(volumeNamePattern)
|
|
return (try? regex.wholeMatch(in: name)) != nil
|
|
} catch {
|
|
return false
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: - Codable
|
|
|
|
extension VolumeResource {
|
|
enum CodingKeys: String, CodingKey {
|
|
case id
|
|
case config
|
|
}
|
|
|
|
public func encode(to encoder: Encoder) throws {
|
|
var container = encoder.container(keyedBy: CodingKeys.self)
|
|
try container.encode(id, forKey: .id)
|
|
try container.encode(config, forKey: .config)
|
|
}
|
|
|
|
public init(from decoder: Decoder) throws {
|
|
let container = try decoder.container(keyedBy: CodingKeys.self)
|
|
self.config = try container.decode(VolumeConfiguration.self, forKey: .config)
|
|
}
|
|
}
|