@edgible-team/sdk
    Preparing search index...

    Interface StackDeployParams

    Stack source: pre-parsed documents, or raw YAML + substitution env.

    interface StackDeployParams {
        allowHostnameRemoval?: boolean;
        app?: string;
        composeSources?: readonly ComposeSource[];
        documents?: {}[];
        dryRun?: boolean;
        env?: EnvRecord;
        organizationId: string;
        yaml?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowHostnameRemoval?: boolean

    ADR-0015: acknowledge applies that withdraw a currently-routable hostname (access renamed/deleted, primary reassigned, custom removed). Rides to the declaration-apply body key allowHostnameRemoval. Without it such an update fails 409 HOSTNAME_REMOVAL_BLOCKED; the create path never trips it.

    app?: string

    Limit to a single application by metadata.name.

    composeSources?: readonly ComposeSource[]

    Where each compose workload's embedded bytes were read from — the composeSources a loadStackFile call returned. With it, a compose-gate failure (STACK_COMPOSE_INVALID / STACK_COMPOSE_PARSE_FAILED) names the offending file in details.composeFile; without it the gate can only say <embedded compose document>, because embedding erased the path.

    documents?: {}[]

    Already-parsed canonical documents (e.g. from loadStackFile).

    dryRun?: boolean

    Plan only — resolves the deploy order without any API call.

    env?: EnvRecord

    Env record for ${VAR} substitution when yaml is given (default {}).

    organizationId: string
    yaml?: string

    Raw multi-document stack YAML, parsed with parseStackDocuments.