Portainer icon

Portainer

Interact with Portainer via API

Actions190

Helm → Helm Install

AI-generated

Overview

The Helm Install operation in this node allows users to deploy Helm charts to a Kubernetes environment by sending chart details as a payload. This is useful for automating the deployment of applications packaged as Helm charts, enabling infrastructure as code practices and simplifying application lifecycle management on Kubernetes clusters.

Typical use cases include:

  • Automating the installation of Helm charts during CI/CD pipelines.
  • Deploying or upgrading applications on Kubernetes clusters programmatically.
  • Managing multiple environments by specifying different endpoint identifiers.

Properties

Name Meaning
Id Environment (Endpoint) identifier; specifies which Kubernetes environment to target for the Helm install operation. Must be a number.
Payload Chart details; a string containing the Helm chart configuration and parameters to be installed.

Output

The node outputs JSON data representing the response from the Helm install operation. This typically includes information about the deployment status, release name, namespace, and any messages returned by the Helm API or service handling the installation.

No binary data output is indicated.

Dependencies

  • Requires an API key credential or similar authentication token to connect securely to the target environment's Helm service or Kubernetes cluster.
  • The node depends on an external Helm API or service endpoint identified by the "Id" property.
  • Proper network access and permissions to perform Helm operations on the specified environment are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing environment identifier ("Id") can cause failures to locate the target Kubernetes cluster.
    • Malformed or incomplete Helm chart details in the "Payload" may result in errors during installation.
    • Authentication failures if the API key or credentials are incorrect or expired.
    • Network connectivity problems between n8n and the Kubernetes environment.
  • Error messages:

    • Errors indicating inability to reach the Helm service usually suggest checking network settings and endpoint correctness.
    • Validation errors related to the payload imply that the Helm chart data needs correction or completion.
    • Authentication errors require verifying the API key or credentials used.

Links and References

Discussion