Update documentation defaults from v1 to v2 #7640
Merged
+12
−30
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: yurishkuro <3523016+yurishkuro@users.noreply.github.com>
Co-authored-by: yurishkuro <3523016+yurishkuro@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Remove default usage of v1 artifacts in Makefiles and scripts
Milestone 1: Update documentation defaults from v1 to v2
Nov 12, 2025
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. You may re-open it if you need more time. |
github-actions
bot
added
the
stale
yurishkuro
reviewed
Jan 12, 2026
Signed-off-by: Yuri Shkuro <yurishkuro@users.noreply.github.com>
yurishkuro
reviewed
Jan 12, 2026
yurishkuro
reviewed
Jan 12, 2026
Signed-off-by: Yuri Shkuro <yurishkuro@users.noreply.github.com>
Signed-off-by: Yuri Shkuro <yurishkuro@users.noreply.github.com>
yurishkuro
reviewed
Jan 12, 2026
Signed-off-by: Yuri Shkuro <yurishkuro@users.noreply.github.com>
yurishkuro
approved these changes
Jan 12, 2026
jaegertracingbot
approved these changes
Jan 12, 2026
yurishkuro
changed the title
Metrics Comparison SummaryTotal changes across all snapshots: 0 Detailed changes per snapshotsummary_metrics_snapshot_cassandra📊 Metrics Diff SummaryTotal Changes: 0
summary_metrics_snapshot_cassandra📊 Metrics Diff SummaryTotal Changes: 0
summary_metrics_snapshot_cassandra📊 Metrics Diff SummaryTotal Changes: 0
summary_metrics_snapshot_cassandra📊 Metrics Diff SummaryTotal Changes: 0
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7640 +/- ##
==========================================
+ Coverage 95.49% 95.50% +0.01%
==========================================
Files 305 305
Lines 16174 16174
==========================================
+ Hits 15445 15447 +2
+ Misses 571 570 -1
+ Partials 158 157 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Manik2708
pushed a commit
to Manik2708/jaeger
that referenced
this pull request
Jan 20, 2026
Implements Milestone 1 from `docs/release/remove-v1-checklist.md`:
ensure documentation and examples default to v2 images/binaries without
breaking CI or release automation.
## Changes
### Documentation updates
- **CONTRIBUTING.md**: Show v2 as primary dev option (`go run
./cmd/jaeger --config ./cmd/jaeger/config.yaml`), v1 as legacy
- **docker-compose/monitor/README.md**: Remove v1 examples, update
tracegen to `latest`, simplify terminology
- **examples/hotrod/README.md**: Change examples from
`all-in-one:latest` to `jaeger:latest`, version from `1.52` to `2.0.0`
### Verified no changes needed
All CI test scripts and docker-compose files already use v2 by default
or accept explicit version parameters:
- `scripts/e2e/{kafka,spm}.sh` already default to v2
- `scripts/e2e/{elasticsearch,cassandra}.sh` require explicit parameters
(CI passes them)
- `docker-compose/*/Makefile` build v2 binaries or use explicit version
flags
- `examples/otel-demo/deploy-all.sh` uses `jaegertracing/jaeger:latest`
## Impact
- Developers see v2 examples by default
- CI matrix tests remain unchanged (explicitly pass v1/v2 as needed)
- v1 compatibility preserved: `docker-compose-v1.yml`, `dev-v1` targets,
CI matrix parameters
- Release automation untouched
## Example
Before:
```bash
docker run -p16686:16686 jaegertracing/all-in-one:latest
```
After:
```bash
docker run -p16686:16686 jaegertracing/jaeger:latest
```
Related: jaegertracing#7497
> [!WARNING]
>
> <details>
> <summary>Firewall rules blocked me from connecting to one or more
addresses (expand for details)</summary>
>
> #### I tried to connect to the following addresses, but was blocked by
firewall rules:
>
> - `cr.jaegertracing.io`
> - Triggering command: `/usr/libexec/docker/cli-plugins/docker-compose
compose up -d` (dns block)
>
> If you need me to access, download, or install something from one of
these locations, you can either:
>
> - Configure [Actions setup
steps](https://gh.io/copilot/actions-setup-steps) to set up my
environment, which run before the firewall is enabled
> - Add the appropriate URLs or hosts to the custom allowlist in this
repository's [Copilot coding agent
settings](https://github.com/jaegertracing/jaeger/settings/copilot/coding_agent)
(admins only)
>
> </details>
<!-- START COPILOT CODING AGENT SUFFIX -->
<details>
<summary>Original prompt</summary>
> Goal: Implement Milestone 1 from docs/release/remove-v1-checklist.md
by removing default usage of v1 artifacts in convenience Makefiles,
example scripts, and CI-invoked test helpers. This is a non-breaking,
reversible change: release/publish automation that actually produces v1
artifacts must remain able to do so (no changes to core release scripts
that publish artifacts).
>
> Scope (files to modify):
> - docker-compose/tail-sampling/Makefile
> - Replace any default variables that set JAEGER_VERSION to a v1 value
with v2 defaults (e.g. JAEGER_VERSION=2.0.0 or use the repo's v2-suffix
convention). If the file provides convenience targets that default to v1
images, update them to use v2 or remove v1 convenience targets.
> - docker-compose/monitor/Makefile
> - Update dev convenience targets and README example lines to use v2
images by default.
> - examples/otel-demo/deploy-all.sh
> - If the script defaults to v1 images, change defaults to v2; preserve
an explicit legacy flag to deploy v1 if needed.
> - scripts/e2e/* (only test helpers invoked by CI)
> - Identify helper scripts used by CI e2e jobs that default to v1 and
change their defaults to v2. Do not alter release/publish scripts.
> - scripts/utils/compare_metrics.py
> - Make v2 metrics the default for compare helpers invoked by CI. Keep
ability to compare v1 via explicit flag (no breaking change for test
assertions).
> - README/example lines that are invoked by CI or referenced in release
docs
> - Update documented example commands to use v2 by default where they
would be used by maintainers or CI.
> - Small convenience Makefile targets / scripts referenced in
documentation or used by CI tests
> - Replace v1 defaults with v2; remove legacy v1 targets where
appropriate.
>
> Implementation details:
> - Keep changes minimal: change default literal values, update example
lines, and remove v1-only convenience shortcuts if present.
> - Preserve any explicit support for generating or publishing v1
artifacts in the core release automation (these are out of scope for
this PR).
> - Add clear PR description and tests in the PR body listing exactly
which files changed and why.
> - Create branch chore/remove-v1-usage (off main) and open a pull
request with the changes.
>
> Testing / Validation plan (to include in PR):
> 1. Run repository CI (staging) to ensure tests still pass and no CI
job pulls v1 images by default.
> 2. Run docker-compose examples that were updated (tail-sampling,
monitor) locally and confirm default images are v2.
> 3. Run examples/otel-demo/deploy-all.sh in dry-run and confirm it will
deploy v2 images by default.
> 4. Run scripts/e2e tests used by CI and ensure compare_metrics.py
defaults to v2 metrics; validate no regressions.
> 5. Sanity-check that core release/publish scripts remain unchanged and
still compile if used to produce v1 artifacts.
>
> PR metadata:
> - Branch name: chore/remove-v1-usage
> - Title: Milestone 1: remove v1 usage — change defaults to v2
> - Reviewers: @yurishkuro and CI/release owners (leave as review
request)
> - Include link to docs/release/remove-v1-checklist.md and reference
Issue jaegertracing#7497 in the PR body.
>
> Please implement the minimal code edits described above, open a PR
against main, and include the testing steps in the PR description.
</details>
*This pull request was created as a result of the following prompt from
Copilot chat.*
> Goal: Implement Milestone 1 from docs/release/remove-v1-checklist.md
by removing default usage of v1 artifacts in convenience Makefiles,
example scripts, and CI-invoked test helpers. This is a non-breaking,
reversible change: release/publish automation that actually produces v1
artifacts must remain able to do so (no changes to core release scripts
that publish artifacts).
>
> Scope (files to modify):
> - docker-compose/tail-sampling/Makefile
> - Replace any default variables that set JAEGER_VERSION to a v1 value
with v2 defaults (e.g. JAEGER_VERSION=2.0.0 or use the repo's v2-suffix
convention). If the file provides convenience targets that default to v1
images, update them to use v2 or remove v1 convenience targets.
> - docker-compose/monitor/Makefile
> - Update dev convenience targets and README example lines to use v2
images by default.
> - examples/otel-demo/deploy-all.sh
> - If the script defaults to v1 images, change defaults to v2; preserve
an explicit legacy flag to deploy v1 if needed.
> - scripts/e2e/* (only test helpers invoked by CI)
> - Identify helper scripts used by CI e2e jobs that default to v1 and
change their defaults to v2. Do not alter release/publish scripts.
> - scripts/utils/compare_metrics.py
> - Make v2 metrics the default for compare helpers invoked by CI. Keep
ability to compare v1 via explicit flag (no breaking change for test
assertions).
> - README/example lines that are invoked by CI or referenced in release
docs
> - Update documented example commands to use v2 by default where they
would be used by maintainers or CI.
> - Small convenience Makefile targets / scripts referenced in
documentation or used by CI tests
> - Replace v1 defaults with v2; remove legacy v1 targets where
appropriate.
>
> Implementation details:
> - Keep changes minimal: change default literal values, update example
lines, and remove v1-only convenience shortcuts if present.
> - Preserve any explicit support for generating or publishing v1
artifacts in the core release automation (these are out of scope for
this PR).
> - Add clear PR description and tests in the PR body listing exactly
which files changed and why.
> - Create branch chore/remove-v1-usage (off main) and open a pull
request with the changes.
>
> Testing / Validation plan (to include in PR):
> 1. Run repository CI (staging) to ensure tests still pass and no CI
job pulls v1 images by default.
> 2. Run docker-compose examples that were updated (tail-sampling,
monitor) locally and confirm default images are v2.
> 3. Run examples/otel-demo/deploy-all.sh in dry-run and confirm it will
deploy v2 images by default.
> 4. Run scripts/e2e tests used by CI and ensure compare_metrics.py
defaults to v2 metrics; validate no regressions.
> 5. Sanity-check that core release/publish scripts remain unchanged and
still compile if used to produce v1 artifacts.
>
> PR metadata:
> - Branch name: chore/remove-v1-usage
> - Title: Milestone 1: remove v1 usage — change defaults to v2
> - Reviewers: @yurishkuro and CI/release owners (leave as review
request)
> - Include link to docs/release/remove-v1-checklist.md and reference
Issue jaegertracing#7497 in the PR body.
>
> Please implement the minimal code edits described above, open a PR
against main, and include the testing steps in the PR description.
<!-- START COPILOT CODING AGENT TIPS -->
---
💬 We'd love your input! Share your thoughts on Copilot coding agent in
our [2 minute survey](https://gh.io/copilot-coding-agent-survey).
---------
Signed-off-by: Yuri Shkuro <yurishkuro@users.noreply.github.com>
Signed-off-by: Yuri Shkuro <github@ysh.us>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: yurishkuro <3523016+yurishkuro@users.noreply.github.com>
Co-authored-by: Yuri Shkuro <yurishkuro@users.noreply.github.com>
Co-authored-by: Yuri Shkuro <github@ysh.us>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements Milestone 1 from
docs/release/remove-v1-checklist.md: ensure documentation and examples default to v2 images/binaries without breaking CI or release automation.Changes
Documentation updates
go run ./cmd/jaeger --config ./cmd/jaeger/config.yaml), v1 as legacylatest, simplify terminologyall-in-one:latesttojaeger:latest, version from1.52to2.0.0Verified no changes needed
All CI test scripts and docker-compose files already use v2 by default or accept explicit version parameters:
scripts/e2e/{kafka,spm}.shalready default to v2scripts/e2e/{elasticsearch,cassandra}.shrequire explicit parameters (CI passes them)docker-compose/*/Makefilebuild v2 binaries or use explicit version flagsexamples/otel-demo/deploy-all.shusesjaegertracing/jaeger:latestImpact
docker-compose-v1.yml,dev-v1targets, CI matrix parametersExample
Before:
After:
Related: #7497
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
cr.jaegertracing.io/usr/libexec/docker/cli-plugins/docker-compose compose up -d(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
This pull request was created as a result of the following prompt from Copilot chat.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.