Repository files navigation

This is the official Helm charts repository for New Relic. It is indexed at [Helm Hub][helm-hub], where you can find the list of available charts and their documentation.

• Prerequisites
• Install
• Development
• Testing
• Contributing
• Support
• License

• Helm CLI (install instructions)
• New Relic account

You can have all the information about the installation in theNew Relic Documentation page for installing the Kubernetes integrationusing Helm

Just as a glance of the process of installation and configuration the process involves to create avalues.yaml that will look like this:

global:licenseKey:YOUR_LICENSE_KEYcluster:YOUR_CLUSTER_NAMEnri-kube-events:enabled:truenri-metadata-injection:enabled:truenri-prometheus:enabled:truenewrelic-logging:enabled:truek8s-agents-operator:enabled:truekube-state-metrics:enabled:true

Add the official repository:

helm repo add newrelic https://helm-charts.newrelic.com

Then, runhelm upgrade:

helm upgrade --install newrelic-bundle newrelic/nri-bundle -f your-custom-values.yaml

You can find a list of all the global values in thenri-bundle's README. There you can find also linksto the values of all the subcharts.

The following example installs thenri-bundle chart, which groups multiple New Relic charts into one.nri-bundle contains:

• New Relic's Kubernetes integration
• New Relic's Kubernetes plugin for logs
• New Relic's Prometheus OpenMetrics integration
• Metadata injection webhook
• Kube state metrics

You can find additional information on how to upgrade to the new version of KSM in theNew Relic Documentation page for Kubernetes Compatibility and Requirements

You can use theHelm CLI to develop a chart and add it to this repository.

1. Clone this repository on your local machine.
2. Add or modify the files for the desired chart.
3. To install the chart locally, runhelm install dev-chart charts/<YOUR_CHART>
4. Verify that the chart works as expected.
5. Remove the installed chart withhelm uninstall dev-chart.
6. Create your pull request and follow the instructions below.

Feel free to add different values to the chart.

This repository usesRenovate to automatically bump dependencies. It currently supports updating dependencies onnri-bundle whenever an individual chart gets released.

Unfortunately, renovate does not support yet updatingappVersion, norimage.tag entries invalues.yaml.

Seechart testing

Seeour Contributing docs and ourreview guidelines

A note about vulnerabilities

As noted in oursecurity policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic throughHackerOne.

If you would like to contribute to this project, reviewthese guidelines.

To all contributors, we thank you! Without your contribution, this project would not be what it is today.

Should you need assistance with New Relic products, you are in good hands with several support diagnostic tools and support channels.

If the issue has been confirmed as a bug or is a feature request, file a GitHub issue.

Support Channels

• New Relic Documentation: Comprehensive guidance for using our platform
• New Relic Community: The best place to engage in troubleshooting questions
• New Relic Developer: Resources for building a custom observability applications
• New Relic University: A range of online training for New Relic users of every level
• New Relic Technical Support 24/7/365 ticketed support. Read more about ourTechnical Support Offerings.

Issues and enhancement requests can be submitted in theIssues tab of this repository. Please search for and review the existing open issues before submitting a new issue.

You need to initialize Helm with:

helm init

The project is released under version 2.0 of theApache license. The individual charts within this project are also released under the Apache 2.0 license, unless there is a separate LICENSE file in the chart directory. These charts are used to install software, some of which is proprietary, pre-release, or otherwise restricted. Please check the project and dependency repositories for more information.