Version 0

Vino preview release version

HostManifest

A manifest defines the starting state of a Vino host and network.

version

The manifest version.
  • Type: u8
  • Required

host

Additional host configuration.

network

The configuration for a Vino network.

default_schematic

The default schematic to execute if none is provided.
  • Type: string

HostConfig

Host configuration options.

allow_latest

Whether or not to allow the :latest tag on remote artifacts.
  • Type: bool

insecure_registries

A list of registries to connect to insecurely (over HTTP vs HTTPS).
  • Type: string[]

timeout

The timeout for network requests (in ms).
  • Type: u64

id

The ID for this host, used to identify the host over the lattice.
  • Type: string(Optional)

expose

The schematics to expose via RPC or the lattice, if any.
  • Type: string[]

lattice

The lattice configuration.

rpc

Configuration for the GRPC server.

http

Configuration for the HTTP 1 server (development only).

HttpConfig

Configuration for HTTP/S servers.

enabled

Enable/disable the server.
  • Type: bool

port

The port to bind to.
  • Type: u16(Optional)

address

The address to bind to.
  • Type: string(Optional)

pem

Path to pem file for TLS.
  • Type: string(Optional)

key

Path to key file for TLS.
  • Type: string(Optional)

ca

Path to CA file.
  • Type: string(Optional)

LatticeConfig

Configuration used to connect to the lattice.

enabled

Enable/disable the lattice connection.
  • Type: bool

address

The address of the NATS server.
  • Type: string

creds_path

The path to the NATS credsfile.
  • Type: string(Optional)

token

The NATS token.
  • Type: string(Optional)

NetworkManifest

A Vino network definition.

name

The unique identifier for this Network.
  • Type: string(Optional)

labels

The labels that apply to this network.
  • Type: Map

schematics

The links between capabilities and components.

providers

A list of providers and component collections.

SchematicManifest

A definition for an individual Vino schematic.

name

Schematic name.
  • Type: string
  • Required

providers

A list of providers and component collections.
  • Type: string[]

instances

A map from component reference to its target.
  • Type: MapComponentDefinition>

connections

A list of connections from component to component.

constraints

A map of constraints and values that limit where this schematic can run.
  • Type: Map

ProviderDefinition

A provider definition.

namespace

The namespace to reference the provider's components on.
  • Type: string

kind

The kind/type of the provider.

reference

The reference/location of the provider.
  • Type: string

data

Data or configuration to pass to the provider initialization.
  • Type: Map

ProviderKind

Kind of provider.

Native

Native providers included at compile-time in a Vino host.
  • Index: 0

GrpcUrl

The URL for a separately managed GRPC endpoint.
  • Index: 1

WaPC

A WaPC WebAssembly provider.
  • Index: 2

Lattice

A provider accessible via a connected lattice.
  • Index: 3

Network

A local or remote Network definition.
  • Index: 4

ComponentDefinition

A single component definition.

id

The ID of the component (i.e. the alias, key, or namespace).
  • Type: string
  • Required

config

Data to associate with the reference.
  • Type: Map(Optional)

ConnectionDefinition

A connection between components. This can be specified in short-form syntax (where applicable). See docs.vino.dev for more information.

from

The originating component from upstream.

to

The destination component (downstream).

default

The default value to provide in the event of an upstream Error or Exception.
  • Type: string(Optional)

ConnectionTargetDefinition

A connection target e.g. a port on a reference. This can be specified in short-form syntax (where applicable). See docs.vino.dev for more information.

instance

The instance name of the referenced component.
  • Type: string
  • Required

port

The component's port.
  • Type: string
  • Required

data

Data to send automatically. Parsed as JSON. (only used for instances).
  • Type: string(Optional)