Version 0
HostManifest
A manifest defines the starting state of a Wick host and network.
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
format | | The configuration manifest format. | Yes | |
version | | The version of the configuration. | ||
host | | Additional host configuration. | ||
network | | The configuration for a Wick network. | ||
default_schematic | | The default schematic to execute if none is provided. |
HostConfig
Host configuration options.
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
allow_latest | | Whether or not to allow the :latest tag on remote artifacts. | ||
insecure_registries | | A list of registries to connect to insecurely (over HTTP vs HTTPS). | ||
id | | The ID for this host, used to identify the host over the mesh. | ||
expose | | The schematics to expose via RPC or the mesh, if any. | ||
mesh | | The mesh configuration. | ||
rpc | | Configuration for the GRPC server. | ||
http | | Configuration for the HTTP 1 server (development only). |
HttpConfig
Configuration for HTTP/S servers.
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
enabled | | Enable/disable the server. | ||
port | | The port to bind to. | ||
address | | The address to bind to. | ||
pem | | Path to pem file for TLS. | ||
key | | Path to key file for TLS. | ||
ca | | Path to CA file. |
MeshConfig
Configuration used to connect to the mesh.
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
enabled | | Enable/disable the mesh connection. | ||
address | | The address of the NATS server. | ||
creds_path | | The path to the NATS credsfile. | ||
token | | The NATS token. |
NetworkManifest
A Wick network definition.
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
name | | The unique identifier for this Network. | ||
schematics | | The links between capabilities and components. | ||
collections | | A list of component collections. |
CollectionDefinition
A collection definition.
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
namespace | | The local namespace for the collection. | ||
kind | | The kind/type of the collection. | ||
reference | | The reference/location of the collection. | ||
data | | Data or configuration used to initialize the collection. |
CollectionKind
Kind of collection.
| Field name | Type | Description | | Native | unknown type | Native collections included at compile-time in a Wick host. | | GrpcUrl | unknown type | The URL for a separately managed GRPC endpoint. | | WaPC | unknown type | A WaPC WebAssembly collection. | | Network | unknown type | A local or remote Network definition. |
SchematicManifest
A definition for an individual Wick schematic.
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
name | | Schematic name. | Yes | |
instances | | A map from component reference to its target. | ||
connections | | A list of connections from component to component. | ||
constraints | | A map of constraints and values that limit where this schematic can run. |
ComponentDefinition
A single component definition.
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
id | | The ID of the component (i.e. the alias, key, or namespace). | Yes | |
data | | Data to associate with the reference. |
ConnectionDefinition
A connection between components. This can be specified in short-form syntax (where applicable).
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
from | | The originating component from upstream. | ||
to | | The destination component (downstream). |
ConnectionTargetDefinition
A connection target e.g. a port on a reference. This can be specified in short-form syntax (where applicable).
| Field name | Type | Description | Required? | Shortform? |
|---|---|---|---|---|
instance | | The instance name of the referenced component. | Yes | |
port | | The component’s port. | Yes | |
data | | Data to associate with a connection. |