Skip to content

Commit

Permalink
style(K8s): Added TW updates
Browse files Browse the repository at this point in the history
  • Loading branch information
nbaenam committed Jun 1, 2023
1 parent bd436bc commit c0bf316
Show file tree
Hide file tree
Showing 5 changed files with 111 additions and 106 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,13 @@ New Relic has several Helm charts for the different components which offer diffe
* [`nri-metadata-injection`](https://github.com/newrelic/k8s-metadata-injection/tree/main/charts/nri-metadata-injection): Sets up a minimal `MutatingAdmissionWebhook` that injects a couple of environment variables in the containers. These contain metadata about the cluster and New Relic installation and will be later picked up by applications instrumented using APM, allowing to [correlate APM and infrastructure data](/docs/integrations/kubernetes-integration/link-your-applications/link-your-applications-kubernetes/).
* [`nri-statsd`](https://github.com/newrelic/helm-charts/tree/master/charts/nri-statsd): New Relic StatsD integration.

For convenience, New Relic provides the [`nri-bundle`](https://github.com/newrelic/helm-charts/tree/master/charts/nri-bundle) chart, which acts as a wrapper or a meta-package for the individual charts mentioned above. While it's possible to install them separately, we strongly recommend doing so using the [`nri-bundle`](https://github.com/newrelic/helm-charts/tree/master/charts/nri-bundle) instead, because:
Although you can install these components separately, we strongly recommend you use the [`nri-bundle`](https://github.com/newrelic/helm-charts/tree/master/charts/nri-bundle) chart. New Relic provides this chart, which acts as a wrapper or a meta-package for the individual charts mentioned above. The use of this chart enables you these advantages:

- It provides full control over which components are installed.
- It ensures that their installed versions are compatible with each other.
- It ensures that their configuration values are consistent across the installed charts.
- You can still configure each component individually as a [Helm dependency](https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#overriding-values-from-a-parent-chart), using the configuration parameters mentioned [here](#configure).

If you decide to install the components separately, you can configure each component individually as a [Helm dependency](https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#overriding-values-from-a-parent-chart), using the configuration parameters mentioned [here](#configure).

The `nri-bundle` chart is the one that is installed and configured by our [Kubernetes guided install](/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-integration-install-configure#guided-install).

Expand Down Expand Up @@ -122,13 +124,13 @@ The `nri-bundle` chart is the one that is installed and configured by our [Kuber
Please notice and adjust the following flags:

* `global.licenseKey=YOUR_NEW_RELIC_LICENSE_KEY`: Must be set to a valid <InlinePopover type="licenseKey" /> for your account.
* `global.cluster=K8S_CLUSTER_NAME`: Is used to identify the cluster in the New Relic UI, so should be a descriptive value not used by any other Kubernetes cluster configured in your New Relic account.
* `kube-state-metrics.enabled=true`: Setting this to `true` will automatically install Kube State Metrics (KSM) for you, which is required for our integration to run. You can set this to false if KSM is already present in your cluster, even if it is on a different namespace.
* `global.cluster=K8S_CLUSTER_NAME`: It's used to identify the cluster in the New Relic UI, so should be a descriptive value not used by any other Kubernetes cluster configured in your New Relic account.
* `kube-state-metrics.enabled=true`: Setting this to `true` will automatically install Kube State Metrics (KSM) for you, which is required for our integration to run. You can set this to false if KSM is already present in your cluster, even if it's on a different namespace.
* `newrelic-prometheus-agent.enabled=true`: Will deploy our Prometheus Agent, which automatically collects data from Prometheus endpoints present in the cluster.
* `nri-metadata-injection.enabled=true`: Will install our minimal webhook, which adds environment variables that, in turn, allows [linking applications instrumented with New Relic APM to Kubernetes](/docs/kubernetes-pixie/kubernetes-integration/link-your-applications/link-your-applications-kubernetes).


Our Kubernetes charts have a comprehensive set of flags and tunables that can be edited to better fit your particular needs. Please check the [Configure the integration](#configure) section below to see what can be changed.
Our Kubernetes charts have a comprehensive set of flags and tunables that can be edited to better fit your particular needs. Please, check the [Configure the integration](#configure) section below to see what can be changed.

5. Install the Kubernetes integration by running the command without `--debug` and `--dry-run`:

Expand All @@ -141,7 +143,7 @@ The `nri-bundle` chart is the one that is installed and configured by our [Kuber
<Callout variant="important">
Make sure you're using Kubernetes version 1.26.x or [a lower version that we support](/docs/kubernetes-pixie/kubernetes-integration/get-started/kubernetes-integration-compatibility-requirements).

Kubernetes 1.27.x is currently in an experimental release phase. If you find any issues, please contact support @ newrelic.com.
Kubernetes 1.27.x is currently in an experimental release phase. If you find any issues, please [contact support](https://support.newrelic.com).
</Callout>
6. Check that pods are being deployed and reach a stable state:

Expand All @@ -168,7 +170,7 @@ You should see:
title="Installation instructions for Helm 2"
>
<Callout variant="important">
The last version the `nri-bundle` chart supporting Helm 2 is `3.2.11`. Please upgrade to Helm 3 to install the latest version. We will be removing support for Helm 2 installations soon.
The last version the `nri-bundle` chart supporting Helm 2 is `3.2.11`. Please, upgrade to Helm 3 to install the latest version. We will be removing support for Helm 2 installations soon.
</Callout>

To install using Helm 2:
Expand Down

0 comments on commit c0bf316

Please sign in to comment.