Skip to content

Commit 5e612b2

Browse files
committed
Fix open-telemetry#6237: Update broken links to OpenTelemetry Operator API docs - Needs test and htmltest.yml also needs to be changed to not ignore links anymore
1 parent cd90ab7 commit 5e612b2

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

content-modules/community

Submodule community updated 104 files

content/en/blog/2023/end-user-q-and-a-04.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ generated? One of a bunch of things."
326326
### Kubernetes modes on OTel
327327

328328
The OTel Operator supports four
329-
[deployment modes](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollectorspec)
329+
[deployment modes](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1beta1/opentelemetrycollector_types.go#L184-L189)
330330
for the OTel Collector in Kubernetes:
331331

332332
- [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) -

content/en/blog/2024/otel-operator-q-and-a/index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ easier. It does the following:
2424
[custom resource (CR)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
2525
- Manages the configuration of a fleet of OpenTelemetry Collectors via
2626
[OpAMP](/docs/specs/opamp/) integration, supported by the
27-
[`OpAMPBridge`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opampbridge)
27+
[`OpAMPBridge`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1alpha1/opampbridge_types.go)
2828
custom resource.
2929
- Provides
3030
[integration with the Prometheus Operator's `PodMonitor` and `ServiceMonitor` CRs](https://github.com/open-telemetry/opentelemetry-operator/tree/main/cmd/otel-allocator).
@@ -55,7 +55,7 @@ Longer answer: OTel Collector can be fed more than one Collector config YAML
5555
file. That way, you can keep your base configurations in, say,
5656
`otelcol-config.yaml`, and overrides or additions to the base configuration can
5757
go in, for example, `otelcol-config-extras.yaml`. See an example of this in the
58-
[OTel Demos Docker compose file](https://github.com/open-telemetry/opentelemetry-demo/blob/06f020c97f78ae9625d3a4a5d1107c55045c567f/docker-compose.yml#L665-L668).
58+
[OTel Demo's Docker compose file](https://github.com/open-telemetry/opentelemetry-demo/blob/06f020c97f78ae9625d3a4a5d1107c55045c567f/docker-compose.yml#L665-L668).
5959

6060
Unfortunately, while the OTel Collector supports multiple Collector
6161
configuration files, the Collector managed by the OTel Operator does not.
@@ -202,7 +202,7 @@ to authenticate against that private registry. For more info on how to use
202202
[the instructions](https://github.com/open-telemetry/opentelemetry-operator?tab=readme-ov-file#using-imagepullsecrets).
203203

204204
For more info, check out the
205-
[OpenTelemetryCollector CR API docs](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollector).
205+
[OpenTelemetryCollector CR API docs](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1beta1/opentelemetrycollector_types.go).
206206

207207
### Q5: Does the Target Allocator work for all deployment types?
208208

@@ -240,7 +240,7 @@ kubectl --context kind-otel-target-allocator-talk apply -f https://raw.githubuse
240240
```
241241

242242
See my
243-
[example of the OpenTelemetry Operators Target Allocator with `ServiceMonitor`](https://github.com/avillela/otel-target-allocator-talk/tree/main?tab=readme-ov-file#3b--kubernetes-deployment-servicenow-cloud-observability-backend).
243+
[example of the OpenTelemetry Operator's Target Allocator with `ServiceMonitor`](https://github.com/avillela/otel-target-allocator-talk/tree/main?tab=readme-ov-file#3b--kubernetes-deployment-servicenow-cloud-observability-backend).
244244

245245
### Q7: Do I need to create a service account to use the Target Allocator?
246246

@@ -279,7 +279,7 @@ Just like you can override the Collector base image in the
279279
image.
280280

281281
Please keep in mind that
282-
[its usually best to keep the Target Allocator and OTel operator versions the same](https://cloud-native.slack.com/archives/C033BJ8BASU/p1709128862949249?thread_ts=1709081221.484429&cid=C033BJ8BASU),
282+
[it's usually best to keep the Target Allocator and OTel operator versions the same](https://cloud-native.slack.com/archives/C033BJ8BASU/p1709128862949249?thread_ts=1709081221.484429&cid=C033BJ8BASU),
283283
to avoid any compatibility issues. If do you choose to override the Target
284284
Allocator’s base image, you can do so by adding `spec.targetAllocator.image` in
285285
the `OpenTelemetryCollector` CR. You can also specify the number of replicas by
@@ -322,7 +322,7 @@ yourself (see
322322
[Q7](#q7-do-i-need-to-create-a-service-account-to-use-the-target-allocator)).
323323

324324
For more info, check out the
325-
[Target Allocator API docs](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollectorspectargetallocator).
325+
[Target Allocator API docs](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1beta1/opentelemetrycollector_types.go#L239-L249).
326326

327327
### Q10: Is there a version lag between the OTel Operator auto-instrumentation and auto-instrumentation of supported languages?
328328

content/en/docs/platforms/kubernetes/operator/automatic.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ component. If you chose not to use a Collector, you can skip to the next
4444
section.
4545

4646
The Operator provides a
47-
[Custom Resource Definition (CRD) for the OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollector)
47+
[Custom Resource Definition (CRD) for the OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1beta1/opentelemetrycollector_types.go)
4848
which is used to create an instance of the Collector that the Operator manages.
4949
The following example deploys the Collector as a deployment (the default), but
5050
there are other
@@ -109,7 +109,7 @@ an endpoint for auto-instrumentation in your pods.
109109
To be able to manage automatic instrumentation, the Operator needs to be
110110
configured to know what pods to instrument and which automatic instrumentation
111111
to use for those pods. This is done via the
112-
[Instrumentation CRD](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#instrumentation).
112+
[Instrumentation CRD](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1alpha1/instrumentation_types.go).
113113

114114
Creating the Instrumentation resource correctly is paramount to getting
115115
auto-instrumentation working. Making sure all endpoints and env vars are correct

content/en/docs/platforms/kubernetes/operator/troubleshooting/target-allocator.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -333,10 +333,10 @@ If you configured a
333333
[`ServiceMonitor`](https://observability.thomasriley.co.uk/prometheus/configuring-prometheus/using-service-monitors/)
334334
selector, it means that the Target Allocator only looks for `ServiceMonitors`
335335
having a `metadata.label` that matches the value in
336-
[`serviceMonitorSelector`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollectorspectargetallocatorprometheuscr-1).
336+
[`serviceMonitorSelector`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1beta1/opentelemetrycollector_types.go#L102-L105).
337337

338338
Suppose that you configured a
339-
[`serviceMonitorSelector`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollectorspectargetallocatorprometheuscr-1)
339+
[`serviceMonitorSelector`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1beta1/opentelemetrycollector_types.go#L102-L105)
340340
for your Target Allocator, like in the following example:
341341

342342
```yaml
@@ -386,8 +386,8 @@ Allocator will fail to discover scrape targets from that `ServiceMonitor`.
386386

387387
{{% alert title="Tip" %}}
388388

389-
The same applies if youre using a [PodMonitor]. In that case, you would use a
390-
[`podMonitorSelector`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollectorspectargetallocatorprometheuscr)
389+
The same applies if you're using a [PodMonitor]. In that case, you would use a
390+
[`podMonitorSelector`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1beta1/opentelemetrycollector_types.go#L106-L109)
391391
instead of a `serviceMonitorSelector`.
392392

393393
{{% /alert %}}
@@ -401,7 +401,7 @@ results in the Target Allocator failing to discover scrape targets from your
401401
`ServiceMonitors` and `PodMonitors`, respectively.
402402

403403
Similarly, in
404-
[`v1beta1`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollector-1)
404+
[`v1beta1`](https://github.com/open-telemetry/opentelemetry-operator/blob/main/apis/v1beta1/opentelemetrycollector_types.go)
405405
of the `OpenTelemetryCollector` CR, leaving out this configuration altogether
406406
also results in the Target Allocator failing to discover scrape targets from
407407
your `ServiceMonitors` and `PodMonitors`.

0 commit comments

Comments
 (0)