Rancher icon

Rancher

Interact with Rancher/Kubernetes API

Overview

The node provides integration with Rancher and Kubernetes APIs to manage various Kubernetes resources, including workloads. Specifically for the Workload resource with the Resume operation, this node resumes a paused workload in a Kubernetes cluster managed by Rancher. This is useful when you want to restart or continue the execution of a workload that was previously paused, such as deployments or other workload types.

Common scenarios include:

  • Resuming a deployment after maintenance or troubleshooting.
  • Restarting workloads that were temporarily suspended to save resources.
  • Automating workload lifecycle management in CI/CD pipelines.

Example: You paused a deployment to apply some configuration changes and now want to resume it automatically using this node.

Properties

Name Meaning
Cluster Name or ID Select the target Kubernetes cluster by name or ID where the workload resides.
Project Name or ID (Optional) Select the project within the cluster to scope the workload.
Namespace Name or ID (Optional) Select the namespace within the project where the workload is located.

These properties are used to identify the exact location of the workload in the Rancher/Kubernetes environment.

Output

The node outputs JSON data representing the result of the resume operation on the workload. The structure typically includes details about the resumed workload's status and metadata as returned by the Rancher/Kubernetes API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active Rancher API credential configured in n8n to authenticate requests.
  • Depends on Rancher/Kubernetes API availability and proper permissions to manage workloads.
  • Uses internal methods to load options dynamically for clusters, projects, and namespaces.

Troubleshooting

  • Common issues:

    • Invalid or missing cluster/project/namespace identifiers can cause failures.
    • Insufficient permissions in Rancher/Kubernetes to resume workloads.
    • Network connectivity issues to the Rancher API endpoint.
  • Error messages:

    • Authentication errors indicate problems with the provided API credentials.
    • Resource not found errors suggest incorrect cluster/project/namespace or workload IDs.
    • Permission denied errors mean the API user lacks rights to resume workloads.
  • Resolutions:

    • Verify and select correct cluster, project, and namespace.
    • Ensure the API key has sufficient permissions.
    • Check network access and Rancher API health.

Links and References

Discussion