mirror of
https://github.com/apple/container.git
synced 2026-10-19 12:31:08 +00:00
J Logan
b3eb70307a
- Closes #457. - A container can now declare additional DNS names for a network attachment with a repeatable `alias` property on `--network`, including subtree aliases that match every name below a domain. - With the default domain `test`, this container answers to `gateway.test` by its name, to `api.test` by the exact alias, and to `web.gateway.test`, `a.b.gateway.test` and every other name below `gateway.test` by the subtree alias. The motivating case is a gateway container in front of a local Kubernetes cluster that answers for `*.gateway.test`, with an ingress controller routing on the `Host` header. - An alias is an exact name, or a name with a leading dot that matches every name below it. A name without a dot gets the default domain, as container names do. A subtree alias must be below a name the same attachment owns, and exact names are unique across all containers, so a container cannot claim another container's namespace. The rules for one attachment are checked when a container is created, again when a stored container starts, and again by the network helper when it registers the aliases. See `docs/architecture/dns.md` for the design, the invariants and the security considerations.
45 lines
1.8 KiB
Swift
45 lines
1.8 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 ContainerNetworkClient
|
|
import ContainerResource
|
|
import ContainerXPC
|
|
import ContainerizationExtras
|
|
|
|
/// A network service
|
|
public protocol NetworkService: Sendable {
|
|
/// Gets the properties of the realized network.
|
|
func status() async throws -> NetworkStatus
|
|
|
|
/// Register a hostname and aliases that resolve to it, and allocate associated addresses.
|
|
///
|
|
/// Each alias is in its normalized string form: an exact name, or a name with a leading dot that
|
|
/// matches every name below it.
|
|
func allocate(
|
|
hostname: String,
|
|
macAddress: MACAddress?,
|
|
aliases: [String],
|
|
session: XPCServerSession
|
|
) async throws -> (attachment: Attachment, additionalData: XPCMessage?)
|
|
|
|
/// Look up a name on the network.
|
|
///
|
|
/// The name can be the hostname of an attachment, an alias of it, or a name below a subtree alias.
|
|
/// Returns the attachment that the name resolves to and how the name matched, or nil if the name
|
|
/// does not resolve on this network.
|
|
func lookup(name: String) async throws -> NetworkMatch?
|
|
}
|