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
| API | workflow.etorm.com/v1alpha1 |
| Resource | workflownamespaces (cluster-scoped inside its cluster) |
| Short names | wfns |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: workflow.etorm.com/v1alpha1
kind: WorkflowNamespace
metadata:
name: example
spec: {}
Spec
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
displayName | string | up to 128 characters | Human-readable name. | ||
shards | integer (one of) | 1 | 1, 2, 4, 8, 16 | How 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. | |
retentionDays | integer | 7 | 1 to 90 | Closed workflows keep their history this many days, then it is deleted. | |
vpcRef | reference to VPC | Also 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. | |||
publicEndpoint | boolean | true | Serve the API on a public hostname with a certificate; false keeps it on the VPC only. | ||
allowInsecureVpc | boolean | false | Allow plain HTTP on the VPC. Off by default: the API is HTTPS only. | ||
monitoringRef | reference to MonitoringWorkspace | Optional MonitoringWorkspace to export workflow step spans, retries, and logs to. | |||
searchAttributes | list of object | up to 20 items | Custom attributes a workflow may carry for search. | ||
searchAttributes[].name | string | yes | length 1 to 64 | Attribute name. | |
searchAttributes[].type | string (one of) | yes | keyword, text, int, double, bool, datetime | Value type. | |
indexedAttributes | list of string | up to 3 items | Names of keyword search attributes that are indexed by value, so a search on one is fast (at most 3). | ||
limits | object | {} | Limits lower than the platform's, for this namespace. | ||
limits.maxOpenWorkflows | integer | 1 to 1600000 | Open workflows allowed in all. | ||
limits.requestsPerSecond | integer | 1 to 10000 | Writes accepted per second. |
Status
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
phase | string | Pending, Ready, Degraded or Terminating. | |||
endpoint | string | The hostname of the API. | |||
address | string | The API's address on the VPC, when there is one. | |||
usage | object | What the namespace used. | |||
usage.cpuSeconds | integer | CPU seconds the shards used. | |||
usage.storageBytes | integer | Bytes stored (histories, snapshots, indexes). | |||
usage.openWorkflows | integer | Workflows open now. | |||
reported | object | Figures the shards report about themselves. | |||
conditions | list of object | Detailed state, one entry per aspect; Ready says whether the namespace takes requests. | |||
conditions[].type | string | Aspect. | |||
conditions[].status | string | True or False. | |||
conditions[].reason | string | Machine-readable reason. | |||
conditions[].message | string | Human-readable detail. |
Columns in listings
| Column | From |
|---|---|
| Shards | .spec.shards |
| Endpoint | .status.endpoint |
| Open | .status.usage.openWorkflows |
| Phase | .status.phase |
| Detail | .status.conditions[0].message |