Home

Awesome

<a href="https://opensource.newrelic.com/oss-category/#community-plus"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Plus.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"><img alt="New Relic Open Source community plus project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"></picture></a>

New Relic's Helm charts repository

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.

<!-- vscode-markdown-toc --> <!-- vscode-markdown-toc-config numbering=true autoSave=true /vscode-markdown-toc-config --> <!-- /vscode-markdown-toc -->

<a name='Prerequisites'></a>Prerequisites

<a name='Installthecharts'></a>Install

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: true

Add the official repository:

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

Then, run helm 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 the nri-bundle's README. There you can find also links to the values of all the subcharts.

<a name='Examples'></a>Examples

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

<a name='Upgrading'></a>Upgrading to the new version of KSM

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

<a name='Development'></a>Development

You can use the Helm 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, run helm install dev-chart charts/<YOUR_CHART>
  4. Verify that the chart works as expected.
  5. Remove the installed chart with helm uninstall dev-chart.
  6. Create your pull request and follow the instructions below.

Feel free to add different values to the chart.

<a name='Automatedversionbumps'></a>Automated version bumps

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.

<a name='Testing'></a>Testing

See chart testing

<a name='Contributing'></a>Contributing

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.

<a name='Support'></a>Support

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

<a name='IssuesEnhancementRequests'></a>Issues / Enhancement Requests

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.

<a name='Troubleshoot'></a>Troubleshoot

<a name='TroubleshootCannotLoadRepos'></a>Getting "Couldn't load repositories file" (Helm 2)

You need to initialize Helm with:

helm init

<a name='License'></a>License

The project is released under version 2.0 of the Apache license.