Skip to main content

Get Pipeline Deployment

Required role: read or higher.

Desired versus current CPU, memory, and storage per host, and the state of each change. The pipeline's deployment_status is the lifecycle Feldera wants; this endpoint is what exists in the runner's platform (for example Kubernetes) now.

state values follow Kubernetes kstatus: Current, InProgress, Failed, Terminating, NotFound, and Unknown. status.state summarizes status.hosts. Runners that do not observe their resources return the spec only.

Path Parameters
pipeline_name string — REQUIRED

Unique pipeline name

Responses
200

Pipeline deployment retrieved successfully

Schema — OPTIONAL
spec object

What the deployment asks for, from the pipeline's deployment_config.

resources object

Each *_min is a Kubernetes request and each *_max a limit.

cpu_cores_max double — OPTIONAL
cpu_cores_min double — OPTIONAL
memory_max string — OPTIONAL
memory_min string — OPTIONAL
storage_max string — OPTIONAL
storage_min string — OPTIONAL
status object — OPTIONAL

Observed status of the deployment. state, reason and message summarize hosts.

hosts object[]
compute object

CPU and memory of one host.

last_transition_time date-time — OPTIONAL

When the platform last changed the condition behind state (Kubernetes lastTransitionTime, or deletionTimestamp for Terminating). If only reason changes, for example from ContainerCreating to CrashLoopBackOff, the time stays.

message string — OPTIONAL
reason string — OPTIONAL

Machine-readable cause, passed through from the runner's platform.

state string

Possible values: [Current, InProgress, Failed, Terminating, NotFound, Unknown]

Status of an object or of the whole deployment, from kstatus.

current object — OPTIONAL
cpu_cores_max double — OPTIONAL
cpu_cores_min double — OPTIONAL
memory_mb_max int64 — OPTIONAL
memory_mb_min int64 — OPTIONAL
desired object — OPTIONAL
cpu_cores_max double — OPTIONAL
cpu_cores_min double — OPTIONAL
memory_mb_max int64 — OPTIONAL
memory_mb_min int64 — OPTIONAL
manager string

Possible values: [User, Autoscaler]

Who sets the desired value.

ordinal integer

Host index, from 0 to hosts - 1. Kubernetes names the pod <statefulset>-<ordinal>.

storage object — OPTIONAL

Storage volume of one host.

last_transition_time date-time — OPTIONAL

When the platform last changed the condition behind state (Kubernetes lastTransitionTime, or deletionTimestamp for Terminating). If only reason changes, for example from ContainerCreating to CrashLoopBackOff, the time stays.

message string — OPTIONAL
reason string — OPTIONAL

Machine-readable cause, passed through from the runner's platform.

state string

Possible values: [Current, InProgress, Failed, Terminating, NotFound, Unknown]

Status of an object or of the whole deployment, from kstatus.

current object — OPTIONAL
storage_mb int64 — OPTIONAL
desired object — OPTIONAL
storage_mb int64 — OPTIONAL
manager string

Possible values: [User, Autoscaler]

Who sets the desired value.

message string — OPTIONAL
reason string — OPTIONAL
state string

Possible values: [Current, InProgress, Failed, Terminating, NotFound, Unknown]

Status of an object or of the whole deployment, from kstatus.

404

Pipeline with that name does not exist

Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

503
Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.