Portainer icon

Portainer

Interact with Portainer via API

Actions190

Helm → Helm Delete

AI-generated

Overview

The Helm Delete operation in this node allows users to uninstall a Helm release (an application deployed via Helm) from a Kubernetes environment. This is useful for managing and cleaning up Helm deployments by removing unwanted or outdated releases.

Typical use cases include:

  • Automating the removal of specific Helm releases as part of CI/CD pipelines.
  • Cleaning up test or staging environments by deleting temporary Helm applications.
  • Managing Kubernetes resources programmatically without manual CLI intervention.

For example, you can specify the release name and optionally the namespace to delete a particular Helm deployment from your cluster.

Properties

Name Meaning
Id The identifier of the target environment or endpoint where the Helm release is installed.
Release The name of the Helm release/application to uninstall.
Additional Fields Optional extra parameters; currently supports:
- Namespace An optional Kubernetes namespace where the release is located. If not specified, defaults to the current namespace.

Output

The node outputs JSON data representing the result of the Helm delete operation. This typically includes status information about the uninstallation process, such as success confirmation or error details if the deletion failed.

No binary data output is expected from this operation.

Dependencies

  • Requires access to a Kubernetes environment configured with Helm.
  • Needs an API key or authentication token credential to connect securely to the target environment's API endpoint.
  • The node depends on the Helm CLI or Helm API being accessible through the configured environment identified by the "Id" property.

Troubleshooting

  • Common issues:

    • Incorrect or missing release name will cause the deletion to fail.
    • Specifying a wrong or non-existent namespace may lead to errors or no action.
    • Network or authentication failures when connecting to the Kubernetes environment.

  • Error messages:

    • Errors indicating "release not found" suggest the release name or namespace is incorrect.
    • Authentication errors imply invalid or missing credentials.
    • Timeout or connection refused errors indicate network or endpoint configuration problems.

  • Resolutions:

    • Verify the release name and namespace are correct.
    • Ensure the API credentials are valid and have sufficient permissions.
    • Confirm network connectivity and that the target environment is reachable.

Links and References

Discussion