Overview

This node interacts with Docker to perform operations on Docker resources. Specifically, for the 'Volume' resource with the 'Get' operation, it retrieves detailed information about a specific Docker volume by its ID. This is useful for scenarios where you need to inspect or manage Docker volumes programmatically within an automation workflow, such as monitoring volume usage or integrating volume data into other systems.

Use Case Examples

1. Retrieve details of a Docker volume by specifying its ID to monitor storage usage.
2. Automate volume inspection as part of a container deployment pipeline to ensure volumes are correctly configured.

Properties

Output

JSON

• Name - The name of the Docker volume.
• Driver - The driver used by the Docker volume.
• Mountpoint - The mount point path of the Docker volume on the host.
• CreatedAt - The creation timestamp of the Docker volume.
• Labels - Labels associated with the Docker volume.
• Scope - The scope of the Docker volume (e.g., local, global).
• Options - Driver-specific options for the Docker volume.

Dependencies

• Docker API accessed via dockerode library
• An API key credential for Docker authentication

Troubleshooting

• Ensure the Docker credentials provided are correct and have sufficient permissions to access volume information.
• If the volume ID is incorrect or does not exist, the node will throw an error indicating the volume could not be found.
• Errors related to Docker API connectivity may occur if the Docker daemon is not accessible from the environment where the node runs.

Links

• Docker Volume Inspect API - Official Docker API documentation for inspecting volumes, which this node uses to get volume details.