Rancher icon

Rancher

Interact with Rancher/Kubernetes API

Overview

The node interacts with Rancher and Kubernetes APIs to manage various Kubernetes resources. Specifically, for the Deployment - Get operation, it retrieves information about one or more deployments within a specified cluster, project, and namespace. This is useful for monitoring deployment statuses, fetching metadata, or integrating deployment data into automation workflows.

Common scenarios include:

  • Fetching a list of deployments filtered by creation date, creator ID, name, or UUID.
  • Sorting deployments by creation time or name in ascending or descending order.
  • Limiting the number of returned deployments for pagination or performance reasons.

Example use cases:

  • Automatically retrieving deployment details to trigger alerts if certain deployments are missing or outdated.
  • Integrating deployment metadata into dashboards or reports.
  • Using deployment data as input for further automation steps like scaling or updating deployments.

Properties

Name Meaning
Cluster Name or ID Select the Kubernetes cluster to query. Choose from a dropdown list or specify an ID via expression.
Project Name or ID (Optional) Select the project within the cluster. Choose from a dropdown list or specify an ID via expression.
Namespace Name or ID (Optional) Select the namespace within the project. Choose from a dropdown list or specify an ID via expression.
Additional Fields Collection of optional parameters to refine the query:
  Filters Filter deployments by creation timestamp, creator ID, name, or UUID.
  Sort Sort results by "Created" or "Name" fields, in ascending or descending order.
  Limit Maximum number of deployments to return. Use -1 to return all matching deployments.

Output

The output is an array of JSON objects representing deployments retrieved from the Rancher/Kubernetes API. Each object contains detailed information about a deployment, such as metadata, status, labels, annotations, and other relevant properties depending on the API response.

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for Rancher/Kubernetes API authentication configured in n8n.
  • The node depends on Rancher/Kubernetes API endpoints to fetch deployment data.
  • Dynamic loading of clusters, projects, namespaces, and deployments is supported via internal methods.

Troubleshooting

  • Empty result set: Ensure that the selected cluster, project, and namespace contain deployments matching the filters. Verify correct IDs or names are used.
  • Authentication errors: Confirm that the API key credential is valid and has sufficient permissions to read deployments.
  • Invalid filter or sort values: Check that filter fields and sort options conform to expected formats and allowed values.
  • API rate limits or connectivity issues: Network problems or API throttling may cause failures; retry after some time or check network settings.

Links and References

Discussion