Ir al contenido

registry

El dominio registry tiene 11 acciones. En la superficie meta se alcanzan todas a través de arcane_registry; 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
registry.createCreate a container registryescritura
registry.deleteDelete a container registrydestructiva
registry.getGet a container registrylectura
registry.listList container registrieslectura
registry.pull_usageGet container registry pull usagelectura
registry.repositoriesList registry repositorieslectura
registry.syncSync container registriesdestructiva
registry.tag_deleteDelete a repository tagdestructiva
registry.tagsList repository tagslectura
registry.testTest a container registryescritura
registry.updateUpdate a container registryescritura

Create a container registry

Create a new container registry

  • Tipo: escritura
  • Parámetros obligatorios: awsAccessKeyId, awsRegion, awsSecretAccessKey, description, enabled, insecure, registryType, repositoryNames, token, url, username
  • Meta-herramienta: arcane_registry con "action": "create"
  • Herramienta individual: arcane_registry_create
  • Ruta de Arcane: POST /api/container-registries
  • ID de operación: createContainerRegistry
  • Uso: Stores credentials that Arcane uses to pull images from that host while the registry is enabled, and to browse it with registry.repositories/registry.tags (even when disabled). Every field is required: for registryType “generic” pass a non-empty username and token, empty strings for the aws* fields and repositoryNames: [] (a null is dropped and then rejected). For “ecr” pass awsRegion plus awsAccessKeyId and awsSecretAccessKey together, or both empty to use the default AWS credential chain. An ecr url must be the private endpoint <12-digit account>.dkr.ecr.<region>.amazonaws.com with insecure: false. insecure: true lets Arcane browse a plain-HTTP registry. repositoryNames are the namespaces offered as push targets for builds. The new registry is also pushed to remote environments in the background. Check it with registry.test.
  • Acciones relacionadas: registry.test, registry.repositories, registry.list, image.pull

Delete a container registry

Delete a container registry by ID

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: id
  • Meta-herramienta: arcane_registry con "action": "delete"
  • Herramienta individual: arcane_registry_delete
  • Ruta de Arcane: DELETE /api/container-registries/{id}
  • ID de operación: deleteContainerRegistry
  • Uso: Deletes stored registry credentials (id from registry.list). Arcane then pulls from that host anonymously unless another stored registry covers it. An unknown id fails with 404. The deletion is propagated to remote environments in the background. To stop using the credentials but keep them, set enabled: false with registry.update instead.
  • Acciones relacionadas: registry.list, registry.update

Get a container registry

Get a container registry by ID

  • Tipo: lectura
  • Parámetros obligatorios: id
  • Meta-herramienta: arcane_registry con "action": "get"
  • Herramienta individual: arcane_registry_get
  • Ruta de Arcane: GET /api/container-registries/{id}
  • ID de operación: getContainerRegistry
  • Uso: Returns one registry’s stored settings (url, username, description, insecure, enabled, registryType, repositoryNames, awsAccessKeyId, awsRegion), id from registry.list. The token and AWS secret are never returned. Read it before registry.update, which needs every field sent back.
  • Acciones relacionadas: registry.list, registry.update, registry.test

List container registries

Get a paginated list of container registries

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_registry con "action": "list"
  • Herramienta individual: arcane_registry_list
  • Ruta de Arcane: GET /api/container-registries
  • ID de operación: listContainerRegistries
  • Uso: Lists the registry credentials stored in Arcane. They are global to the Arcane instance, not per environment. search matches url, username and description, and start/limit page through the results. Each item’s id is the registry id every other registry.* action takes. Tokens and AWS secrets are never returned.
  • Acciones relacionadas: registry.get, registry.create, registry.repositories, registry.pull_usage

Get container registry pull usage

Get configured registry pull usage and rate limit visibility

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_registry con "action": "pull_usage"
  • Herramienta individual: arcane_registry_pull_usage
  • Ruta de Arcane: GET /api/container-registries/pull-usage
  • ID de operación: getContainerRegistryPullUsage
  • Uso: Takes no parameters and returns one entry per configured registry: observedPulls counts the successful image pulls Arcane made from that host (e.g. image.pull). Live Docker Hub rate-limit figures (limit, remaining, used, windowSeconds) are fetched only for enabled docker.io registries, with their credentials or anonymously, and cached for 30 minutes (see checkedAt). Other registries report authMethod “unknown” and no limits, and a failed check is reported in error.
  • Acciones relacionadas: registry.list, image.pull

List registry repositories

