Overview

This node operation retrieves detailed information about a specific edge computing stack in Portainer by its ID. It is useful for managing and monitoring edge stacks in a Docker or Kubernetes environment, allowing users to fetch the current configuration and status of an edge stack.

Use Case Examples

1. Fetch details of an edge stack by providing its unique Edge Stack ID to monitor its configuration and deployment status.
2. Use this operation to integrate edge stack information retrieval into automation workflows for edge computing management.

Properties

Output

JSON

• id - The unique identifier of the edge stack.
• name - The name of the edge stack.
• stackFileContent - The content of the stack file (e.g., docker-compose.yml) defining the stack.
• edgeGroups - List of edge groups associated with the stack.
• deploymentType - The deployment type of the stack (e.g., Docker Compose, Docker Swarm, Kubernetes).
• prePullImage - Flag indicating whether images should be pre-pulled before deployment.
• retryDeploy - Flag indicating whether deployment should be retried on failure.

Dependencies

• Portainer API with an API key credential for authentication

Troubleshooting

• Ensure the Edge Stack ID is correct and exists in the Portainer environment to avoid 'not found' errors.
• Verify API credentials and base URL configuration to prevent authentication or connection errors.
• If SSL issues occur, consider enabling the 'Ignore SSL Issues' option if appropriate for your environment.

Links

• Portainer Edge Stacks API Documentation - Official documentation for managing edge stacks via the Portainer API.