Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Get Kubernetes Metrics For All Pods

AI-generated

Overview

This node operation retrieves Kubernetes metrics for all pods within a specified namespace. It is useful for monitoring the performance and resource usage of pods in a Kubernetes cluster, enabling users to gather real-time data such as CPU and memory consumption across all pods in a given namespace.

Practical examples include:

  • Monitoring pod resource usage to optimize scaling decisions.
  • Collecting metrics for alerting or dashboard visualization.
  • Auditing resource consumption during deployments or troubleshooting.

Properties

Name Meaning
Id Environment identifier (a numeric ID) specifying which Kubernetes environment to query.
Namespace The Kubernetes namespace from which to retrieve metrics for all pods.

Output

The node outputs JSON data containing metrics for all pods in the specified namespace. This typically includes resource usage statistics such as CPU and memory metrics per pod. The exact structure depends on the Kubernetes metrics API response but generally consists of an array or object with pod names and their corresponding metrics.

No binary data output is indicated.

Dependencies

  • Requires access to a Kubernetes cluster with metrics-server or equivalent metrics API enabled.
  • Needs proper authentication and configuration to connect to the Kubernetes environment identified by the provided environment ID.
  • The node likely depends on an API key or token credential configured in n8n to authenticate requests to the Kubernetes API.

Troubleshooting

  • Common issues:

    • Failure to connect to the Kubernetes cluster due to incorrect environment ID or missing credentials.
    • Metrics API not available if metrics-server is not installed or properly configured in the cluster.
    • Insufficient permissions to access metrics in the specified namespace.

  • Error messages:

    • Connection errors indicating inability to reach the Kubernetes API endpoint.
    • Authorization errors suggesting invalid or missing credentials.
    • Empty or missing metrics data if the namespace does not exist or no pods are running.

  • Resolutions:

    • Verify that the environment ID corresponds to a correctly configured Kubernetes cluster in n8n.
    • Ensure the metrics-server is deployed and accessible in the cluster.
    • Confirm that the credentials used have sufficient RBAC permissions to read pod metrics in the target namespace.
    • Double-check the namespace name for typos or existence.

Links and References

Discussion