API Reference

Packages

• runtime.wasmcloud.dev/v1alpha1

runtime.wasmcloud.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the runtime v1alpha1 API group.

Resource Types

• Artifact
• ArtifactList
• Host
• HostList
• Workload
• WorkloadDeployment
• WorkloadDeploymentList
• WorkloadList
• WorkloadReplicaSet
• WorkloadReplicaSetList

Artifact

Artifact is the Schema for the artifacts API.

Appears in:

• ArtifactList

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	Artifact
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ArtifactSpec

ArtifactList

ArtifactList contains a list of Artifact.

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	ArtifactList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Artifact array

ArtifactSpec

ArtifactSpec defines the desired state of Artifact.

Appears in:

• Artifact

Field	Description	Default	Validation
image string			Required: {}
imagePullSecret LocalObjectReference			Optional: {}

ConfigLayer

Appears in:

• HostInterface
• LocalResources

Field	Description	Default	Validation
configFrom LocalObjectReference array	ConfigFrom is a list of references to ConfigMaps that will be provided to the workload. The keys and values of all referenced ConfigMaps will be merged. In case of key conflicts, the last ConfigMap in the list wins.		Optional: {}
secretFrom LocalObjectReference array	The keys and values of all referenced Secrets will be merged. In case of key conflicts, the last Secret in the list wins. The values of the Secrets will be base64-decoded, utf-8 decoded before being provided to the workload.		Optional: {}
config object (keys:string, values:string)			Optional: {}

EphemeralVolume

EphemeralVolume represents a temporary directory that shares a workload's lifetime.

Appears in:

• Volume

Host

Host is the Schema for the Hosts API.

Appears in:

• HostList

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	Host
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
hostId string			Required: {}
hostname string			Optional: {}
httpPort integer			Optional: {}

HostInterface

Appears in:

• WorkloadSpec

Field	Description	Default	Validation
configFrom LocalObjectReference array	ConfigFrom is a list of references to ConfigMaps that will be provided to the workload. The keys and values of all referenced ConfigMaps will be merged. In case of key conflicts, the last ConfigMap in the list wins.		Optional: {}
secretFrom LocalObjectReference array	The keys and values of all referenced Secrets will be merged. In case of key conflicts, the last Secret in the list wins. The values of the Secrets will be base64-decoded, utf-8 decoded before being provided to the workload.		Optional: {}
config object (keys:string, values:string)			Optional: {}
namespace string			Required: {}
package string			Required: {}
interfaces string array			MinItems: 1 Required: {}
version string			Optional: {}

HostList

HostList contains a list of Host.

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	HostList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Host array

HostPathVolume

HostPathVolume represents a pre-existing file or directory on the host machine.

Appears in:

• Volume

Field	Description	Default	Validation
path string	Path of the file or directory on the host.		Required: {}

LocalResources

LocalResources describes resources that will be made available to a workload component.

Appears in:

• WorkloadComponent
• WorkloadService

Field	Description	Default	Validation
volumeMounts VolumeMount array	VolumeMounts is a list of volume mounts that will be mounted into the workload component. The volumes must be defined in the WorkloadSpec.Volumes field.		Optional: {}
environment ConfigLayer			Optional: {}
config object (keys:string, values:string)			Optional: {}
allowedHosts string array			Optional: {}

ReplicaSetStatus

Appears in:

• WorkloadDeploymentStatus
• WorkloadReplicaSetStatus

Field	Description	Default	Validation
expected integer			Optional: {}
current integer			Optional: {}
ready integer			Optional: {}
unavailable integer			Optional: {}

Volume

Volume represents a named volume that can be mounted by components.

Appears in:

• WorkloadSpec

Field	Description	Default	Validation
name string	Name of the volume. Must be a DNS_LABEL and unique within the Workload.		Required: {}
ephemeral EphemeralVolume	EphemeralVolume represents a temporary directory that shares a workload's lifetime.		Optional: {}
hostPath HostPathVolume	HostPathVolume represents a pre-existing file or directory on the host machine.		Optional: {}

VolumeMount

VolumeMount describes a mounting of a Volume within a component.

Appears in:

• LocalResources

Field	Description	Default	Validation
name string	Name must match the Name of a Volume defined in the WorkloadSpec.Volumes field.		Required: {}
mountPath string	MountPath is the path within the component where the volume should be mounted.		Required: {}

