Crate wasmcloud_control_interface

Control Interface Client

This library provides a client API for consuming the wasmCloud control interface over a NATS connection. This library can be used by multiple types of tools, and is also used by the control interface capability provider and the wash CLI

Usage

All of the Client functions are handled by a wasmCloud host running in the specified lattice. Each function returns a Result<CtlResponse<T>> wrapper around the actual response type. The outer result should be handled for protocol (timeouts, no hosts available) and deserialization errors (invalid response payload). The inner result is the actual response from the host(s) and should be handled for application-level errors.

Re-exports

• pub use client::collect_sub_timeout;
• pub use client::Client;
• pub use client::ClientBuilder;

Modules

• client
  Control interface client

Structs

• ComponentAuctionAck
  A host response to a request to start an component, confirming the host has enough capacity to start the component
• ComponentAuctionRequest
  A request to locate suitable hosts for a given component
• ComponentDescription
  A summary description of an component within a host inventory
• ComponentInstance
• CtlResponse
  A control interface response that wraps a response payload, a success flag, and a message with additional context if necessary.
• DeleteInterfaceLinkDefinitionRequest
  A request to remove a link definition and detach the relevant component from the given provider
• Host
  A summary representation of a host
• HostInventory
  Describes the known contents of a given host at the time of a query. Also used as a payload for the host heartbeat
• HostLabel
  A label on a given host (ex. “arch=amd64”)
• InterfaceLinkDefinition
  A link definition between a source and target component (actor or provider) on a given interface. An InterfaceLinkDefinition connects one component’s import to another component’s export, specifying the configuration each component needs in order to execute the request, and represents an operator’s intent to allow the source to invoke the target.
• ProviderAuctionAck
  A host response to a request to start a provider, confirming the host has enough capacity to start the provider and that the provider is not already running on the host
• ProviderAuctionRequest
  A request to locate a suitable host for a capability provider. The provider’s unique identity is used to rule out hosts on which the provider is already running.
• ProviderDescription
  A summary description of a capability provider within a host inventory
• RegistryCredential
  Credentials for a registry that contains artifacts from which WebAssembly components can be extracted (usually a docker image registry)
• ScaleComponentCommand
• StartProviderCommand
  A command sent to a host requesting a capability provider be started with the given link name and optional configuration.
• StopHostCommand
  A command sent to request that the given host purge and stop
• StopProviderCommand
  A request to stop the given provider on the indicated host
• UpdateComponentCommand
  A command instructing a specific host to perform a live update on the indicated component by supplying a new image reference. Note that live updates are only possible through image references

Type Aliases

• ComponentId
  Identifier of a component which sends invocations on the lattice
• KnownConfigName
  The name of a known (possibly pre-created) configuration, normally used when creating new interface links in order to configure one or both source/target
• LatticeTarget
  Identifier of one or more entities on the lattice used for addressing. May take many forms, such as:
• LinkName
  Name of a link on the wasmCloud lattice
• WitInterface
  WIT interface for a given operation (ex. readwrite in wasi:keyvalue/readwrite.get)
• WitNamespace
  WIT namespace for a given operation (ex. wasi in wasi:keyvalue/readwrite.get)
• WitPackage
  WIT package for a given operation (ex. keyvalue in wasi:keyvalue/readwrite.get)