@suluk/provision - v0.2.0
    Preparing search index...

    Interface InstanceSpec

    A declared instance the platform WANTS (the desired state — one entry in provision.config).

    interface InstanceSpec {
        ref: string;
        service: string;
        plan?: string;
        name: string;
        params?: Record<string, unknown>;
        bind?: Record<string, string>;
        protected?: boolean;
    }
    Index

    Properties

    ref service plan? name params? bind? protected?

    Properties

    ref: string

    a unique handle within the config, referenced by other instances' params (e.g. "db", "kv-sessions").

    service: string

    the broker id that provisions it (must match a catalog offering's id), e.g. "cloudflare-d1".

    plan?: string

    the plan id; defaults to the offering's first plan.

    name: string

    the provider-facing name, e.g. "toolfactory-db".

    params?: Record<string, unknown>

    provision params (broker-specific). A string value of the form @<ref>.<key> is a BINDING REFERENCE, resolved at apply time from that producer instance's outputs — this is what wires the provisioning DAG.

    bind?: Record<string, string>

    binding outputs → env var names: where this instance's credentials/ids LAND (the binding-chain sink). e.g. { database_id: "CLOUDFLARE_D1_ID" }.

    protected?: boolean

    guard a stateful resource (a database, a bucket) from destruction: prune + teardown SKIP it unless forced. The terraform prevent_destroy analog — the safety rail for the resources whose loss is unrecoverable.

    Settings

    Member Visibility

    On This Page

    Properties