Skip to content
Proud to collaborate with Microsoft for Startups

kubernetes.resourcequota.get ​

Read a ResourceQuota with its live consumption and utilization

Reads a single ResourceQuota and reports what the tenant is actually consuming against it.

If the ResourceQuota exists, returns exists=True with hard (the enforced caps) and used (current consumption) as plain maps, plus a utilization map giving the used/hard ratio per resource for every entry the API server reports numerically.

If it is not found (404), returns exists=False with empty maps — no exception is raised.

hard and used come from status, not spec: status is what the quota controller enforces and observes, spec is only what was asked for. A quota just written may briefly report an empty status.

utilization is the field a fleet dashboard or a "tenant near its cap" alert reads. Quantities are parsed from Kubernetes' suffixed notation (500m, 2Gi, 1e3); an entry that cannot be parsed is omitted rather than guessed at, so a missing key means "not comparable", never "zero".

Inputs:

  • connection_uuid: UUID of the cloud connection (required)
  • namespace: Namespace the ResourceQuota lives in (required)
  • name: ResourceQuota name (required)

Outputs:

  • exists: bool
  • hard: JSON — enforced caps, e.g.
  • used: JSON — current consumption in the same units
  • utilization: JSON — used/hard as a float per comparable resource

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

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes——
namespacestringYes——
namestringYes——
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
organization_uuiduuidNo——
namespacestringNo——
namestringNo——
existsbooleanNo——
hardjsonNo——
usedjsonNo——
utilizationjsonNo——
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.resourcequota.get",
  "initial_data": {
    "connection_uuid": "value",
    "namespace": "value",
    "name": "value"
  }
}