Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IA] Link normalization step for platforms #6232

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
# TODO move into content/en/blog/2023/contributing-to-otel/index.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
- ^https://shorturl.at/vLYZ0$

# Temporary during IA rework
# https://github.com/open-telemetry/opentelemetry.io/issues/6222
- (^/docs|..)/(faas|kubernetes)\b
- ^../lambda-collector/ # zh/docs/faas/lambda-manual-instrument/index.html
- ^../../(helm|operator)\b # es/docs/kubernetes/collector/components/index.html
# Temporary until semconv is updated to 1.30.0+
- ^https://cloud.google.com/apis/design/resource_names#full_resource_name
- ^https://cloud.google.com/functions/docs/concepts/exec#function_scope_versus_global_scope
- ^https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902
- ^https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest
2 changes: 1 addition & 1 deletion content/en/blog/2022/k8s-metadata/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ cSpell:ignore: k8sattributes k8sattributesprocessor k8sprocessor KUBE replicaset

{{% alert title="Note" color="info" %}} The most up to date information for how
to enhance telemetry with Kubernetes metadata can be found in the docs. See
[Getting Started with Kubernetes](/docs/kubernetes/getting-started/) for more
[Getting Started with Kubernetes](/docs/platforms/kubernetes/getting-started/) for more
info. {{% /alert %}}

