Module types 

ZLayer V1 Service Specification Types

This module defines all types for parsing and validating ZLayer deployment specs.

Structs

AccessRule

An access rule determining what a network can reach.

ApiSpec

API server configuration (embedded in deploy/up flows)

BridgeNetwork

A user-defined bridge or overlay network that containers can attach to.

BridgeNetworkAttachment

A container attached to a BridgeNetwork.

CommandSpec

Command override specification (Section 5.5)

ContainerRestartPolicy

Container-runtime-level restart policy.

DependsSpec

Dependency specification

DeploymentSpec

Top-level deployment specification

DeviceSpec

Device passthrough specification

DistributedConfig

Configuration for distributed GPU job coordination.

EndpointSpec

Endpoint specification (proxy binding)

EndpointTunnelConfig

Tunnel configuration for an endpoint

ErrorsSpec

Error handling policies

ExternalSpec

External service specification (proxy backend without a container)

GpuSpec

GPU resource specification

HealthSpec

Health check specification

ImageSpec

Container image specification

InitFailurePolicy

Init failure policy

InitSpec

Init actions specification

InitStep

Init action step

JoinPolicy

Join policy - controls who can join a service

LifecycleSpec

Lifecycle policy for service / job / cron containers.

LogsConfig

Log output configuration for services and jobs.

NetworkMember

A member of a network.

NetworkPolicySpec

A network policy defines an access control group with membership rules and service access policies.

NodeSelector

Node selection constraints for service placement

OverlayConfig

Overlay network configuration

OverlaySettings

Overlay network settings

PanicPolicy

Panic policy

PortMapping

A single host-to-container port publish rule (Docker’s -p).

RegistryAuth

Inline Docker/OCI registry credentials attached to a single pull request.

ResourcesSpec

Resource limits (upper bounds, not reservations)

ScaleTargets

Target metrics for adaptive scaling

ServiceNetworkSpec

Per-service network configuration (overlay + join policy).

ServiceSpec

Per-service specification

StreamEndpointConfig

Stream (L4) proxy configuration for TCP/UDP endpoints

TargetPlatform

Platform a service targets. None on ServiceSpec.platform means “any agent is acceptable” (preserves backward compatibility).

TunnelAccessConfig

On-demand access settings for zlayer tunnel access

TunnelDefinition

Top-level tunnel definition (not tied to a service endpoint)

UlimitSpec

Per-process resource limit (Docker --ulimit style).

WasmCapabilities

Explicit capability declarations for WASM modules. Controls which host interfaces are linked and available to the component.

WasmConfig

Comprehensive configuration for all WASM service types.

WasmHttpConfigDeprecated

Configuration for WASM HTTP services with instance pooling

WasmPreopen

Pre-opened directory for WASM filesystem access

Enums

AccessAction

Access control action.

ArchKind

CPU architecture a service needs. Mirrors the arch half of an OCI platform.

BridgeNetworkDriver

Backing driver for a BridgeNetwork.

ContainerRestartKind

Which flavor of container restart policy to apply.

DependencyCondition

Dependency condition

ExposeType

Exposure type

FailureAction

Failure action for init steps

GpuSharingMode

GPU sharing mode controlling how GPU resources are multiplexed.

HealthCheck

Health check type

InitFailureAction

Init failure action

JoinMode

Join mode

JoinScope

Join scope

MemberKind

Type of network member.

NetworkMode

Network mode for a service container.

NodeMode

How service replicas are allocated to nodes

OsKind

Operating system a service needs to run on.

PanicAction

Panic action

PortProtocol

Transport protocol for a published container port.

Protocol

Protocol type

PullPolicy

Image pull policy

RegistryAuthType

Authentication scheme for a RegistryAuth.

ResourceType

Resource type - determines container lifecycle

ScaleSpec

Scaling configuration

SchedulingPolicy

Scheduling policy for GPU workloads

ServiceType

Service type - determines runtime behavior and scaling model

StorageSpec

Storage mount specification

StorageTier

Storage performance tier

StreamHealthCheck

Health check types for stream (L4) endpoints

TimeoutAction

Timeout action

TunnelProtocol

Protocol for tunnel connections (tcp or udp only)

Functions

default_registry_auth_type

Serde default for RegistryAuth::auth_type. Kept as a free function so #[serde(default = "...")] can reference it.

effective_pull_policy

Resolve the effective pull policy for a deploy/scale operation.

Type Aliases

InitParams

Init action parameters