List the repositories stored in a container registry through its catalog API

  • Tipo: lectura
  • Parámetros obligatorios: id
  • Meta-herramienta: arcane_registry con "action": "repositories"
  • Herramienta individual: arcane_registry_repositories
  • Ruta de Arcane: GET /api/container-registries/{id}/repositories
  • ID de operación: listContainerRegistryRepositories
  • Desde: Arcane v2.15.0
  • Uso: Lists repository names through the registry’s catalog API (/v2/_catalog) with the stored credentials, or anonymously without them. id from registry.list. Only repositories under the namespace path of the registry URL are returned, and registries without a catalog API (Docker Hub, for one) fail. Pass a returned name as repository to registry.tags or registry.tag_delete.
  • Acciones relacionadas: registry.list, registry.tags

Sync container registries

Sync container registries from a remote source

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: registries
  • Meta-herramienta: arcane_registry con "action": "sync"
  • Herramienta individual: arcane_registry_sync
  • Ruta de Arcane: POST /api/container-registries/sync
  • ID de operación: syncContainerRegistries
  • Uso: Agent-side endpoint a manager uses to push its registries: the given list REPLACES this instance’s registries, matched by id, and every registry not in it is deleted (an empty list deletes them all). Each item needs id, url, username, the plain-text token (an empty token clears the stored one), insecure, enabled, registryType, repositoryNames, createdAt and updatedAt. To push registries to an environment use environment.sync instead. registry.create/update/delete already propagate in the background.
  • Acciones relacionadas: environment.sync, registry.list

Delete a repository tag

Delete the manifest a tag points to, which also removes every tag sharing its digest

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: id, repository, tag
  • Meta-herramienta: arcane_registry con "action": "tag_delete"
  • Herramienta individual: arcane_registry_tag_delete
  • Ruta de Arcane: DELETE /api/container-registries/{id}/tags
  • ID de operación: deleteContainerRegistryTag
  • Desde: Arcane v2.15.0
  • Uso: Deletes the manifest by digest in the remote registry, so every other tag of the same image disappears too. Irreversible. repository from registry.repositories, tag from registry.tags. The registry must allow deletes and the stored credentials need delete rights. Returns the deleted digest. It does not touch images on any Docker host: use image.delete for those.
  • Acciones relacionadas: registry.tags, registry.repositories, image.delete

List repository tags

List the tags of a registry repository with their manifest details

  • Tipo: lectura
  • Parámetros obligatorios: id, repository
  • Meta-herramienta: arcane_registry con "action": "tags"
  • Herramienta individual: arcane_registry_tags
  • Ruta de Arcane: GET /api/container-registries/{id}/tags
  • ID de operación: listContainerRegistryTags
  • Desde: Arcane v2.15.0
  • Uso: Lists the tags of one repository (a full name from registry.repositories, including any namespace of the registry URL, id from registry.list) with digest, mediaType, total size, per-platform os/architecture/size, and created for single-platform images. Manifest details are fetched only for the current page (limit, default 20). A tag whose manifest cannot be read carries error instead of failing the list. Tags with the same digest are one manifest, which registry.tag_delete removes together.
  • Acciones relacionadas: registry.repositories, registry.tag_delete

Test a container registry

Test connectivity and authentication to a container registry

  • Tipo: escritura
  • Parámetros obligatorios: id
  • Meta-herramienta: arcane_registry con "action": "test"
  • Herramienta individual: arcane_registry_test
  • Ruta de Arcane: POST /api/container-registries/{id}/test
  • ID de operación: testContainerRegistry
  • Uso: Logs in through the Arcane instance’s local Docker daemon (not a remote environment’s) with the stored credentials (id from registry.list), so the registry must be reachable from the daemon, over TLS the daemon trusts (Docker uses plain HTTP only for 127.0.0.0/8 and configured insecure registries). ECR registries first obtain a token from AWS. Success returns “Authentication succeeded” (“ECR authentication succeeded” for ECR). A registry without credentials is reported as saved, not tested, and a bad login fails with “login failed”.
  • Acciones relacionadas: registry.list, registry.update, registry.create

Update a container registry

Update an existing container registry

  • Tipo: escritura
  • Parámetros obligatorios: id, awsAccessKeyId, awsRegion, awsSecretAccessKey, description, enabled, insecure, registryType, repositoryNames, token, url, username
  • Meta-herramienta: arcane_registry con "action": "update"
  • Herramienta individual: arcane_registry_update
  • Ruta de Arcane: PUT /api/container-registries/{id}
  • ID de operación: updateContainerRegistry
  • Uso: Rewrites a registry (id from registry.list) and every field is required, so start from registry.get and send all of them back. token: "" keeps the stored token, but moving url to another host requires the token again. registryType cannot change. description and repositoryNames are replaced by what you send. enabled: false stops Arcane using the credentials without deleting them. The change is pushed to remote environments in the background. Failures there are only logged, so use environment.sync to retry one.
  • Acciones relacionadas: registry.get, registry.test, registry.list, environment.sync