The Kubernetes integration is compatible with many different platforms including GKE, EKS, AKS, OpenShift, and more. Each has a different compatibility with our integration. You can find more information in this page.
Requirements
The New Relic Kubernetes integration requires a New Relic account. If you haven't already, create your free New Relic account below to start monitoring your data today.
You'll also need:
- A Linux distribution compatible with New Relic infrastructure agent.
- If you are using Helm, see the specific compatibility and requirements.
Important
kube-state-metrics
v2 or higher is supported from integration version 3.6.0 or higher.
Install the Kubernetes integration up to version 3.5.0 if you are using kube-state-metrics
1.9.8 or lower.
Check the values.yaml
file if you're updating kube-state-metrics
from v1.9.8 to v2 or higher because some variables may have changed.
Container runtime
Our Kubernetes integration is CRI-agnostic. It's been specifically tested to be compatible with Containerd, CRI-O, and Docker.
Compatibility
Our Kubernetes integration is compatible with Kubernetes versions 1.16 to 1.26. Kubernetes 1.27.x is currently in an experimental release phase; if you find any issues, please contact support @ newrelic.com.
Important
If you are using Openshift, you can also use kubectl
most of the time but be careful that kubectl
does not have commands like oc login
or oc adm
. You may need to use oc
instead of kubectl
.
Our integration is compatible and is continuously tested on the following Kubernetes versions:
Versions | |
---|---|
Kubernetes cluster | 1.16 to 1.26 |
Our integration currently supports an experimental release of the following Kubernetes versions:
Versions | |
---|---|
Kubernetes cluster | 1.27 |
Important
If you find any issues with our integration on Kubernetes version 1.27.x, please contact support @ newrelic.com.
Important
Starting from Kubernetes version 1.26, the @autoscaling/v2beta2
API is no longer available and replaced by the @autoscaling/v2
. For continued HorizontalPodAutoscaling
metric reporting it's important that you install kube-state-metrics
version 2.7+ on the Kubernetes version 1.26+ clusters. This is because only kube-state-metrics
v2.7+ can support the @autoscaling/v2
API.
Kubernetes Flavors
Kubernetes integration is compatible with different flavors. We tested the integration with the following ones:
Flavor | Notes |
---|---|
Minikube | |
Kind | |
K3s | |
Kubeadm | |
Amazon Elastic Kubernetes Service (EKS) | |
Amazon Elastic Kubernetes Service Anywhere (EKS-Anywhere) | |
Amazon Elastic Kubernetes Service on Fargate (EKS-Fargate) | |
Rancher Kubernetes Engine (RKE1) | Extra configuration is needed to instrument control plane components |
Azure Kubernetes Service (AKS) | |
Google Kubernetes Engine (GKE) | |
OpenShift | Tested with OpenShift 4.12 and lower. Note that 3.x versions are no longer supported. |
VMware Tanzu | Compatible with VMware Tanzu (Pivotal Platform) version 2.5 to 2.11, and Ops Manager version 2.5 to 2.10 |
Depending on the installation method, the control plane monitoring is not available or may need extra configuration.
For example:
- Only API Server metrics are scrapable and available to instrument managed clusters (GKE, EKS, AKS) control plane because no endpoint exposes the needed metrics for etcd, scheduler and controller manager.
- To instrument Rancher control plane, since components
/metrics
are not always reachable by default and can't be autodiscovered, some extra configuration is needed.