Skip to content

Commit

Permalink
[chore] Clarify that cmd/otelcorecol and top-level go.mod are not the…
Browse files Browse the repository at this point in the history
… source of the core distro (open-telemetry#10351)

#### Description

Documents the purpose of `cmd/otelcorecol` in a new README and in a
comment on the builder manifest. Adds note to top-level go.mod.

This is a common point of confusion and was recently confusing for users
on the aftermath of CVE-2024-36129

Counterpart to open-telemetry/opentelemetry-collector-contrib/pull/33409

---------

Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
  • Loading branch information
mx-psi and arminru authored Jun 6, 2024
1 parent 9c3481b commit d3c5ce0
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
4 changes: 4 additions & 0 deletions cmd/otelcorecol/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# `otelcorecol` test binary

This folder contains the sources for the `otelcorecol` test binary. This binary is intended for internal **TEST PURPOSES ONLY**. The source files in this folder are **NOT** the ones used to build any official OpenTelemetry Collector releases.
Check [open-telemetry/opentelemetry-collector-releases](https://github.com/open-telemetry/opentelemetry-collector-releases) for the official releases. Check the [**`otelcol` folder**](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol) on that repository for the official Collector core manifest.
8 changes: 8 additions & 0 deletions cmd/otelcorecol/builder-config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# NOTE:
# This builder configuration is NOT used to build any official binary.
# To see the builder manifests used for official binaries,
# check https://github.com/open-telemetry/opentelemetry-collector-releases
#
# For the OpenTelemetry Collector Core official distribution sources, check
# https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol

dist:
module: go.opentelemetry.io/collector/cmd/otelcorecol
name: otelcorecol
Expand Down
8 changes: 8 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
module go.opentelemetry.io/collector

// NOTE:
// This go.mod is NOT used to build any official binary.
// To see the builder manifests used for official binaries,
// check https://github.com/open-telemetry/opentelemetry-collector-releases
//
// For the OpenTelemetry Collector Core distribution specifically, see
// https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol

go 1.21.0

require (
Expand Down

0 comments on commit d3c5ce0

Please sign in to comment.