Struct DeploymentSpec 

pub struct DeploymentSpec {
    pub version: String,
    pub deployment: String,
    pub services: HashMap<String, ServiceSpec>,
    pub externals: HashMap<String, ExternalSpec>,
    pub tunnels: HashMap<String, TunnelDefinition>,
    pub api: ApiSpec,
    pub environment: Option<String>,
    pub project: Option<String>,
}

Top-level deployment specification

Fields

version: String

Spec version (must be “v1”)

deployment: String

Deployment name (used for overlays, DNS)

services: HashMap<String, ServiceSpec>

Service definitions

externals: HashMap<String, ExternalSpec>

External service definitions (proxy backends without containers)

External services register static backend addresses with the proxy for host/path-based routing without starting any containers. Useful for proxying to services running outside of ZLayer (e.g., on other machines reachable via VPN).

tunnels: HashMap<String, TunnelDefinition>

Top-level tunnel definitions (not tied to service endpoints)

api: ApiSpec

API server configuration (enabled by default)

environment: Option<String>

Environment name whose secrets $S: references resolve against. Resolved to a concrete scope and stamped onto each service at deploy time.

project: Option<String>

Project name that scopes environment (matches how secrets were imported, e.g. --env dev --project zatabase). None => global environment.

Trait Implementations

impl Clone for DeploymentSpec

fn clone(&self) -> DeploymentSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeploymentSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeploymentSpec

fn deserialize<__D>( __deserializer: __D, ) -> Result<DeploymentSpec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeploymentSpec

fn eq(&self, other: &DeploymentSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DeploymentSpec

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DeploymentSpec

impl Validate for DeploymentSpec

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for DeploymentSpec

type Args = ()

fn validate_with_args( &self, args: <DeploymentSpec as ValidateArgs<'v_a>>::Args, ) -> Result<(), ValidationErrors>