OpenTelemetry Operator

A Carvel package for OpenTelemetry Operator, which manages collectors and auto-instrumentation of the workload using OpenTelemetry instrumentation libraries.

🚀  Getting Started

Prerequisites

• Kubernetes 1.34+

• Carvel kctrl CLI.

• Carvel kapp-controller deployed in your Kubernetes cluster. You can install it with Carvel kapp (recommended choice) or kubectl.

  kapp deploy -a kapp-controller -y \
    -f https://github.com/carvel-dev/kapp-controller/releases/latest/download/release.yml

Dependencies

OpenTelemetry Operator requires the following packages included in the Kadras Engineering Platform and available to install from the Kadras package repository:

• cert-manager.

Installation

Add the Kadras package repository to your Kubernetes cluster:

kctrl package repository add -r kadras-packages \
  --url ghcr.io/kadras-io/kadras-packages \
  -n kadras-system --create-namespace

Installation without package repository

The recommended way of installing the OpenTelemetry Operator package is via the Kadras package repository. If you prefer not using the repository, you can add the package definition directly using kapp or kubectl.

kubectl create namespace kadras-system
kapp deploy -a opentelemetry-collector-package -n kadras-system -y \
  -f https://github.com/kadras-io/package-for-opentelemetry-operator/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/package-for-opentelemetry-operator/releases/latest/download/package.yml

Install the OpenTelemetry Operator package:

kctrl package install -i opentelemetry-collector \
  -p opentelemetry-collector.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-system

Note You can find the ${VERSION} value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.

kctrl package available list -p opentelemetry-collector.packages.kadras.io -n kadras-system

Verify the installed packages and their status:

kctrl package installed list -n kadras-system

📙  Documentation

Documentation, tutorials and examples for this package are available in the docs folder. For documentation specific to OpenTelemetry Operator, check out opentelemetry.io.

🛡️  Security

The security process for reporting vulnerabilities is described in SECURITY.md.

🖊️  License

This project is licensed under the Apache License 2.0. See LICENSE for more information.