Kubecost · Schema

Budget

Cloud CostCost MonitoringKubernetesOptimizationSpending

Properties

Name Type Description
id string Unique identifier for the budget.
name string Name of the budget rule.
amount number Budget amount limit.
interval string Recurrence interval of the budget.
aggregation string The field used to scope the budget, such as namespace, cluster, or label.
filter string Filter expression to scope the budget to specific workloads.
actions array Alert actions when budget thresholds are reached.
currentSpend number Current spend within the budget period.
createdAt string
updatedAt string
View JSON Schema on GitHub

JSON Schema

kubecost-budget-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Budget",
  "title": "Budget",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the budget."
    },
    "name": {
      "type": "string",
      "description": "Name of the budget rule."
    },
    "amount": {
      "type": "number",
      "description": "Budget amount limit."
    },
    "interval": {
      "type": "string",
      "enum": [
        "weekly",
        "monthly"
      ],
      "description": "Recurrence interval of the budget."
    },
    "aggregation": {
      "type": "string",
      "description": "The field used to scope the budget, such as namespace, cluster, or label."
    },
    "filter": {
      "type": "string",
      "description": "Filter expression to scope the budget to specific workloads."
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BudgetAction"
      },
      "description": "Alert actions when budget thresholds are reached."
    },
    "currentSpend": {
      "type": "number",
      "description": "Current spend within the budget period."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}