podman_pod
El dominio podman_pod tiene 8 acciones. En la superficie meta se alcanzan todas a través de arcane_podman_pod; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.
Resumen
Sección titulada «Resumen»| Acción | Título | Tipo |
|---|---|---|
podman_pod.create | Create pod | escritura |
podman_pod.delete | Remove pod | destructiva |
podman_pod.get | Inspect pod | lectura |
podman_pod.lifecycle | Run pod lifecycle action | destructiva |
podman_pod.list | List pods | lectura |
podman_pod.prune | Prune pods | destructiva |
podman_pod.stats | Get pod stats | lectura |
podman_pod.top | List pod processes | lectura |
Acciones
Sección titulada «Acciones»podman_pod.create
Sección titulada «podman_pod.create»Create pod
- Tipo: escritura
- Parámetros obligatorios:
name - Meta-herramienta:
arcane_podman_podcon"action": "create" - Herramienta individual:
arcane_podman_pod_create - Ruta de Arcane:
POST /api/environments/{id}/podman/pods - ID de operación:
create-podman-pod - Desde: Arcane v2.17.0
- Uso: Creates an empty pod (name required, and it gets an infra container unless noInfra=true) to which containers are added later: hostname, labels, portMappings, networks or networkMode, DNS settings, shared namespaces, restartPolicy, resource limits and the infra container’s image/command. Nothing runs until podman_pod.lifecycle start. Returns the new id. For a pod with its containers in one step use podman.kube_play. Needs podman:pods.
- Acciones relacionadas:
podman_pod.lifecycle,podman_pod.get,podman.kube_play
podman_pod.delete
Sección titulada «podman_pod.delete»Remove pod
- Tipo: destructiva — exige
confirm: true - Parámetros obligatorios:
podId - Meta-herramienta:
arcane_podman_podcon"action": "delete" - Herramienta individual:
arcane_podman_pod_delete - Ruta de Arcane:
DELETE /api/environments/{id}/podman/pods/{podId} - ID de operación:
delete-podman-pod - Desde: Arcane v2.17.0
- Uso: Removes a pod and its containers (podId from podman_pod.list). A pod with running containers is refused unless force=true, which stops them first. Volumes are kept. Needs podman:pods.
- Acciones relacionadas:
podman_pod.list,podman_pod.prune,podman.kube_down
podman_pod.get
Sección titulada «podman_pod.get»Inspect pod
- Tipo: lectura
- Parámetros obligatorios:
podId - Meta-herramienta:
arcane_podman_podcon"action": "get" - Herramienta individual:
arcane_podman_pod_get - Ruta de Arcane:
GET /api/environments/{id}/podman/pods/{podId} - ID de operación:
get-podman-pod - Desde: Arcane v2.17.0
- Uso: Inspects one pod (podId: name or ID from podman_pod.list): state, infra container and its config (ports, networks, DNS), shared namespaces, cgroup, resource limits, mounts and member containers. Not found fails with an error. Needs podman:read.
- Acciones relacionadas:
podman_pod.list,podman_pod.top,podman_pod.stats,podman_pod.lifecycle
podman_pod.lifecycle
Sección titulada «podman_pod.lifecycle»Run pod lifecycle action
Start, stop, restart, pause, unpause, or kill a pod
- Tipo: destructiva — solo cuando
action is kill; esas llamadas exigenconfirm: true, las demás no - Parámetros obligatorios:
podId,action - Meta-herramienta:
arcane_podman_podcon"action": "lifecycle" - Herramienta individual:
arcane_podman_pod_lifecycle - Ruta de Arcane:
POST /api/environments/{id}/podman/pods/{podId}/{action} - ID de operación:
podman-pod-action - Desde: Arcane v2.17.0
- Uso: Runs one lifecycle action on every container of a pod (podId from podman_pod.list): action is start, stop, restart, pause, unpause or kill. timeout (seconds) bounds a stop before Podman kills, signal picks kill’s signal (default SIGKILL). Only kill needs confirm=true (it ends the processes with no chance to shut down, as container.kill), while start, stop, restart, pause and unpause run without it, as their container.* counterparts do. The pod and its containers stay either way (podman_pod.delete removes them), except containers created with —rm (autoRemove, or those of a quadlet .pod unit), which Podman removes when they stop, also through stop or restart here. Returns a message. Needs podman:pods.
- Acciones relacionadas:
podman_pod.get,podman_pod.delete,podman_pod.top
podman_pod.list
Sección titulada «podman_pod.list»List pods
List Podman pods with their member containers
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_podman_podcon"action": "list" - Herramienta individual:
arcane_podman_pod_list - Ruta de Arcane:
GET /api/environments/{id}/podman/pods - ID de operación:
list-podman-pods - Desde: Arcane v2.17.0
- Uso: A page of the environment’s Podman pods (id, name, status, created, infraId, labels, networks and member containers with their state). search matches name, ID, status or network. sort by name, status or created with order asc or desc. start and limit (default 20) page. Only on a Podman environment (podman.status), else 400. Needs podman:read.
- Acciones relacionadas:
podman_pod.get,podman_pod.create,podman_pod.stats,podman.kube_play
podman_pod.prune
Sección titulada «podman_pod.prune»Prune pods
Remove every stopped pod
- Tipo: destructiva — exige
confirm: true - Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_podman_podcon"action": "prune" - Herramienta individual:
arcane_podman_pod_prune - Ruta de Arcane:
POST /api/environments/{id}/podman/pods/prune - ID de operación:
prune-podman-pods - Desde: Arcane v2.17.0
- Uso: Removes every stopped pod of the environment (pods whose containers all exited, killed ones included) and returns the removed pod IDs. Running pods are untouched. Needs podman:pods.
- Acciones relacionadas:
podman_pod.list,podman_pod.delete
podman_pod.stats
Sección titulada «podman_pod.stats»Get pod stats
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_podman_podcon"action": "stats" - Herramienta individual:
arcane_podman_pod_stats - Ruta de Arcane:
GET /api/environments/{id}/podman/pods/stats - ID de operación:
get-podman-pod-stats - Desde: Arcane v2.17.0
- Uso: One snapshot of CPU, memory, network, block I/O and PID usage per container of the pods named in names (names or IDs, empty means every pod), as
podman pod stats --no-stream, and values are Podman’s formatted strings. Needs podman:read. - Acciones relacionadas:
podman_pod.top,podman_pod.list
podman_pod.top
Sección titulada «podman_pod.top»List pod processes
- Tipo: lectura
- Parámetros obligatorios:
podId - Meta-herramienta:
arcane_podman_podcon"action": "top" - Herramienta individual:
arcane_podman_pod_top - Ruta de Arcane:
GET /api/environments/{id}/podman/pods/{podId}/top - ID de operación:
get-podman-pod-top - Desde: Arcane v2.17.0
- Uso: The processes running in a pod’s containers (podId from podman_pod.list) as titles and processes rows, like
podman pod top, and psArgs passes ps format descriptors. Needs podman:read. - Acciones relacionadas:
podman_pod.stats,podman_pod.get