Skip to content

Latest commit

 

History

History
106 lines (70 loc) · 5.14 KB

README.md

File metadata and controls

106 lines (70 loc) · 5.14 KB
Raw

New Relic Open Source experimental project banner.

newrelic-agent-operator

The newrelic-agent-operator is an implementation of the Opentelemetry Operator that auto-instruments containerized workloads in Kubernetes with New Relic APM agents.

Documentation

Prerequisites

Currently, the New Relic Agent Operator requires Cert Manager to be installed in your cluster.

Helm Charts

You can install the New Relic Agent Operator via Helm from the newrelic-agent-operator repository. Visit the installation docs for more info.

helm repo add newrelic-agent-operator https://newrelic-experimental.github.io/newrelic-agent-operator
helm upgrade --install newrelic-agent-operator newrelic-agent-operator/newrelic-agent-operator --set licenseKey='<NEW RELIC INGEST LICENSE KEY>' -n newrelic

Building

  1. Build and push your image to the location specified by IMG:
make container container-push  IMG=<some-registry>/newrelic-agent-operator:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/newrelic-agent-operator:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

Undeploy the controller from the cluster:

make undeploy

Test It Out

  1. Install the CRDs into the cluster:
make install
  1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

Things to consider

  • Currently, newrelic-agent-operator supports instrumentation for Python, Java, Node.js and .NET.
  • cert-manager is required to be presented on cluster before starting newrelic-agent-operator

Support

New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. If you're running into a problem, please raise an issue on this repository and we will try to help you ASAP. Please bear in mind this is an open source project and hence it isn't directly supported by New Relic.

Contributing

We encourage your contributions to improve newrelic-agent-operator . Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at [email protected].

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.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.