Attaching Kubernetes resource metadata to OpenTelemetry traces is useful to
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2022/k8s-otel-expose/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ in this setup are mentioned in brackets.
[v1.2.1] installed.
- A Kubernetes [v1.23.3] edge cluster to create a test cluster. Using
[Kind](https://kind.sigs.k8s.io/) is recommended.
- Installed [OpenTelemetry Operator](/docs/kubernetes/operator/) [v0.58.0] on
- Installed [OpenTelemetry Operator](/docs/platforms/kubernetes/operator/) [v0.58.0] on
both ends.
- Installed [Jaeger Operator](https://www.jaegertracing.io/docs/1.37/operator/)
[v1.37.0] on your public cluster.
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2023/contributing-to-otel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Feeling a little more adventurous? Then why not join one of the other OTel
(SIGs)? By joining a SIG, you can contribute to things like (but not limited to)
SDK development, auto-instrumentation of libraries, the
[OTel Collector](/docs/collector/), and the
[OTel Operator](/docs/kubernetes/operator/). You don't even need to be a regular
[OTel Operator](/docs/platforms/kubernetes/operator/). You don't even need to be a regular
contributor. Sometimes, contributions come out of necessity. Like maybe you
found a bug in the Collector. Why not take a stab at fixing it? Or maybe there's
a feature that you and your team desperately need. Again, why not take a stab at
Expand Down
6 changes: 3 additions & 3 deletions content/en/blog/2023/end-user-q-and-a-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,9 @@ others are still instrumented using the [legacy OpenTracing
[using shims](/docs/migration/opentracing/).

The OpenTelemetry Operator is being implemented to auto-instrument Java and .NET
code. Among other things, the [OTel Operator](/docs/kubernetes/operator/)
code. Among other things, the [OTel Operator](/docs/platforms/kubernetes/operator/)
supports injecting and
[configuring auto-instrumentation](/docs/kubernetes/operator/automatic/#configure-automatic-instrumentation)
[configuring auto-instrumentation](/docs/platforms/kubernetes/operator/automatic/#configure-automatic-instrumentation)
in .NET, Java, Python, and Node.js. Iris hopes that Go auto-instrumentation will
be available in the near-future. To track progress of auto-instrumentation in
Go, see
Expand Down Expand Up @@ -255,7 +255,7 @@ would be a bottleneck in terms of load and single point of failure. The team
currently has one
[OpenTelemetry Collector agent](/docs/collector/deployment/agent/) per
Kubernetes cluster. The end goal is to replace those agents with the
[OTel Operator](/docs/kubernetes/operator/) instead, which allows you to deploy
[OTel Operator](/docs/platforms/kubernetes/operator/) instead, which allows you to deploy
and configure the OTel Collector and inject and configure auto-instrumentation.

Everything is then sent to a central OTel Collector (i.e. an
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2023/lambda-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ cSpell:ignore: adot otel-faas socha
The
[Functions-as-a-Service (FaaS) SIG](https://docs.google.com/document/d/187XYoQcXQ9JxS_5v2wvZ0NEysaJ02xoOYNXj08pT0zc)
is incredibly excited to announce that the release of OpenTelemetry Lambda
layers, and associated [documentation](/docs/faas/) on how to monitor Amazon Web
layers, and associated [documentation](/docs/platforms/faas/) on how to monitor Amazon Web
Services (AWS) Lambdas.

## OTel FaaS repackaged
Expand Down Expand Up @@ -42,7 +42,7 @@ The FaaS SIG has addressed the above-mentioned shortcomings:
Collector alongside auto-instrumentation layers for JavaScript, Java, and
Python.
- Added official community Lambda documentation to the OTel website under the
new [FaaS section](/docs/faas/).
new [FaaS section](/docs/platforms/faas/).

## What next

Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2023/opamp-status/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ with a backlog of issues created to guide further development.
## OpAMP in Kubernetes

In OTel we have dedicated support for Kubernetes as a compute platform via the
[OpenTelemetry Operator for Kubernetes](/docs/kubernetes/operator/). In this
[OpenTelemetry Operator for Kubernetes](/docs/platforms/kubernetes/operator/). In this
context, we're also working on OpAMP support in Kubernetes which will be
available through a
[bridge component](https://docs.google.com/document/d/1M8VLNe_sv1MIfu5bUR5OV_vrMBnAI7IJN-7-IAr37JY/)
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2024/prom-and-otel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -607,7 +607,7 @@ There are a few more Collector components you can implement to monitor
Kubernetes, including Kubernetes-specific ones as well as general-use
processors, such as the batch, memory limiter, and resource processors. To learn
more, see
[Important Components for Kubernetes](/docs/kubernetes/collector/components/).
[Important Components for Kubernetes](/docs/platforms/kubernetes/collector/components/).

After you’ve configured the components in your Collector config file, you need
to enable them within the [pipelines](/docs/collector/configuration/#pipelines)
Expand Down
7 changes: 4 additions & 3 deletions content/en/blog/2025/otel-collector-k8s-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,10 @@ So, what if, as a Collector user, you could simply enable automatic discovery
and then let your cluster users tell the Collector how their workloads should be
monitored by annotating their pods properly? That sounds awesome, and it’s not
actually something new. OpenTelemetry already supports auto-instrumentation
through the [Kubernetes operator](/docs/kubernetes/operator/automatic/),
allowing users to instrument their applications automatically just by annotating
their pods. In addition, this is a feature that other monitoring agents in the
through the
[Kubernetes operator](/docs/platforms/kubernetes/operator/automatic/), allowing
users to instrument their applications automatically just by annotating their
pods. In addition, this is a feature that other monitoring agents in the
observability industry already support, and users are familiar with it.

All this motivation led the OpenTelemetry community
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/collector/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ handling, `Service` configuration based on the OpenTelemetry configuration,
automatic sidecar injection into deployments, and more.

For guidance on how to use the Collector with Kubernetes, see
[Kubernetes Getting Started](/docs/kubernetes/getting-started/).
[Kubernetes Getting Started](/docs/platforms/kubernetes/getting-started/).

## Nomad

Expand Down Expand Up @@ -274,8 +274,8 @@ make otelcorecol

[data collection]: /docs/concepts/components/#collector
[deployment methods]: ../deployment/
[opentelemetry helm charts]: /docs/kubernetes/helm/
[opentelemetry operator]: /docs/kubernetes/operator/
[opentelemetry helm charts]: /docs/platforms/kubernetes/helm/
[opentelemetry operator]: /docs/platforms/kubernetes/operator/
[getting started with opentelemetry on hashicorp nomad]:
https://github.com/hashicorp/nomad-open-telemetry-getting-started
[releases]:
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/collector/scaling.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,9 @@ load balancer. Using a Sidecar also makes sense to avoid bringing down a crucial
component for all pods in a node when one DaemonSet pod fails.

The sidecar pattern consists in adding a container into the workload pod. The
[OpenTelemetry Operator](/docs/kubernetes/operator/) can automatically add that
for you. To accomplish that, you’ll need an OpenTelemetry Collector CR and
you’ll need to annotate your PodSpec or Pod telling the operator to inject a
[OpenTelemetry Operator](/docs/platforms/kubernetes/operator/) can automatically
add that for you. To accomplish that, you’ll need an OpenTelemetry Collector CR
and you’ll need to annotate your PodSpec or Pod telling the operator to inject a
sidecar:

```yaml
Expand Down Expand Up @@ -244,9 +244,9 @@ Collector. For instance, each Collector could be responsible for one Kubernetes
namespace or specific labels on the workloads.

Another way of scaling the Prometheus receiver is to use the
[Target Allocator](/docs/kubernetes/operator/target-allocator/): it’s an extra
binary that can be deployed as part of the OpenTelemetry Operator and will
distribute Prometheus scrape targets for a given configuration across the
[Target Allocator](/docs/platforms/kubernetes/operator/target-allocator/): it’s
an extra binary that can be deployed as part of the OpenTelemetry Operator and
will distribute Prometheus scrape targets for a given configuration across the
cluster of Collectors. You can use a Custom Resource (CR) like the following to
make use of the Target Allocator:

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/concepts/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ The OpenTelemetry Operator is an implementation of a Kubernetes Operator. The
operator manages the OpenTelemetry Collector and auto-instrumentation of the
workloads using OpenTelemetry.

For more information, see [K8s Operator](/docs/kubernetes/operator/).
For more information, see [K8s Operator](/docs/platforms/kubernetes/operator/).

## Function as a Service assets

Expand All @@ -136,4 +136,4 @@ provides pre-built Lambda layers able to auto-instrument your application as
well as the option of a standalone Collector Lambda layer that can be used when
instrumenting applications manually or automatically.

For more information, see [Functions as a Service](/docs/faas/).
For more information, see [Functions as a Service](/docs/platforms/faas/).
10 changes: 5 additions & 5 deletions content/en/docs/contributing/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ command:

```console
$ npm run check:i18n
1 1 content/en/docs/kubernetes/_index.md - content/zh/docs/kubernetes/_index.md
1 1 content/en/docs/platforms/kubernetes/_index.md - content/zh/docs/platforms/kubernetes/_index.md
...
```

Expand All @@ -158,11 +158,11 @@ of the corresponding English language pages by using the `-d` flag and providing
the paths to your localized pages, or omit the paths to see all. For example:

```console
$ npm run check:i18n -- -d content/zh/docs/kubernetes
diff --git a/content/en/docs/kubernetes/_index.md b/content/en/docs/kubernetes/_index.md
$ npm run check:i18n -- -d content/zh/docs/platforms/kubernetes
diff --git a/content/en/docs/platforms/kubernetes/_index.md b/content/en/docs/platforms/kubernetes/_index.md
index 3592df5d..c7980653 100644
--- a/content/en/docs/kubernetes/_index.md
+++ b/content/en/docs/kubernetes/_index.md
--- a/content/en/docs/platforms/kubernetes/_index.md
+++ b/content/en/docs/platforms/kubernetes/_index.md
@@ -1,7 +1,7 @@
---
title: OpenTelemetry with Kubernetes
Expand Down
5 changes: 3 additions & 2 deletions content/en/docs/demo/kubernetes-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ aliases: [kubernetes_deployment]
cSpell:ignore: loadgen otlphttp spanmetrics
---

We provide a [OpenTelemetry Demo Helm chart](/docs/kubernetes/helm/demo/) to
help deploy the demo to an existing Kubernetes cluster.
We provide a
[OpenTelemetry Demo Helm chart](/docs/platforms/kubernetes/helm/demo/) to help
deploy the demo to an existing Kubernetes cluster.

[Helm](https://helm.sh) must be installed to use the charts. Please refer to
Helm's [documentation](https://helm.sh/docs/) to get started.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/getting-started/ops.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ following:
- [What is OpenTelemetry?](../../what-is-opentelemetry/)
- [How can I instrument applications without touching their code?](../../concepts/instrumentation/zero-code/)
- [How can I set up a collector?](../../collector/)
- [How can I get automation for Kubernetes with the OpenTelemetry Operator?](../../kubernetes/operator/)
- [How can I get automation for Kubernetes with the OpenTelemetry Operator?](../../platforms/kubernetes/operator/)

If you are looking for a set of applications to try things out, you will find
our official [OpenTelemetry demo](/ecosystem/demo/) useful.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ cSpell:ignore: bleh targetallocator
---

If you’ve enabled
[Target Allocator](/docs/kubernetes/operator/target-allocator/) service
discovery on the [OpenTelemetry Operator](/docs/kubernetes/operator/), and the
Target Allocator is failing to discover scrape targets, there are a few
troubleshooting steps that you can take to help you understand what’s going on
and restore normal operation.
[Target Allocator](/docs/platforms/kubernetes/operator/target-allocator/)
service discovery on the
[OpenTelemetry Operator](/docs/platforms/kubernetes/operator/), and the Target
Allocator is failing to discover scrape targets, there are a few troubleshooting
steps that you can take to help you understand what’s going on and restore
normal operation.

## Troubleshooting steps

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/languages/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ The list above is aliased to [`/api`](/api).

{{% /alert %}}

[zero-code]: /docs/kubernetes/operator/automatic/
[zero-code]: /docs/platforms/kubernetes/operator/automatic/
[instrumentation]: /docs/concepts/instrumentation/
[otel-op]: /docs/kubernetes/operator/
[otel-op]: /docs/platforms/kubernetes/operator/
2 changes: 1 addition & 1 deletion content/en/docs/languages/js/serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ OpenTelemetry instrumentation libraries.
{{% alert title="Note" color="info" %}}

You can also automatically instrument your AWS Lambda functions by using the
[community provided Lambda layers](/docs/faas/lambda-auto-instrument/).
[community provided Lambda layers](/docs/platforms/faas/lambda-auto-instrument/).

{{% /alert %}}

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/platforms/faas/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: FaaS
description: >-
OpenTelemetry supports various methods of monitoring Function-as-a-Service
provided by different cloud vendors
redirects: [{ from: /docs/faas/*, to: ':splat' }] # cSpell:disable-line
redirects: [{ from: /docs/platforms/faas/*, to: ':splat' }] # cSpell:disable-line
---

Functions as a Service (FaaS) is an important serverless compute platform for
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/platforms/kubernetes/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: OpenTelemetry with Kubernetes
linkTitle: Kubernetes
redirects: [{ from: /docs/kubernetes/*, to: ':splat' }]
redirects: [{ from: /docs/platforms/kubernetes/*, to: ':splat' }]
---

[Kubernetes](https://kubernetes.io/) is an open source system for automated
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/platforms/kubernetes/helm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ linkTitle: Helm Charts
If you chose to use Helm, you can use
[OpenTelemetry Helm Charts](https://github.com/open-telemetry/opentelemetry-helm-charts)
to manage installs of the [OpenTelemetry Collector](/docs/collector),
[OpenTelemetry Operator](/docs/kubernetes/operator), and
[OpenTelemetry Operator](/docs/platforms/kubernetes/operator), and
[OpenTelemetry Demo](/docs/demo).

Add the OpenTelemetry Helm repository with:
Expand Down
14 changes: 7 additions & 7 deletions content/en/docs/platforms/kubernetes/helm/collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,8 @@ This feature is disabled by default. It has the following requirements in order
to be safely enabled:

- It requires the
[Filelog receiver](/docs/kubernetes/collector/components/#filelog-receiver) be
included in the Collector image, such as the
[Filelog receiver](/docs/platforms/kubernetes/collector/components/#filelog-receiver)
be included in the Collector image, such as the
[Contrib distribution of the Collector](https://github.com/open-telemetry/opentelemetry-collector-releases/pkgs/container/opentelemetry-collector-releases%2Fopentelemetry-collector-contrib).
- Although not a strict requirement, it is recommended this preset be used with
`mode=daemonset`. The `filelogreceiver` will only be able to collect logs on
Expand Down Expand Up @@ -238,7 +238,7 @@ Due to RBAC considerations, this feature is disabled by default. It has the
following requirements:

- It requires the
[Kubernetes Attributes processor](/docs/kubernetes/collector/components/#kubernetes-attributes-processor)
[Kubernetes Attributes processor](/docs/platforms/kubernetes/collector/components/#kubernetes-attributes-processor)
be included in the Collector image, such as the
[Contrib distribution of the Collector](https://github.com/open-telemetry/opentelemetry-collector-releases/pkgs/container/opentelemetry-collector-releases%2Fopentelemetry-collector-contrib).

Expand All @@ -263,7 +263,7 @@ container metrics from the API server on a kubelet.
This feature is disabled by default. It has the following requirements:

- It requires the
[Kubeletstats receiver](/docs/kubernetes/collector/components/#kubeletstats-receiver)
[Kubeletstats receiver](/docs/platforms/kubernetes/collector/components/#kubeletstats-receiver)
be included in the Collector image, such as the
[Contrib distribution of the Collector](https://github.com/open-telemetry/opentelemetry-collector-releases/pkgs/container/opentelemetry-collector-releases%2Fopentelemetry-collector-contrib).
- Although not a strict requirement, it is recommended this preset be used with
Expand Down Expand Up @@ -293,7 +293,7 @@ collected by Kube State Metrics.
This feature is disabled by default. It has the following requirements:

- It requires the
[Kubernetes Cluster receiver](/docs/kubernetes/collector/components/#kubernetes-cluster-receiver)
[Kubernetes Cluster receiver](/docs/platforms/kubernetes/collector/components/#kubernetes-cluster-receiver)
be included in the Collector image, such as the
[Contrib distribution of the Collector](https://github.com/open-telemetry/opentelemetry-collector-releases/pkgs/container/opentelemetry-collector-releases%2Fopentelemetry-collector-contrib).
- Although not a strict requirement, it is recommended this preset be used with
Expand Down Expand Up @@ -321,7 +321,7 @@ The OpenTelemetry Collector can be configured to collect Kubernetes events.
This feature is disabled by default. It has the following requirements:

- It requires the
[Kubernetes Objects receiver](/docs/kubernetes/collector/components/#kubernetes-objects-receiver)
[Kubernetes Objects receiver](/docs/platforms/kubernetes/collector/components/#kubernetes-objects-receiver)
be included in the Collector image, such as the
[Contrib distribution of the Collector](https://github.com/open-telemetry/opentelemetry-collector-releases/pkgs/container/opentelemetry-collector-releases%2Fopentelemetry-collector-contrib).
- Although not a strict requirement, it is recommended this preset be used with
Expand Down Expand Up @@ -351,7 +351,7 @@ Kubernetes nodes.
This feature is disabled by default. It has the following requirements:

- It requires the
[Host Metrics receiver](/docs/kubernetes/collector/components/#host-metrics-receiver)
[Host Metrics receiver](/docs/platforms/kubernetes/collector/components/#host-metrics-receiver)
be included in the Collector image, such as the
[Contrib distribution of the Collector](https://github.com/open-telemetry/opentelemetry-collector-releases/pkgs/container/opentelemetry-collector-releases%2Fopentelemetry-collector-contrib).
- Although not a strict requirement, it is recommended this preset be used with
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/platforms/kubernetes/helm/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ linkTitle: Operator Chart

## Introduction

The [OpenTelemetry Operator](/docs/kubernetes/operator) is a Kubernetes operator
that manages [OpenTelemetry Collectors](/docs/collector) and
The [OpenTelemetry Operator](/docs/platforms/kubernetes/operator) is a
Kubernetes operator that manages [OpenTelemetry Collectors](/docs/collector) and
auto-instrumentation of workloads. One of the ways to install the OpenTelemetry
Operator is via the
[OpenTelemetry Operator Helm Chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-operator).

For detailed use of the OpenTelemetry Operator visit its
[docs](/docs/kubernetes/operator).
[docs](/docs/platforms/kubernetes/operator).

### Installing the Chart

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/platforms/kubernetes/operator/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description:
aliases:
- /docs/operator
- /docs/k8s-operator
- /docs/kubernetes-operator
- /docs/platforms/kubernetes-operator
redirects:
- { from: /docs/operator/*, to: ':splat' }
- { from: /docs/k8s-operator/*, to: ':splat' }
- { from: /docs/kubernetes-operator/*, to: ':splat' }
- { from: /docs/platforms/kubernetes-operator/*, to: ':splat' }
---

## Introduction
Expand Down
Loading