opentelemetry-collector-releases icon indicating copy to clipboard operation
opentelemetry-collector-releases copied to clipboard

Make the command name consistent across images

Open dmitryax opened this issue 1 year ago • 9 comments
trafficstars

Currently, we use different commands for different images.

  • /otelcol for the core image
  • /otelcol-contrib for the contrib image (/otecontribcol if built with make docker-otelcontribcol)
  • /otelcol-k8s for k8s image

Is there any value to having a unique command in each distro?

If not, we could use /otelcol consistently for every image.

We can make this change gradually and support both old and new names for some time.

Initially brought in https://github.com/open-telemetry/opentelemetry-helm-charts/pull/1148#discussion_r1567939304

dmitryax avatar Apr 16 '24 21:04 dmitryax

cc @jpkrohling

mx-psi avatar Apr 17 '24 16:04 mx-psi

The different configuration files is also confusing..

codeboten avatar Apr 17 '24 16:04 codeboten

As discussed in 17-Apr-2024 - The same command could just be a symlink to ensure the change isn't breaking backwards compatibility

codeboten avatar Apr 17 '24 16:04 codeboten

Opened a separate issue for configuration consistency: https://github.com/open-telemetry/opentelemetry-collector-releases/issues/530

codeboten avatar Apr 17 '24 16:04 codeboten

I pinged Juraci because I think this was intentional (see https://github.com/open-telemetry/opentelemetry-collector-releases/issues/59#issuecomment-1014451868)

mx-psi avatar Apr 17 '24 16:04 mx-psi

@dmitryax if we wanted to take advantage of the entrypoint in the helm chart like @jaronoff97 mentioned we'll need to update the container to use args instead of command.

TylerHelmuth avatar Apr 17 '24 16:04 TylerHelmuth

Created https://github.com/open-telemetry/opentelemetry-helm-charts/pull/1149 for the helm chart.

TylerHelmuth avatar Apr 17 '24 20:04 TylerHelmuth

The idea behind both the config files being at different locations, and the binary names being different, is that different distributions could be installed via OS packages (rpm/deb) without interfering. From here, we have a few options:

  • continue allowing multiple distributions to be installed on the same system independently
  • make them all providers of a capability, like the Provides keyword for RPM, meaning that only one such package is allowed at any given time

jpkrohling avatar Apr 19 '24 14:04 jpkrohling