Skip to content

Commit 1321611

Browse files
committed
wip: add documentation about the TA CRD
1 parent cc72bdd commit 1321611

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -600,6 +600,8 @@ For more information about multi-instrumentation feature capabilities please see
600600

601601
### Target Allocator
602602

603+
TODO: Add information about TargetAllocator CRD
604+
603605
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:
604606

605607
```yaml

cmd/otel-allocator/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ The easiest way to do this is to grab a copy of the individual [`PodMonitor`](ht
8686
> ✨ 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).
8787
8888
# Usage
89+
90+
TODO: Add information about TargetAllocator CRD
91+
8992
The `spec.targetAllocator:` controls the TargetAllocator general properties. Full API spec can be found here: [api.md#opentelemetrycollectorspectargetallocator](../../docs/api.md#opentelemetrycollectorspectargetallocator)
9093

9194
A basic example that deploys.

docs/crd-changelog.md

+4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
This document explains major changes made in new CRD versions. It is intended to help users migrate and take
44
advantage of the new features.
55

6+
## TargetAllocator.opentelemetry.io/v1alpha1
7+
8+
TODO
9+
610
## OpenTelemetryCollector.opentelemetry.io/v1beta1
711

812
### Migration

0 commit comments

Comments
 (0)