Rancher icon

Rancher

Interact with Rancher/Kubernetes API

Actions54

Overview

This node interacts with the Rancher/Kubernetes API to manage various Kubernetes resources, including Deployments. Specifically, the "Deployment" resource with the "Detail" operation retrieves detailed information about a specific deployment within a Kubernetes cluster.

Common scenarios where this node is beneficial include:

  • Inspecting the current state and configuration of a deployment in a Kubernetes environment.
  • Automating monitoring or auditing workflows that require fetching deployment details.
  • Integrating deployment data into broader automation pipelines for DevOps or infrastructure management.

For example, you might use this node to fetch the detailed status of a deployment before deciding to scale it or roll it back.

Properties

Name Meaning
Cluster Name or ID Select the Kubernetes cluster by name or ID where the deployment resides.
Project Name or ID (Optional) Select the project within the cluster.
Namespace Name or ID (Optional) Select the namespace within the project where the deployment exists.
Deployment ID The unique identifier of the deployment to retrieve details for.

These properties allow precise targeting of the deployment resource within the hierarchical structure of cluster → project → namespace → deployment.

Output

The node outputs a JSON object containing detailed information about the specified deployment. This includes metadata, status, configuration, and other relevant fields as returned by the Rancher/Kubernetes API for deployments.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "deployment-id",
  "name": "deployment-name",
  "namespace": "namespace-name",
  "replicas": 3,
  "availableReplicas": 3,
  "labels": {
    "app": "my-app"
  },
  "annotations": { ... },
  "status": { ... },
  "spec": { ... }
}

Dependencies

  • Requires an active Rancher/Kubernetes API connection configured via an API key credential.
  • The node depends on the Rancher API endpoint being accessible and properly authenticated.
  • The user must have appropriate permissions to read deployment details in the targeted cluster/project/namespace.

Troubleshooting

  • Missing or invalid Cluster/Project/Namespace/Deployment IDs: Ensure that the selected cluster, project, namespace, and deployment exist and are correctly specified. Use the provided dropdowns or valid expressions.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network connectivity issues: Confirm that the Rancher API endpoint is reachable from the n8n instance.
  • Permission denied errors: Check that the user associated with the API key has read access to the deployment resource.
  • Empty or unexpected response: Validate that the deployment ID corresponds to an existing deployment and that the namespace/project context is correct.

Links and References

Discussion