Skip to content
Proud to collaborate with Microsoft for Startups

kubernetes.persistentvolume.delete ​

Delete a cluster PersistentVolume (destructive; reclaims orphaned storage)

Deletes a cluster-scoped PersistentVolume. Swallows 404 so the workflow is idempotent — callers can safely delete one that was already removed.

This is the reclaim step for storage a teardown left behind: a Released volume under a Retain policy that no namespace will ever claim again. kubernetes.persistentvolume.list flags those as orphaned.

Destructive and unrecoverable. Under a Retain policy the PV object is the last cluster-side handle on the backing cloud disk, so deleting it both discards the data and, depending on the provisioner, may leave the disk itself allocated in the cloud account — check the provider console after a reclaim sweep rather than assuming the bill stopped.

A PV still Bound to a live PVC does not disappear on delete: Kubernetes marks it Terminating and its finalizer holds until the claim goes away. Delete the PVC first. This workflow reports what the API server accepted; it does not wait for the object to actually vanish.

Inputs:

  • connection_uuid: Cloud connection UUID (required)
  • name: PersistentVolume name (required)

Outputs:

  • name, existed: bool existed=False means the PersistentVolume was already absent.

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

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes——
namestringYes——
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
organization_uuiduuidNo——
namestringNo——
existedbooleanNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "kubernetes.persistentvolume.delete",
  "initial_data": {
    "connection_uuid": "value",
    "name": "value"
  }
}