swarm_config
El dominio swarm_config tiene 5 acciones. En la superficie meta se alcanzan todas a través de arcane_swarm_config; 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 |
|---|---|---|
swarm_config.create | Create swarm config | escritura |
swarm_config.delete | Delete swarm config | destructiva |
swarm_config.get | Get swarm config | lectura |
swarm_config.list | List swarm configs | lectura |
swarm_config.update | Update swarm config labels | escritura |
Acciones
Sección titulada «Acciones»swarm_config.create
Sección titulada «swarm_config.create»Create swarm config
- Tipo: escritura
- Parámetros obligatorios:
spec - Meta-herramienta:
arcane_swarm_configcon"action": "create" - Herramienta individual:
arcane_swarm_config_create - Ruta de Arcane:
POST /api/environments/{id}/swarm/configs - ID de operación:
create-swarm-config - Uso: spec uses Docker’s field names: {Name (required), Data (the content, base64-encoded), Labels}. Returns the created config with its id. Configs are immutable: to change one, create a new config and reference it in the service’s spec.TaskTemplate.ContainerSpec.Configs (ConfigID, ConfigName, File) with swarm_service.create or swarm_service.update. For sensitive data use swarm_secret.create. Requires the swarm:configs permission.
- Acciones relacionadas:
swarm_config.list,swarm_service.create,swarm_service.update,swarm_secret.create
swarm_config.delete
Sección titulada «swarm_config.delete»Delete swarm config
- Tipo: destructiva — exige
confirm: true - Parámetros obligatorios:
configId - Meta-herramienta:
arcane_swarm_configcon"action": "delete" - Herramienta individual:
arcane_swarm_config_delete - Ruta de Arcane:
DELETE /api/environments/{id}/swarm/configs/{configId} - ID de operación:
delete-swarm-config - Uso: configId (ID or name) from swarm_config.list. Refused while any service still references the config. Update or delete that service first, and its old tasks may take a moment to release it. Requires the swarm:configs permission.
- Acciones relacionadas:
swarm_config.list,swarm_service.list,swarm_service.update,swarm_service.delete
swarm_config.get
Sección titulada «swarm_config.get»Get swarm config
- Tipo: lectura
- Parámetros obligatorios:
configId - Meta-herramienta:
arcane_swarm_configcon"action": "get" - Herramienta individual:
arcane_swarm_config_get - Ruta de Arcane:
GET /api/environments/{id}/swarm/configs/{configId} - ID de operación:
get-swarm-config - Uso: configId accepts the config’s ID or its name (from swarm_config.list). spec.Data holds the content, base64-encoded. Not found returns 404.
- Acciones relacionadas:
swarm_config.list,swarm_config.delete
swarm_config.list
Sección titulada «swarm_config.list»List swarm configs
- Tipo: lectura
- Parámetros obligatorios: ninguno
- Meta-herramienta:
arcane_swarm_configcon"action": "list" - Herramienta individual:
arcane_swarm_config_list - Ruta de Arcane:
GET /api/environments/{id}/swarm/configs - ID de operación:
list-swarm-configs - Uso: Returns a page of the environment’s swarm configs (start, limit default 20), each with id, spec (Name, Labels, Data base64-encoded), version and timestamps. search matches the name or ID, sort by name, createdAt or updatedAt with order asc or desc. The environment must be a swarm manager (check with swarm.status). Requires swarm:read.
- Acciones relacionadas:
swarm_config.get,swarm_config.create,swarm_config.update,swarm.status
swarm_config.update
Sección titulada «swarm_config.update»Update swarm config labels
- Tipo: escritura
- Parámetros obligatorios:
configId,labels,version - Meta-herramienta:
arcane_swarm_configcon"action": "update" - Herramienta individual:
arcane_swarm_config_update - Ruta de Arcane:
PUT /api/environments/{id}/swarm/configs/{configId} - ID de operación:
update-swarm-config - Desde: Arcane v2.17.0
- Uso: Replaces the labels of a config (configId, ID or name, from swarm_config.list) with labels ({} clears them). The data, name and templating are immutable, so to change the content create a new config and point the services at it. version is the config’s version.Index from swarm_config.get (0 uses the current one), and a stale version is refused by Docker. Returns the updated config. Requires the swarm:configs permission.
- Acciones relacionadas:
swarm_config.get,swarm_config.list,swarm_config.create