Criar Runbook

{
  "name": "disk-cleanup",
  "namespace": "production",
  "description": "Free disk space when a StatefulSet reports disk pressure",
  "trigger": {
    "signalType": "disk_pressure",
    "severity": "medium",
    "resourceKind": "StatefulSet"
  },
  "steps": [
    {
      "name": "diagnose",
      "action": "ExecDiagnostic",
      "description": "Check filesystem usage",
      "params": {
        "command": "df -h"
      }
    },
    {
      "name": "restart-pod",
      "action": "RestartStatefulSetPod",
      "description": "Restart the affected pod"
    }
  ],
  "labels": {
    "team": "storage"
  }
}

curl -X POST -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -d @runbook.json http://localhost:8090/api/v1/runbooks

{
  "apiVersion": "v1",
  "kind": "Runbook",
  "spec": {
    "name": "disk-cleanup",
    "namespace": "production",
    "description": "Free disk space when a StatefulSet reports disk pressure",
    "trigger": {
      "signalType": "disk_pressure",
      "severity": "medium",
      "resourceKind": "StatefulSet"
    },
    "steps": [
      {
        "name": "diagnose",
        "action": "ExecDiagnostic",
        "description": "Check filesystem usage",
        "params": {
          "command": "df -h"
        }
      },
      {
        "name": "restart-pod",
        "action": "RestartStatefulSetPod",
        "description": "Restart the affected pod"
      }
    ],
    "maxAttempts": 3,
    "creationTimestamp": "2026-03-19T16:00:00Z"
  },
  "resourceMeta": {
    "name": "disk-cleanup",
    "namespace": "production",
    "uid": "7d8e9f0a-1b2c-4d3e-9f4a-5b6c7d8e9f0a",
    "creationTimestamp": "2026-03-19T16:00:00Z",
    "labels": {
      "team": "storage"
    }
  }
}

POST

runbooks

{
  "name": "disk-cleanup",
  "namespace": "production",
  "description": "Free disk space when a StatefulSet reports disk pressure",
  "trigger": {
    "signalType": "disk_pressure",
    "severity": "medium",
    "resourceKind": "StatefulSet"
  },
  "steps": [
    {
      "name": "diagnose",
      "action": "ExecDiagnostic",
      "description": "Check filesystem usage",
      "params": {
        "command": "df -h"
      }
    },
    {
      "name": "restart-pod",
      "action": "RestartStatefulSetPod",
      "description": "Restart the affected pod"
    }
  ],
  "labels": {
    "team": "storage"
  }
}

curl -X POST -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -d @runbook.json http://localhost:8090/api/v1/runbooks

{
  "apiVersion": "v1",
  "kind": "Runbook",
  "spec": {
    "name": "disk-cleanup",
    "namespace": "production",
    "description": "Free disk space when a StatefulSet reports disk pressure",
    "trigger": {
      "signalType": "disk_pressure",
      "severity": "medium",
      "resourceKind": "StatefulSet"
    },
    "steps": [
      {
        "name": "diagnose",
        "action": "ExecDiagnostic",
        "description": "Check filesystem usage",
        "params": {
          "command": "df -h"
        }
      },
      {
        "name": "restart-pod",
        "action": "RestartStatefulSetPod",
        "description": "Restart the affected pod"
      }
    ],
    "maxAttempts": 3,
    "creationTimestamp": "2026-03-19T16:00:00Z"
  },
  "resourceMeta": {
    "name": "disk-cleanup",
    "namespace": "production",
    "uid": "7d8e9f0a-1b2c-4d3e-9f4a-5b6c7d8e9f0a",
    "creationTimestamp": "2026-03-19T16:00:00Z",
    "labels": {
      "team": "storage"
    }
  }
}

string

obrigatório

Nome do runbook (um nome de recurso do Kubernetes, ex.: disk-cleanup)

string

padrão:"default"

Namespace onde o runbook será criado

string

Objetivo do runbook

object

obrigatório

Quando o runbook se aplica. Os três campos são obrigatórios no CRD.

Mostrar Propriedades do trigger

string

obrigatório

Sinal da anomalia, ex.: oom_kill, crashloop_backoff, error_rate, latency, pod_restart, cpu_high, memory_high, disk_pressure, image_pull_error (lista completa no enum do CRD Anomaly)

string

obrigatório

critical, high, medium ou low

string

obrigatório

Kind do recurso afetado, ex.: Deployment, StatefulSet, DaemonSet, Job, CronJob

object[]

obrigatório

Passos em ordem

Mostrar Propriedades do passo

string

obrigatório

Nome do passo

