Ir al contenido

swarm_secret

El dominio swarm_secret tiene 5 acciones. En la superficie meta se alcanzan todas a través de arcane_swarm_secret; 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
swarm_secret.createCreate swarm secretescritura
swarm_secret.deleteDelete swarm secretdestructiva
swarm_secret.getGet swarm secretlectura
swarm_secret.listList swarm secretslectura
swarm_secret.updateUpdate swarm secret labelsescritura

Create swarm secret

  • Tipo: escritura
  • Parámetros obligatorios: spec
  • Meta-herramienta: arcane_swarm_secret con "action": "create"
  • Herramienta individual: arcane_swarm_secret_create
  • Ruta de Arcane: POST /api/environments/{id}/swarm/secrets
  • ID de operación: create-swarm-secret
  • Uso: spec uses Docker’s field names: {Name (required), Data (the secret, base64-encoded), Labels}. Returns the created secret with its id. The value can never be read back, and secrets are immutable: to rotate, create a new secret and reference it in the service’s spec.TaskTemplate.ContainerSpec.Secrets (SecretID, SecretName, File) with swarm_service.create or swarm_service.update. Requires the swarm:secrets permission. Use swarm_config.create for non-sensitive data.
  • Acciones relacionadas: swarm_secret.list, swarm_service.create, swarm_service.update, swarm_config.create

Delete swarm secret

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: secretId
  • Meta-herramienta: arcane_swarm_secret con "action": "delete"
  • Herramienta individual: arcane_swarm_secret_delete
  • Ruta de Arcane: DELETE /api/environments/{id}/swarm/secrets/{secretId}
  • ID de operación: delete-swarm-secret
  • Uso: secretId (ID or name) from swarm_secret.list. Refused while any service still references the secret. Update or delete that service first (its old tasks may take a moment to release it). Requires the swarm:secrets permission.
  • Acciones relacionadas: swarm_secret.list, swarm_service.list, swarm_service.update, swarm_service.delete

Get swarm secret

  • Tipo: lectura
  • Parámetros obligatorios: secretId
  • Meta-herramienta: arcane_swarm_secret con "action": "get"
  • Herramienta individual: arcane_swarm_secret_get
  • Ruta de Arcane: GET /api/environments/{id}/swarm/secrets/{secretId}
  • ID de operación: get-swarm-secret
  • Uso: secretId from swarm_secret.list (Docker also resolves a name). Returns id, version, timestamps and spec (Name, Labels) only: Docker never returns a secret’s data. Not found returns 404, and the environment must be a swarm manager.
  • Acciones relacionadas: swarm_secret.list, swarm_secret.delete, swarm_service.list

List swarm secrets

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_swarm_secret con "action": "list"
  • Herramienta individual: arcane_swarm_secret_list
  • Ruta de Arcane: GET /api/environments/{id}/swarm/secrets
  • ID de operación: list-swarm-secrets
  • Uso: Returns a page of the environment’s swarm secrets (start, limit default 20), each with id, spec (Name, Labels), version and timestamps. The secret value is never included. search matches the name or ID, sort by name, createdAt or updatedAt with order asc or desc. The environment must be a swarm manager: outside a swarm it fails with ‘Swarm mode is not enabled’, on a worker with ‘Swarm manager access required’ (swarm.status only reports whether swarm mode is on, not the node’s role). Requires swarm:read.
  • Acciones relacionadas: swarm_secret.get, swarm_secret.create, swarm_secret.delete, swarm_secret.update, swarm.status

Update swarm secret labels

  • Tipo: escritura
  • Parámetros obligatorios: secretId, labels, version
  • Meta-herramienta: arcane_swarm_secret con "action": "update"
  • Herramienta individual: arcane_swarm_secret_update
  • Ruta de Arcane: PUT /api/environments/{id}/swarm/secrets/{secretId}
  • ID de operación: update-swarm-secret
  • Desde: Arcane v2.17.0
  • Uso: Replaces the labels of a secret (secretId, ID or name, from swarm_secret.list) with labels ({} clears them). The value and name are immutable, so to rotate it create a new secret and reference it from the services (swarm_service.update). version is the secret’s version.Index from swarm_secret.get (0 uses the current one), and a stale version is refused by Docker. Returns the updated secret without its value. Requires the swarm:secrets permission.
  • Acciones relacionadas: swarm_secret.get, swarm_secret.list, swarm_secret.create, swarm_service.update