Skip to main content

Module envoy

Module envoy 

Source
Expand description

Envoy framework types — Tier, AdapterFlavor, VerbCategory, InternalVerb, VerbDescriptor.

W144 D1–D4 scaffold (R409-T2). Concrete verb structs (e.g. cloud.vps.create) land in R409-T3 onward; this module establishes only the type framework so adapters and the host can refer to it before any verb is defined.

§D1 — schemars-derived schemas

Verb input/output shapes are Rust types decorated with serde + (optionally) schemars::JsonSchema. The trait itself is schema-agnostic so the cloud crate doesn’t pull schemars unconditionally — schema emission lives in [VerbDescriptor::for_verb] under the json-schema feature, which is what xtask + the verb-registration entrypoint enable.

§D3 — AdapterFlavor::Synthetic

Orthogonal to Tier: LocalDockerProvider is tier-S with adapter flavor AdapterFlavor::Synthetic. Tier drives policy (drift, naming, contract-test scope); flavor drives implementation strategy.

Modules§

ci
ci.* verb signatures — external CI pipeline catalog (R409-T12).
cloud_object
cloud.object.* verb signatures — object-storage bucket lifecycle (R409-T6).
cloud_vps
cloud.vps.* verb signatures — the spike catalog (R409-T3).
dns_record
dns.* verb signatures — initial catalog (R409-T6).
floating_ip
floating_ip.* verb signatures (R594-F5).
messaging
messaging.* verb signatures — outbound channel catalog (R409-T12).
observability
observability.* verb signatures — monitoring and alerting catalog (R409-T12).
payments
payments.* verb signatures — billing surface catalog (R409-T12).

Structs§

VerbDescriptor
Type-erased verb descriptor — what an adapter registers with the host.

Enums§

AdapterFlavor
How an adapter is built. Orthogonal to Tier.
Tier
Provider tier — policy bucket (drift handling, naming rules, contract-test coverage). Cardinality is roughly fixed; new tiers are a deliberate design move, not an extension point.
VerbCategory
Verb category — the namespace prefix in <category>.<verb> (e.g. cloud.vps.create). Marked non-exhaustive: the catalog grows through diligence/refine (see W144 §“What the internal contract covers”).

Traits§

EnvoyAdapter
Provider adapter — what the host registers to expose a vendor’s verbs.
InternalVerb
One internal verb. Implementors are zero-sized marker types (e.g. pub struct CloudVpsCreate;); the associated Input / Output types carry the wire shape.

Functions§

default_adapters
Construct the tier-S adapters this process can source live credentials for from ambient env/vault state alone — no camp-scoped config needed.