Expand description
ZLayer V1 Service Specification Types
This module defines all types for parsing and validating ZLayer deployment specs.
Structs§
- Access
Rule - An access rule determining what a network can reach.
- ApiSpec
- API server configuration (embedded in deploy/up flows)
- Bridge
Network - A user-defined bridge or overlay network that containers can attach to.
- Bridge
Network Attachment - A container attached to a
BridgeNetwork. - Command
Spec - Command override specification (Section 5.5)
- Container
Restart Policy - Container-runtime-level restart policy.
- Depends
Spec - Dependency specification
- Deployment
Spec - Top-level deployment specification
- Device
Spec - Device passthrough specification
- Distributed
Config - Configuration for distributed GPU job coordination.
- Endpoint
Spec - Endpoint specification (proxy binding)
- Endpoint
Tunnel Config - Tunnel configuration for an endpoint
- Errors
Spec - Error handling policies
- External
Spec - External service specification (proxy backend without a container)
- GpuSpec
- GPU resource specification
- Health
Spec - Health check specification
- Image
Spec - Container image specification
- Init
Failure Policy - Init failure policy
- Init
Spec - Init actions specification
- Init
Step - Init action step
- Join
Policy - Join policy - controls who can join a service
- Logs
Config - Log output configuration for services and jobs.
- Network
Member - A member of a network.
- Network
Policy Spec - A network policy defines an access control group with membership rules and service access policies.
- Node
Selector - Node selection constraints for service placement
- Overlay
Config - Overlay network configuration
- Overlay
Settings - Overlay network settings
- Panic
Policy - Panic policy
- Port
Mapping - A single host-to-container port publish rule (Docker’s
-p). - Registry
Auth - Inline Docker/OCI registry credentials attached to a single pull request.
- Resources
Spec - Resource limits (upper bounds, not reservations)
- Scale
Targets - Target metrics for adaptive scaling
- Service
Network Spec - Per-service network configuration (overlay + join policy).
- Service
Spec - Per-service specification
- Stream
Endpoint Config - Stream (L4) proxy configuration for TCP/UDP endpoints
- Target
Platform - Platform a service targets.
NoneonServiceSpec.platformmeans “any agent is acceptable” (preserves backward compatibility). - Tunnel
Access Config - On-demand access settings for
zlayer tunnel access - Tunnel
Definition - Top-level tunnel definition (not tied to a service endpoint)
- Wasm
Capabilities - Explicit capability declarations for WASM modules. Controls which host interfaces are linked and available to the component.
- Wasm
Config - Comprehensive configuration for all WASM service types.
- Wasm
Http Config Deprecated - Configuration for WASM HTTP services with instance pooling
- Wasm
Preopen - Pre-opened directory for WASM filesystem access
Enums§
- Access
Action - Access control action.
- Arch
Kind - CPU architecture a service needs. Mirrors the arch half of an OCI platform.
- Bridge
Network Driver - Backing driver for a
BridgeNetwork. - Container
Restart Kind - Which flavor of container restart policy to apply.
- Dependency
Condition - Dependency condition
- Expose
Type - Exposure type
- Failure
Action - Failure action for init steps
- GpuSharing
Mode - GPU sharing mode controlling how GPU resources are multiplexed.
- Health
Check - Health check type
- Init
Failure Action - Init failure action
- Join
Mode - Join mode
- Join
Scope - Join scope
- Member
Kind - Type of network member.
- Node
Mode - How service replicas are allocated to nodes
- OsKind
- Operating system a service needs to run on.
- Panic
Action - Panic action
- Port
Protocol - Transport protocol for a published container port.
- Protocol
- Protocol type
- Pull
Policy - Image pull policy
- Registry
Auth Type - Authentication scheme for a
RegistryAuth. - Resource
Type - Resource type - determines container lifecycle
- Scale
Spec - Scaling configuration
- Scheduling
Policy - Scheduling policy for GPU workloads
- Service
Type - Service type - determines runtime behavior and scaling model
- Storage
Spec - Storage mount specification
- Storage
Tier - Storage performance tier
- Stream
Health Check - Health check types for stream (L4) endpoints
- Timeout
Action - Timeout action
- Tunnel
Protocol - 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.
Type Aliases§
- Init
Params - Init action parameters