Require configuration file for all OTel collector installations and update examples#808
Require configuration file for all OTel collector installations and update examples#808
Conversation
dmenilo1
requested review from
a team,
ShauliSolomovich,
avivgold098,
nicolastakashi and
oded-dd
as code owners
otel-installer/docker/README.md
Outdated
| > [!IMPORTANT] | ||
| > **Configuration Required** | ||
| > | ||
| > A configuration file must be provided when installing the collector in regular mode. |
There was a problem hiding this comment.
Use not using the opamp supervisor or something like that. Otherwise is not clear
There was a problem hiding this comment.
Updated all entries in all readme files to local configuration mode which makes more sense
| CORALOGIX_PRIVATE_KEY="<your-private-key>" \ | ||
| bash -c "$(curl -sSL https://github.com/coralogix/telemetry-shippers/releases/latest/download/docker-install.sh)" \ | ||
| -- --config /path/to/config.yaml | ||
| -- -c /path/to/config.yaml |
There was a problem hiding this comment.
Not removed, both options exist, just examples are updated to use -c
There was a problem hiding this comment.
Please, try to keep changes to just what is needed in the PR. Else, it can be difficult to review the important changes because of the introduced noise.
| # One-line installation (sudo is handled automatically): | ||
| # CORALOGIX_DOMAIN="your-domain" CORALOGIX_PRIVATE_KEY="your-key" bash -c "$(curl -sSL https://github.com/coralogix/telemetry-shippers/releases/latest/download/coralogix-otel-collector.sh)" | ||
| # | ||
| # Or with options: |
There was a problem hiding this comment.
This adds confusion to users, it is noot used in any examples (all use bash -c "$(curl ...)")
[OPTIONS] is vague
Less common than the bash -c method
| Examples: | ||
| # One-line installation (recommended) | ||
| CORALOGIX_DOMAIN="your-domain" CORALOGIX_PRIVATE_KEY="your-key" bash -c "$(curl -sSL https://github.com/coralogix/telemetry-shippers/releases/latest/download/coralogix-otel-collector.sh)" | ||
| CORALOGIX_PRIVATE_KEY="your-key" bash -c "$(curl -sSL https://github.com/coralogix/telemetry-shippers/releases/latest/download/coralogix-otel-collector.sh)" -- -c /path/to/config.yaml |
There was a problem hiding this comment.
Why the domain is not needed anymore here but in other locations it is?
There was a problem hiding this comment.
domain is part of the otel-config in regular mode, it is populated automatically from the UI integration.
It is only needed for supervised mode
| -- --memory-limit 2048 --listen-interface 0.0.0.0 | ||
| ``` | ||
|
|
||
| ## Service Discovery |
There was a problem hiding this comment.
The chart to support it is not released yet, so removed it until released
3 participants
Description
Add configuration requirement and update all installation examples across platforms
Checklist: