• English日本語한국어
  • Log inStart now

Get started with Kubernetes

The New Relic Kubernetes integration gives you full observability into the health and performance of your environment by leveraging the New Relic infrastructure agent. This agent collects telemetry data from your cluster using several New Relic integrations such as the Kubernetes events integration, the Prometheus Agent, and the New Relic Logs Kubernetes plugin.

To install our Kubernetes integration, we recommend that you follow the instructions here for our guided install. We recommend this interactive installation tool for servers, VMs, and unprivileged environments.

Ways to integrate

Integration

When to use

Install

Guided install (recommended)

Guided install guides you through the integration process with either a Helm command with the required values filled, or a plain manifest if you don't want to use Helm. It gives you control over which features are enabled and which data is collected.

It also offers a quickstart option that includes some optional, pre-built resources such as dashboards and alerts alongside the Kubernetes integration so that you can gain instant visibility into your Kubernetes clusters.

Manual Windows install

When you have a Windows-based Kubernetes system. Note that there are various limitations to the Windows integration.

See our Windows install docs:

Windows install

Manual Helm install

This option is not recommended, as the guided install will prompt for some configuration options and autopopulate secrets and values for you. Additionally, our guided install also allows installing our integration as plain manifests rather than a Helm release.

See our manual Helm install docs:

Manual EKS Fargate install

When monitoring Kubernetes workloads on EKS Fargate. This integration automatically injects a sidecar containing the infrastructure agent and the nri-kubernetes integration in each pod that needs to be monitored.

New Relic operator

Kubernetes operators help manage these complex applications by abstracting those Kubernetes resources into a set of custom configurations, or custom resources.

This reduces the burden on you as a user, as you would only need to interface with the custom resources to manage the application. You can then rely on the operator to deploy, upgrade, and manage the application for you.

Follow the instructions in the operator doc and refer back to this doc as needed.

The remainder of this doc will cover the guided install process.

Guided install

Take a look at the following to make sure you're ready:

  • If custom manifests have been used instead of Helm, you will need to first remove the old installation using kubectl delete -f previous-manifest-file.yml, and then proceed through the guided installer again. This will generate an updated set of manifests that can be deployed using kubectl apply -f manifest-file.yml.
  • Make sure you're using the supported Kubernetes versions and make sure to check out the preliminary notes for your managed services or platforms on our compatibility and requirements page.
  • Make sure you have New Relic . You can set up an account that's freeno credit card required.
  • Make sure the newrelic dockerhub (https://hub.docker.com/u/newrelic) and Google's registry (registry.k8s.io) domains are added to your allow list. This is where the installation will pull container images from. Note, you may need to follow the commands to identify the additional Google registry domains to be added to your white list, because registry.k8s.io typically redirects to your local registry domain (e.g., asia-northeast1-docker.pkg.dev) based on your region.

If you're installing our integration on a managed cloud, please take a look at these preliminary notes before proceeding:

Navigating the Kubernetes integration guided install

Once you start the guided install, use the following information to help you make decisions about the configurations.

Tip

The steps that follow skip the preliminary steps for the quickstart. If you chose the guided install with the quickstart, just click through the pages Confirm your Kubernetes quickstart installation and Installation plan to reach the main guided install pages described below.

Step 1 of 3

On the page Configure the Kubernetes Integration complete the following fields:

Field

Description

We'll send your data to this account

Choose the New Relic account that you want your Kubernetes data written to.

Cluster name

Cluster name is the name we will use to tag your Kubernetes data with so that you can filter for the data specific to the cluster you're installing this integration in. This is important if you choose to connect multiple clusters to your New Relic account so choose a name that you'll recognize.

Namespace for the integration

Namespace for the integration is the namespace we will use to house the Kubernetes integration in your cluster. We recommend using the default namespace of newrelic.

Step 2 of 3

On the page Select the additional data you want to gather, choose the options that are right for you:

Scrape Prometheus endpoints

By selecting this option, we will install Prometheus in agent mode to collect metrics from the Prometheus endpoints exposed in your cluster. Expand the collapsers to see details about each option:

Gather log data

Enable service-level insights, full-body requests, and application profiles through Pixie

Pixie is an open source observability tool for Kubernetes applications that uses eBPF to automatically collect telemetry data. If you don't have Pixie installed on your cluster, but want to leverage Pixie's powerful telemetry data collection and visualization on the New Relic platform, check Enable service-level insights, full-body requests, and application profiles through Pixie.

If you're already using Community Cloud, select Community Cloud hosted Pixie is already running on this cluster. Keep the following in mind about the different ways Pixie can be hosted. New Relic provides a different level of integration support for each Pixie hosting option.

Step 3 of 3

Finalize the Kubernetes installation setup by choosing one of the following installation methods in the last step of the guided install:

  • Guided Install (recommended): This option will automatically download and use the newrelic-cli CLI to install and configure the Kubernetes integration.
  • Helm 3: Use this option if you prefer using Helm to install and configure the Kubernetes integration. This option installs the nri-bundle Helm chart, which you can further configure with the options described here. This is also where you can enable the New Relic operator.
  • Manifest: Select this option if you prefer generating a Kubernetes manifest in YAML format and manually installing it with kubectl.

Use your Kubernetes data

Learn more about:

Did this doc help with your installation?

Copyright © 2023 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.