Ir al contenido

updater

El dominio updater tiene 5 acciones. En la superficie meta se alcanzan todas a través de arcane_updater; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

AcciónTítuloTipo
updater.container_updateUpdate a single containerdestructiva
updater.historyGet updater historylectura
updater.project_checkCheck project service updatesescritura
updater.runRun updaterdestructiva
updater.statusGet updater statuslectura

Update a single container

Pull the latest image and apply the appropriate update strategy for a specific container

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: containerId
  • Meta-herramienta: arcane_updater con "action": "container_update"
  • Herramienta individual: arcane_updater_container_update
  • Ruta de Arcane: POST /api/environments/{id}/containers/{containerId}/update
  • ID de operación: update-container
  • Uso: Pulls the container’s image tag and, when the image changed, recreates the container (same name, new ID). The result counts checked/updated/skipped/failed and each item has status and updateApplied. containerId from container.list. Use instead of updater.run to touch one container. A compose service is better updated with project.update_services. It ignores the auto-update exclusion setting and opt-out label, but skips a container run by a Podman quadlet (since Arcane v2.17.1, use podman.auto_update_run). async=true returns the accepted activity at once (follow it with activity.get).
  • Acciones relacionadas: updater.run, updater.status, container.list, container.get, image_update.check_ref, activity.get

Get updater history

Get the history of update operations

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_updater con "action": "history"
  • Herramienta individual: arcane_updater_history
  • Ruta de Arcane: GET /api/environments/{id}/updater/history
  • ID de operación: get-updater-history
  • Uso: Stored per-resource auto-update records (resource, status, old/new image, updateApplied, error), newest first, and limit defaults to 50. Only unscoped runs write them (updater.run without resourceIds, dry runs included, and the scheduled auto-update). Scoped updater.run calls and updater.container_update are not recorded, so read their outcome from their own result or from activity.list.
  • Acciones relacionadas: updater.run, activity.list

Check project service updates

  • Tipo: escritura
  • Parámetros obligatorios: projectId
  • Meta-herramienta: arcane_updater con "action": "project_check"
  • Herramienta individual: arcane_updater_project_check
  • Ruta de Arcane: POST /api/environments/{id}/updater/projects/{projectId}/check
  • ID de operación: check-project-updates
  • Desde: Arcane v2.11.0
  • Uso: Checks each image service of a compose project against its registry, honoring the services’ update-policy labels, and replaces the project’s stored image-update records with the fresh results. Nothing is pulled or recreated. projectId from project.list. Returns updateInfo-style fields (status, hasUpdate, imageCount, imagesWithUpdates, serviceUpdates). Apply with project.update_services or project.redeploy.
  • Acciones relacionadas: project.list, project.updates, project.update_services, project.redeploy

Run updater

Apply pending container updates

  • Tipo: destructiva — solo cuando dryRun is false or absent; esas llamadas exigen confirm: true, las demás no
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_updater con "action": "run"
  • Herramienta individual: arcane_updater_run
  • Ruta de Arcane: POST /api/environments/{id}/updater/run
  • ID de operación: run-updater
  • Uso: Applies updates across the environment and waits for the result (checked, updated, restarted, skipped, failed, items, activityId). Without resourceIds it applies the pending standalone image updates found by earlier image_update checks. With resourceIds and type container, project (project ID or compose:<name>) or image it updates only the matching containers, and 400s when none match. dryRun reports without changing anything, forceUpdate updates even when current. It fails if another update is already running (see updater.status). With or without resourceIds, a manual run updates opted-out containers too: those with the label com.getarcaneapp.arcane.updater=false or named in the autoUpdateExcludedContainers setting, when they have a pending update (since Arcane v2.17.1. Without resourceIds that means every opted-out container with one. Containers only restarted as dependents still honor both.) automatic=true honors them, as the scheduled auto-update and webhooks do. Containers run by a Podman quadlet are always skipped (use podman.auto_update_run). Only the scheduled auto-update waits for the autoUpdateDelay setting (hours since Arcane first saw the new image, and a container’s com.getarcaneapp.arcane.updater.delay label overrides it, 0 included). This action applies at once. Needs confirm=true unless dryRun=true.
  • Acciones relacionadas: updater.status, updater.container_update, image_update.check_all, image_update.summary, activity.get, podman.auto_update_run

Get updater status

Get the current status of the updater

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_updater con "action": "status"
  • Herramienta individual: arcane_updater_status
  • Ruta de Arcane: GET /api/environments/{id}/updater/status
  • ID de operación: get-updater-status
  • Uso: Live, in-memory view of updates in progress: updatingContainers and updatingProjects counts plus their containerIds and projectIds. Check it before updater.run or updater.container_update, which refuse to start while another update holds the updater.
  • Acciones relacionadas: updater.run, updater.container_update