README
¶
K8s Agents Operator 
This project auto-instruments containerized workloads in Kubernetes with New Relic agents.
Table Of Contents
Installation
For instructions on how to install the Helm chart, read the chart's README
Development
We use Minikube and Tilt to spawn a local environment that it will reload after any changes inside the charts or the integration code.
Make sure you have these tools or install them:
Start the local environment:
ctlptl create registry ctlptl-registry --port=5005
ctlptl create cluster minikube --registry=ctlptl-registry
tilt up
Support
New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
- 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
Contribute
We encourage your contributions to improve K8s Agents Operator! Keep in mind that 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 (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.
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.
License
K8s Agents Operator is licensed under the Apache 2.0 License.
Directories
¶
| Path | Synopsis |
|---|---|
|
api/v1alpha2
Package v1alpha2 contains API Schema definitions for the v1alpha2 API group +kubebuilder:object:generate=true +groupName=newrelic.com
|
Package v1alpha2 contains API Schema definitions for the v1alpha2 API group +kubebuilder:object:generate=true +groupName=newrelic.com |
|
autodetect
Package autodetect is for auto-detecting traits from the environment (platform, APIs, ...).
|
Package autodetect is for auto-detecting traits from the environment (platform, APIs, ...). |
|
internal/config
Package config contains the operator's runtime configuration.
|
Package config contains the operator's runtime configuration. |
|
internal/version
Package version contains the operator's version, as well as versions of underlying components.
|
Package version contains the operator's version, as well as versions of underlying components. |
|
internal/webhookhandler
Package webhookhandler contains the webhook that injects sidecars into pods.
|
Package webhookhandler contains the webhook that injects sidecars into pods. |