@user/docker/compose

Model type — v2026.02.11.1

Details

Type
@user/docker/compose
Normalized
@user/docker/compose
Version
v2026.02.11.1
Methods
4
Resources
1
Files
0
Definitions
1

Global Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sshHost": {
      "type": "string",
      "description": "SSH hostname or IP address"
    },
    "sshUser": {
      "default": "root",
      "description": "SSH user (default 'root')",
      "type": "string"
    },
    "composePath": {
      "type": "string",
      "description": "Path to docker-compose directory on remote host"
    },
    "serviceName": {
      "description": "Specific service name (optional, operates on all services if omitted)",
      "type": "string"
    }
  },
  "required": [
    "sshHost",
    "sshUser",
    "composePath"
  ],
  "additionalProperties": false
}

Methods (4)

start

Start Docker Compose services

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
stop

Stop Docker Compose services

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
update

Pull latest images and restart Docker Compose services

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
status

Show Docker Compose service status

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Resources (1)

result

Docker compose operation result

Lifetime
infinite
Garbage Collection
10

Definitions (1)

NameVersionTagsID
calamityv1dfc613b0