Skip to content

Commit

Permalink
wip: add documentation about the TA CRD
Browse files Browse the repository at this point in the history
  • Loading branch information
swiatekm committed Nov 7, 2024
1 parent bf91413 commit 9b78ffa
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,8 @@ For more information about multi-instrumentation feature capabilities please see

### Target Allocator

TODO: Add information about TargetAllocator CRD

The OpenTelemetry Operator comes with an optional component, the [Target Allocator](/cmd/otel-allocator/README.md) (TA). When creating an OpenTelemetryCollector Custom Resource (CR) and setting the TA as enabled, the Operator will create a new deployment and service to serve specific `http_sd_config` directives for each Collector pod as part of that CR. It will also rewrite the Prometheus receiver configuration in the CR, so that it uses the deployed target allocator. The following example shows how to get started with the Target Allocator:

```yaml
Expand Down
3 changes: 3 additions & 0 deletions cmd/otel-allocator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ The easiest way to do this is to grab a copy of the individual [`PodMonitor`](ht
> ✨ For more information on configuring the `PodMonitor` and `ServiceMonitor`, check out the [PodMonitor API](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PodMonitor) and the [ServiceMonitor API](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ServiceMonitor).
# Usage

TODO: Add information about TargetAllocator CRD

The `spec.targetAllocator:` controls the TargetAllocator general properties. Full API spec can be found here: [api.md#opentelemetrycollectorspectargetallocator](../../docs/api.md#opentelemetrycollectorspectargetallocator)

A basic example that deploys.
Expand Down
4 changes: 4 additions & 0 deletions docs/crd-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
This document explains major changes made in new CRD versions. It is intended to help users migrate and take
advantage of the new features.

## TargetAllocator.opentelemetry.io/v1alpha1

TODO

## OpenTelemetryCollector.opentelemetry.io/v1beta1

### Migration
Expand Down

0 comments on commit 9b78ffa

Please sign in to comment.