Workload

Workload is the Schema for the artifacts API.

Appears in:

• WorkloadList

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	Workload
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec WorkloadSpec

WorkloadComponent

WorkloadComponent represents a component of a workload. Components are stateless, invocation-driven units of computation. Components are isolated from each other and can be scaled independently. Each Component has a Root WIT World, representing the Components imports/exports. The combined list of all Components' Root WIT Worlds within a workload must be compatible with the Host's WIT World. All components within a workload are guaranteed to be placed on the same Wasm Host.

Appears in:

• WorkloadSpec

Field	Description	Default	Validation
name string			Required: {}
image string			Required: {}
imagePullSecret LocalObjectReference			Optional: {}
poolSize integer			Optional: {}
maxInvocations integer			Optional: {}
localResources LocalResources			Optional: {}

WorkloadDeployPolicy

Underlying type: string

Appears in:

• WorkloadDeploymentSpec

Field	Description
RollingUpdate
Recreate

WorkloadDeployment

WorkloadDeployment is the Schema for the artifacts API.

Appears in:

• WorkloadDeploymentList

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	WorkloadDeployment
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec WorkloadDeploymentSpec

WorkloadDeploymentArtifact

Appears in:

• WorkloadDeploymentSpec

Field	Description	Default	Validation
name string			Required: {}
artifactFrom LocalObjectReference			Required: {}

WorkloadDeploymentList

WorkloadDeploymentList contains a list of HttpTrigger.

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	WorkloadDeploymentList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items WorkloadDeployment array

WorkloadDeploymentSpec

WorkloadDeploymentSpec defines the desired state of WorkloadDeployment.

Appears in:

• WorkloadDeployment

Field	Description	Default	Validation
replicas integer			Optional: {}
template WorkloadReplicaTemplate			Required: {}
deployPolicy WorkloadDeployPolicy		RollingUpdate	Optional: {}
artifacts WorkloadDeploymentArtifact array			Optional: {}

WorkloadList

WorkloadList contains a list of Workload.

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	WorkloadList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Workload array

WorkloadReplicaSet

WorkloadReplicaSet is the Schema for the artifacts API.

Appears in:

• WorkloadReplicaSetList

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	WorkloadReplicaSet
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec WorkloadReplicaSetSpec

WorkloadReplicaSetList

WorkloadReplicaSetList contains a list of WorkloadReplicaSet.

Field	Description	Default	Validation
apiVersion string	runtime.wasmcloud.dev/v1alpha1
kind string	WorkloadReplicaSetList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items WorkloadReplicaSet array

WorkloadReplicaSetSpec

WorkloadReplicaSetSpec defines the desired state of WorkloadReplicaSet.

Appears in:

• WorkloadDeploymentSpec
• WorkloadReplicaSet

Field	Description	Default	Validation
replicas integer			Optional: {}
template WorkloadReplicaTemplate			Required: {}

WorkloadReplicaTemplate

Appears in:

• WorkloadDeploymentSpec
• WorkloadReplicaSetSpec

Field	Description	Default	Validation
annotations object (keys:string, values:string)			Optional: {}
labels object (keys:string, values:string)			Optional: {}
spec WorkloadSpec			Required: {}

WorkloadService

WorkloadService represents a long-running service that is part of the workload. It is also sometimes referred to as a "sidecar" and is optional. A Service differs from a Component in that it is long-running and represents the Workload's "localhost". Services can bind to TCP & UDP ports, which are accessible by Components within the same workload via "localhost" or "127.0.0.1". Services export a single WIT interface, shaped as wasi:cli/run. Services can import interfaces from any Component within the same workload, or from the Host.

Appears in:

• WorkloadSpec

Field	Description	Default	Validation
image string			Required: {}
imagePullSecret LocalObjectReference			Optional: {}
maxRestarts integer			Optional: {}
localResources LocalResources			Optional: {}

WorkloadSpec

WorkloadSpec defines the desired state of Workload.

Appears in:

• Workload
• WorkloadReplicaTemplate

Field	Description	Default	Validation
hostSelector object (keys:string, values:string)			Optional: {}
hostId string			Optional: {}
components WorkloadComponent array			Optional: {}
hostInterfaces HostInterface array			Optional: {}
service WorkloadService			Optional: {}
volumes Volume array			Optional: {}