string

obrigatório

Tipo de ação de remediação, ex.: AdjustResources, RestartDeployment, ScaleDeployment, RollbackDeployment, ExecDiagnostic

string

Por que o passo é necessário e o que ele faz

object

Parâmetros chave/valor (strings) da ação (ex.: {"memory_limit": "1Gi"}, {"replicas": "5"})

integer

padrão:"3"

Número máximo de tentativas de remediação; 0 ou omitido significa 3

object

Labels do Kubernetes para o Runbook

A resposta é 201 Created, com o runbook em spec e os metadados em resourceMeta. name ausente ou JSON malformado retornam 400; uma falha da API do Kubernetes retorna a mensagem do API server com o status correspondente: 409 só quando já existe um runbook com esse nome, 422 quando o API server rejeita o objeto (valor fora dos enums do CRD, campo obrigatório ausente), 403 quando o operator não tem permissão para criá-lo e 500 nos demais casos.

{
  "name": "disk-cleanup",
  "namespace": "production",
  "description": "Free disk space when a StatefulSet reports disk pressure",
  "trigger": {
    "signalType": "disk_pressure",
    "severity": "medium",
    "resourceKind": "StatefulSet"
  },
  "steps": [
    {
      "name": "diagnose",
      "action": "ExecDiagnostic",
      "description": "Check filesystem usage",
      "params": {
        "command": "df -h"
      }
    },
    {
      "name": "restart-pod",
      "action": "RestartStatefulSetPod",
      "description": "Restart the affected pod"
    }
  ],
  "labels": {
    "team": "storage"
  }
}

curl -X POST -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -d @runbook.json http://localhost:8090/api/v1/runbooks

{
  "apiVersion": "v1",
  "kind": "Runbook",
  "spec": {
    "name": "disk-cleanup",
    "namespace": "production",
    "description": "Free disk space when a StatefulSet reports disk pressure",
    "trigger": {
      "signalType": "disk_pressure",
      "severity": "medium",
      "resourceKind": "StatefulSet"
    },
    "steps": [
      {
        "name": "diagnose",
        "action": "ExecDiagnostic",
        "description": "Check filesystem usage",
        "params": {
          "command": "df -h"
        }
      },
      {
        "name": "restart-pod",
        "action": "RestartStatefulSetPod",
        "description": "Restart the affected pod"
      }
    ],
    "maxAttempts": 3,
    "creationTimestamp": "2026-03-19T16:00:00Z"
  },
  "resourceMeta": {
    "name": "disk-cleanup",
    "namespace": "production",
    "uid": "7d8e9f0a-1b2c-4d3e-9f4a-5b6c7d8e9f0a",
    "creationTimestamp": "2026-03-19T16:00:00Z",
    "labels": {
      "team": "storage"
    }
  }
}

{
  "apiVersion": "v1",
  "kind": "Error",
  "error": "Bad Request",
  "code": 400,
  "message": "name is required"
}

{
  "apiVersion": "v1",
  "kind": "Error",
  "error": "Conflict",
  "code": 409,
  "message": "failed to create runbook: runbooks.platform.chatcli.io \"disk-cleanup\" already exists"
}

Autorizações

X-API-Key

string

header

obrigatório

API key sent in the X-API-Key header. Keys are read from the Secret chatcli-operator-secrets, key api-keys (fallback: ConfigMap chatcli-operator-config, key api-keys) in the operator namespace, as a YAML list of {key, role, name, description} (name is the identity recorded on approval decisions); the operator chart creates it only with apiKeys.create: true. Roles: viewer < operator < admin — any other role string is denied everywhere. Changes are picked up within about 30 seconds; deleting both the Secret and the ConfigMap revokes every key. With no keys configured every /api/ call returns 401, unless CHATCLI_OPERATOR_DEV_MODE=true, which grants admin without a key (development only).

Corpo

application/json

name

string

obrigatório

Required on create; ignored on update.

Exemplo:

"oom-standard"

namespace

string

padrão:default

Create only; ignored on update.

description

string

trigger

object

Show child attributes

steps

object[]

Show child attributes

maxAttempts

integer

Defaults to 3 on create; on update only values > 0 are applied.

labels

object

Show child attributes

Resposta

Runbook created

apiVersion

string

Exemplo:

"v1"

kind

string

Exemplo:

"Runbook"

spec

object

Show child attributes

resourceMeta

object

Show child attributes

Introdução

Incidents

AI Insights

Remediations

Runbooks

Approvals

SLOs

PostMortems

Analytics

Clusters

Federation

Audit

Health

Autorizações

Corpo

Resposta