Docker icon

Docker

Interact with Docker via Portainer API

Overview

This node interacts with Docker through the Portainer API, specifically allowing users to tag Docker images on a selected Docker endpoint. Tagging an image is useful for versioning or organizing images by assigning new tags or moving them between repositories.

Common scenarios include:

  • Adding a new tag to an existing Docker image to mark a release version.
  • Retagging images to push them to different repositories.
  • Organizing images in a registry by tagging them appropriately.

For example, you might use this node to tag an image named myapp:latest as myapp:v1.0 before pushing it to a production repository.

Properties

Name Meaning
EndpointID Name or ID The Docker endpoint to target via Portainer API. Choose from a list of available endpoints or specify an ID using an expression. This determines which Docker environment the operation will run against.
Name The name or ID of the Docker image that you want to tag.
Additional Fields Optional fields to specify further details:
- Repo The repository where the new tag will be created (e.g., someuser/someimage).
- Tag The name of the new tag to assign to the image.

Output

The node outputs JSON data representing the result of the tagging operation. This typically includes confirmation details such as the tagged image information returned by the Portainer API. There is no binary output.

Dependencies

  • Requires access to a Portainer API instance managing Docker endpoints.
  • Requires an API key credential for authenticating with the Portainer API.
  • The node uses the Portainer API endpoint /api/endpoints/{endpointId}/docker to perform Docker operations.
  • The user must configure the node with the URL of the Portainer server and valid credentials.

Troubleshooting

  • Invalid Endpoint ID: If the specified endpoint ID does not exist or is inaccessible, the node will fail. Ensure the endpoint ID is correct and the API user has access.
  • Image Not Found: If the image name or ID does not exist on the targeted Docker endpoint, tagging will fail. Verify the image exists before tagging.
  • Insufficient Permissions: The API key used must have permissions to manage images on the Docker endpoint.
  • Missing Required Fields: The node requires the endpoint ID and image name; missing these will cause errors.
  • Network Issues: Connectivity problems with the Portainer API server will prevent the node from working.

Links and References

Discussion