Resources / Diagram

Diagram

Infrastructure drawn as blocks with typed ports, joined by links. A controller builds what it describes.

Overview

APIflow.etorm.com/v1alpha1
Resourcediagrams (cluster-scoped inside its cluster)
Short namesdg
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: flow.etorm.com/v1alpha1
kind: Diagram
metadata:
  name: example
spec: {}

Spec

FieldTypeRequiredDefaultAllowedDescription
statestring (one of)"Running"Running, StoppedRunning (default): the diagram is realized. Stopped: what runs (processes, load balancers, ingress, DHCP and DNS services) is deleted; everything that holds data or an identity (VPCs, accounts, certificates, programs, buckets, databases, message brokers, repositories, boards, columns, cards) stays and keeps being reconciled. Start again by setting Running.
pausedbooleanValidate and report a plan in status.plan, change nothing.
deletePolicystring (one of)Delete, OrphanDelete (default): objects the diagram no longer describes, or that outlive it, are deleted. Orphan: the diagram never deletes; it releases them.
modulesobject (free-form)Reusable sub-diagrams by name (declared typed inputs and outputs plus blocks and links); instantiated by blocks of type `module:<name>`, with `count` or `forEach` for loops.
blockslist of objectup to 500 itemsThe blocks: id, type, name (becomes the object name), canvas position and typed-in values.
blocks[].idstringyeslength 1 to 40
blocks[].typestringyeslength 1 to 40
blocks[].namestringyeslength 1 to 63
blocks[].xnumber
blocks[].ynumber
blocks[].paramsobject (free-form)
linkslist of objectup to 2000 itemsArrows from an output port to an input port.
links[].fromobjectyes
links[].from.blockstringyesup to 40 characters
links[].from.portstringyesup to 40 characters
links[].toobjectyes
links[].to.blockstringyesup to 40 characters
links[].to.portstringyesup to 40 characters

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringStopped, Starting, Running, Stopping or Failed; Invalid when the diagram does not validate (nothing is changed) and Paused with spec.paused.
messagestringWhy the diagram is Failed or Invalid (the first problem), else empty.
blockCountintegerNumber of blocks in the diagram.
observedGenerationintegerThe generation of the spec this status describes.
issueslist of objectProblems that make the diagram invalid: level, message and, when known, the block and port.
issues[].levelstring
issues[].messagestring
blocksobject (free-form)Per block: phase, message, the object it built and the values of its outputs.
planlist of objectWith spec.paused: what would change.
conditionslist of objectDetailed state, one entry per aspect; Ready says whether the object is usable.
conditions[].typestring
conditions[].statusstring
conditions[].reasonstring
conditions[].messagestring

Columns in listings

ColumnFrom
Blocks.status.blockCount
State.spec.state
Phase.status.phase

Related guides

All resources