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.
- Helm CLI (install instructions)
- New Relic account
You can have all the information about the installation in the New Relic Documentation page for installaing the Kubernetes integration using Helm
Just as a glance of the process of installation and configuration the process involves to create a values.yaml that will look like this:
global:
licenseKey: YOUR_LICENSE_KEY
cluster: YOUR_CLUSTER_NAME
nri-kube-events:
enabled: true
nri-metadata-injection:
enabled: true
nri-prometheus:
enabled: true
newrelic-logging:
enabled: true
k8s-agents-operator:
enabled: true
kube-state-metrics:
enabled: trueAdd the official repository:
helm repo add newrelic https://helm-charts.newrelic.comThen, run helm upgrade:
helm upgrade --install newrelic-bundle newrelic/nri-bundle -f your-custom-values.yamlYou can find a list of all the global values in the nri-bundle's README. There you can find also links
to the values of all the subcharts.
The following example installs the nri-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 the New Relic Documentation page for Kubernetes Compatibility and Requirements
You can use the Helm CLI to develop a chart and add it to this repository.
- Clone this repository on your local machine.
- Add or modify the files for the desired chart.
- To install the chart locally, run
helm install dev-chart charts/<YOUR_CHART> - Verify that the chart works as expected.
- Remove the installed chart with
helm uninstall dev-chart. - Create your pull request and follow the instructions below.
Feel free to add different values to the chart.
This repository uses Renovate to automatically bump dependencies. It currently supports updating dependencies on nri-bundle whenever an individual chart gets released.
Unfortunately, renovate does not support yet updating appVersion, nor image.tag entries in values.yaml.
See chart testing
See our Contributing docs and our review guidelines
A note about vulnerabilities
As noted in our security 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 through HackerOne.
If you would like to contribute to this project, review these 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 our Technical Support Offerings.
Issues and enhancement requests can be submitted in the Issues 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 initThe project is released under version 2.0 of the Apache license.