Overview

This node interacts with Docker to perform various operations such as listing, getting, and running Docker resources like containers, images, volumes, and networks. For the 'list' operation, it retrieves a list of the specified Docker resource based on optional filter options provided as JSON. This node is useful for automating Docker management tasks within workflows, such as monitoring running containers, listing available images, or managing Docker volumes and networks.

Use Case Examples

1. List all running Docker containers with optional filters.
2. Retrieve a list of Docker images available on the host.
3. List Docker volumes or networks for management or monitoring purposes.

Properties

Output

JSON

• id - Identifier of the Docker resource item.
• name - Name of the Docker resource item.
• status - Status information of the Docker resource item.
• otherProperties - Additional properties returned by the Docker API for each listed resource item.

Dependencies

• Docker API accessed via dockerode library
• Requires Docker API credentials for authentication

Troubleshooting

• Ensure Docker credentials are correctly configured and accessible by the node.
• Verify that the Docker daemon is running and reachable from the environment where the node executes.
• If the 'options' JSON is malformed, the node may throw errors; ensure valid JSON syntax.
• Common error: 'No credentials got returned!' indicates missing or misconfigured Docker API credentials.

Links

• Docker Engine API - Official Docker API documentation for understanding available operations and options.
• dockerode GitHub Repository - Node.js Docker API client used by this node to interact with Docker.