OpenClaw - Arcane Docker Management Skill

Overview

This skill enables you to interact with your Arcane Docker Management API to manage Docker containers, compose stacks, templates, networks, volumes, images, and system monitoring. Arcane is a comprehensive Docker management platform with a REST API.

When to Use This Skill

Use this skill when the user requests any of the following:

• Managing Docker containers (list, start, stop, restart, remove, inspect)
• Managing Docker Compose stacks (deploy, update, remove, view logs)
• Working with Docker templates (create, deploy, manage)
• Managing Docker images (list, pull, remove, prune)
• Managing Docker networks and volumes
• Monitoring system resources and Docker statistics
• Managing user accounts and API keys
• Viewing system logs and events

API Configuration

Base URL

The API base URL should be configured by the user. Default: ### Authentication Arcane supports two authentication methods: 1. **Bearer Token (JWT)**: Obtained via login endpoint 2. **API Key**: Long-lived authentication using X-API-Key header #### Getting a Bearer Token __CODE_BLOCK_0__ Response includes token, refreshToken, and expiresAt. #### Using API Keys API keys can be created and managed through the /apikeys endpoints. Use the X-API-Key header for authentication. ## Core Functionality ### 1. Container Management #### List Containers __CODE_BLOCK_1__ #### Container Operations __CODE_BLOCK_2__ #### Advanced Container Operations __CODE_BLOCK_3__ ### 2. Docker Compose Stack Management #### List Stacks __CODE_BLOCK_4__ #### Deploy Stack from Template __CODE_BLOCK_5__ #### Deploy Stack from Compose File __CODE_BLOCK_6__ #### Stack Operations __CODE_BLOCK_7__ ### 3. Template Management #### List Templates __CODE_BLOCK_8__ #### Create Template __CODE_BLOCK_9__ #### Template Operations __CODE_BLOCK_10__ #### Global Template Variables __CODE_BLOCK_11__ ### 4. Image Management #### List Images __CODE_BLOCK_12__ #### Pull Image __CODE_BLOCK_13__ #### Image Operations __CODE_BLOCK_14__ ### 5. Network Management #### List Networks __CODE_BLOCK_15__ #### Create Network __CODE_BLOCK_16__ #### Network Operations __CODE_BLOCK_17__ ### 6. Volume Management #### List Volumes __CODE_BLOCK_18__ #### Create Volume __CODE_BLOCK_19__ #### Volume Operations __CODE_BLOCK_20__ ### 7. System Monitoring #### System Information __CODE_BLOCK_21__ #### Events and Logs __CODE_BLOCK_22__ ### 8. User Management #### List Users __CODE_BLOCK_23__ #### Create User __CODE_BLOCK_24__ #### User Operations __CODE_BLOCK_25__ ### 9. API Key Management #### List API Keys __CODE_BLOCK_26__ #### Create API Key __CODE_BLOCK_27__ #### API Key Operations __CODE_BLOCK_28__ ## Implementation Guidelines ### Error Handling All API responses follow a standard format: __CODE_BLOCK_29__ Error responses use HTTP problem details (RFC 7807): __CODE_BLOCK_30__ ### Pagination List endpoints support pagination with these query parameters: - start: Starting index (default: 0) - limit: Items per page (default: 20) - sort: Column to sort by - order: Sort direction (asc/desc, default: asc) - search: Search query Response includes pagination metadata: __CODE_BLOCK_31__ ### Using Python When implementing Arcane operations in Python, use the requests library: __CODE_BLOCK_32__ ### Using Bash For simple operations, use curl with error handling: __CODE_BLOCK_33__ ## Common Workflows ### 1. Deploy Application Stack __CODE_BLOCK_34__ ### 2. Scale and Monitor Containers __CODE_BLOCK_35__ ### 3. Cleanup and Maintenance __CODE_BLOCK_36__ ## Best Practices 1. **Authentication**: Always use API keys for automated scripts and services. Use JWT tokens for interactive sessions. 2. **Error Handling**: Check response status codes and handle errors appropriately: - 200: Success - 400: Bad request (validation error) - 401: Unauthorized - 403: Forbidden - 404: Not found - 500: Internal server error 3. **Resource Management**: - Always specify resource limits when creating containers - Use labels to organize resources - Regularly prune unused resources 4. **Security**: - Store API keys and tokens securely (use environment variables) - Use HTTPS in production - Implement proper access controls with user roles - Rotate API keys regularly 5. **Monitoring**: - Monitor container stats regularly - Set up alerts for resource usage - Review system logs periodically 6. **Templates**: - Use variables for configurable values - Document template variables clearly - Version control your templates - Use global variables for shared configuration ## Troubleshooting ### Common Issues **Authentication Failed** - Verify token is not expired (check expiresAt) - Use refresh token to get new access token - Verify API key is correct and not expired **Container Won't Start** - Check container logs: GET /containers/{id}/logs - Inspect container: GET /containers/{id} - Verify port conflicts and resource availability **Stack Deployment Failed** - Validate compose file syntax - Check template variables are properly defined - Review stack logs: GET /stacks/{id}/logs`

Resource Not Found

• Verify resource ID is correct


• Check if resource was deleted


• Ensure proper permissions

Notes

• All timestamps are in ISO 8601 format (UTC)
• Container IDs can be full or short (first 12 characters)
• Image names support full registry paths (registry.example.com/image:tag)
• Network and volume names must be unique
• Stack names must be unique per user/project

Reference Links

For complete API documentation and schema definitions, refer to the OpenAPI specification provided in the JSON schema.