Resources / WorkflowNamespace

WorkflowNamespace

The isolation and billing unit of Workflows: durable workflows written in Rust and compiled to WebAssembly, their activities, task queues, timers and schedules, with every byte kept in Etorm storage. Workflows are offered by invitation; until the engine is enabled for the project, a namespace stays Pending with reason EngineNotAvailable and nothing is billed.

Overview

APIworkflow.etorm.com/v1alpha1
Resourceworkflownamespaces (cluster-scoped inside its cluster)
Short nameswfns
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: workflow.etorm.com/v1alpha1
kind: WorkflowNamespace
metadata:
  name: example
spec: {}

Spec

FieldTypeRequiredDefaultAllowedDescription
displayNamestringup to 128 charactersHuman-readable name.
shardsinteger (one of)11, 2, 4, 8, 16How many shards share the workflows of this namespace (workflow ids are placed by their hash). Each shard serves up to 100 000 open workflows. Cannot be changed.
retentionDaysinteger71 to 90Closed workflows keep their history this many days, then it is deleted.
vpcRefreference to VPCAlso serve the namespace's API on this VPC of the project (workers on the VPC reach it without leaving it). The namespace itself is the permission to attach.
publicEndpointbooleantrueServe the API on a public hostname with a certificate; false keeps it on the VPC only.
allowInsecureVpcbooleanfalseAllow plain HTTP on the VPC. Off by default: the API is HTTPS only.
monitoringRefreference to MonitoringWorkspaceOptional MonitoringWorkspace to export workflow step spans, retries, and logs to.
searchAttributeslist of objectup to 20 itemsCustom attributes a workflow may carry for search.
searchAttributes[].namestringyeslength 1 to 64Attribute name.
searchAttributes[].typestring (one of)yeskeyword, text, int, double, bool, datetimeValue type.
indexedAttributeslist of stringup to 3 itemsNames of keyword search attributes that are indexed by value, so a search on one is fast (at most 3).
limitsobject{}Limits lower than the platform's, for this namespace.
limits.maxOpenWorkflowsinteger1 to 1600000Open workflows allowed in all.
limits.requestsPerSecondinteger1 to 10000Writes accepted per second.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Ready, Degraded or Terminating.
endpointstringThe hostname of the API.
addressstringThe API's address on the VPC, when there is one.
usageobjectWhat the namespace used.
usage.cpuSecondsintegerCPU seconds the shards used.
usage.storageBytesintegerBytes stored (histories, snapshots, indexes).
usage.openWorkflowsintegerWorkflows open now.
reportedobjectFigures the shards report about themselves.
conditionslist of objectDetailed state, one entry per aspect; Ready says whether the namespace takes requests.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Shards.spec.shards
Endpoint.status.endpoint
Open.status.usage.openWorkflows
Phase.status.phase
Detail.status.conditions[0].message

All resources