Portainer icon

Portainer

Interact with Portainer via API

Actions190

Helm → Helm List

AI-generated

Overview

The Helm List operation in this node allows users to retrieve a list of Helm releases from a specified environment (endpoint). This is useful for managing Kubernetes applications deployed via Helm, enabling users to query and filter the releases currently installed in their clusters. Typical use cases include auditing deployed Helm charts, monitoring release statuses, or integrating Helm release data into automation workflows.

Properties

Name Meaning
Id The identifier of the environment or endpoint where the Helm releases are listed.
Additional Fields Optional parameters to refine the list query:
- Namespace Specify a Kubernetes namespace to limit the list to releases within that namespace.
- Filter Provide a filter string to narrow down the results based on release attributes.
- Selector Use a selector expression to filter releases by labels or other criteria.

Output

The output JSON contains an array of Helm release objects representing the releases found in the specified environment. Each object typically includes details such as release name, namespace, status, chart version, and other metadata relevant to the Helm release.

If binary data were involved (not indicated here), it would represent associated files or manifests, but this operation focuses on JSON data describing Helm releases.

Dependencies

  • Requires access to a Kubernetes environment with Helm installed and configured.
  • Needs an API key or authentication token to connect securely to the target environment's Helm API or management endpoint.
  • The node depends on the underlying Portainer API client library for communication.

Troubleshooting

  • Common issues:

    • Invalid or missing environment identifier (Id) can cause failures in connecting to the correct endpoint.
    • Incorrect namespace or filter values may result in empty lists or unexpected results.
    • Network connectivity problems or authentication errors when accessing the Helm API.

  • Error messages:

    • Authentication errors usually indicate invalid or expired credentials; verify and update the API key/token.
    • "Namespace not found" suggests the specified namespace does not exist in the cluster.
    • Timeout or connection refused errors imply network or endpoint availability issues.

Resolving these typically involves checking credentials, verifying environment identifiers, and ensuring network access to the Kubernetes cluster.

Links and References

Discussion