kubernetes.pvc.ensure

Create or replace a namespaced Kubernetes PersistentVolumeClaim

Creates a PersistentVolumeClaim in the given namespace; patches it if it already exists. Accepts a pre-built pvc_spec dict matching the Kubernetes V1PersistentVolumeClaimSpec schema so callers build the spec however they want.

Note: PVC spec is mostly immutable after creation. Only resources.requests.storage can be grown if the storage class supports volume expansion. A patch that attempts to change an immutable field will be rejected by the API server and the workflow will transition to FAILED — this is intentional; the caller must delete and re-create the PVC in that case.

Inputs:

• connection_uuid: Cloud connection UUID (required)
• namespace: Target namespace (required)
• name: PVC name (required)
• pvc_spec: V1PersistentVolumeClaimSpec dict (required). Must include at minimum accessModes and resources.requests.storage. Optional keys: storageClassName, volumeName, etc.

Outputs:

• existed: True if the PVC was patched, False if it was created.

Plugin required: context.get_plugin("connection").kubernetes_runner_clients(connection_uuid, organization_uuid) must expose core_v1 with read_namespaced_persistent_volume_claim, patch_namespaced_persistent_volume_claim, create_namespaced_persistent_volume_claim.

Overview

Property	Value
Workflow type	Atomic
Library	App-kubernetes
Version	1.0

Input Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	Yes	—	—
namespace	string	Yes	—	—
name	string	Yes	—	—
pvc_spec	json	Yes	—	—
workflow_run_id	string	No	—	Engine workflow run id for DAG step execution
organization_uuid	uuid	No	—	—

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	—
organization_uuid	uuid	No	—	—
namespace	string	No	—	—
name	string	No	—	—
pvc_spec	json	No	—	—
existed	boolean	No	—	—
workflow_run_id	string	No	—	Engine workflow run id for DAG step execution
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_at_state	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "kubernetes.pvc.ensure",
  "initial_data": {
    "connection_uuid": "value",
    "namespace": "value",
    "name": "value",
    "pvc_spec": "value"
  }
}