Skip to content

Commit

Permalink
[chore] Clarify that cmd/otelcontribcol and top-level go.mod are not …
Browse files Browse the repository at this point in the history
…the sources of the contrib distro (#33409)

**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->

Documents the purpose of `cmd/otelcontribcol` and `cmd/oteltestbedcol`
in new READMEs and in comments on the builder manifests. 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/pull/10351

---------

Co-authored-by: Armin Ruech <[email protected]>
  • Loading branch information
mx-psi and arminru authored Jun 6, 2024
1 parent 4dda8b9 commit 4322a38
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 0 deletions.
4 changes: 4 additions & 0 deletions cmd/otelcontribcol/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# `otelcontribcol` test binary

This folder contains the sources for the `otelcontribcol` 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-contrib` folder**](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) on that repository for the official Collector contrib manifest.
8 changes: 8 additions & 0 deletions cmd/otelcontribcol/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 Contrib official distribution sources, check
# https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

dist:
module: github.com/open-telemetry/opentelemetry-collector-contrib/cmd/otelcontribcol
name: otelcontribcol
Expand Down
4 changes: 4 additions & 0 deletions cmd/oteltestbedcol/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# `oteltestbedcol` binary

This folder contains the sources for the `oteltestbedcol` test binary. This binary is intended for **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.
5 changes: 5 additions & 0 deletions cmd/oteltestbedcol/builder-config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# 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

dist:
module: github.com/open-telemetry/opentelemetry-collector-contrib/cmd/oteltestbedcol
name: oteltestbedcol
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 github.com/open-telemetry/opentelemetry-collector-contrib

// 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 Contrib distribution specifically, see
// https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

go 1.21.0

require (
Expand Down

0 comments on commit 4322a38

Please sign in to comment.