Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[v2] Update versions in README #6206

Merged
merged 3 commits into from
Nov 13, 2024
Merged

[v2] Update versions in README #6206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e942dfd
[v2] Update versions in README
yurishkuro Nov 13, 2024
1779c57
fix-script
yurishkuro Nov 13, 2024
bb0e1ae
missing-quote
yurishkuro Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions cmd/jaeger/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# jaeger

This is experimental Jaeger V2 based on OpenTelemetry collector.
Jaeger V2 based on OpenTelemetry collector.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we link the new blog post here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other post is more technical. Ideally this should point to the docs instead of a blog post.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to do that in this PR?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not a particularly critical README. We do need to push more visibility though for v2, maybe in the main README.

Read the [blog post](https://medium.com/jaegertracing/towards-jaeger-v2-moar-opentelemetry-2f8239bee48e).

Tracking issue: https://github.com/jaegertracing/jaeger/issues/4843.

```mermaid
flowchart LR
Receiver1 --> Processor
Expand Down Expand Up @@ -36,9 +34,10 @@ flowchart LR

## Try it out

* Download `docker-compose-v2.yml` from https://github.com/jaegertracing/jaeger/blob/main/examples/hotrod/docker-compose-v2.yml
* Optional: find the latest Jaeger version (see https://www.jaegertracing.io/download/) and pass it via environment variable `JAEGER_VERSION`. Otherwise `docker compose` will use the `latest` tag, which is fine for the first time you download the images, but once they are in your local registry the `latest` tag is never updated and you may be running stale (and possibly incompatible) verions of Jaeger and the HotROD app.
* Download `docker-compose-v2.yml` from https://github.com/jaegertracing/jaeger/blob/main/examples/hotrod/docker-compose-v2.yml, e.g.:
* `curl -O https://raw.githubusercontent.com/jaegertracing/jaeger/refs/heads/main/examples/hotrod/docker-compose-v2.yml`
* Optional: find the latest images versions (see https://www.jaegertracing.io/download/) and pass them via environment variables `JAEGER_VERSION` and `HOTROD_VERSION`. Otherwise `docker compose` will use the `latest` tag, which is fine for the first time you download the images, but once they are in your local registry the `latest` tag is never updated and you may be running stale (and possibly incompatible) verions of Jaeger and the HotROD app.
* Run Jaeger backend and HotROD demo, e.g.:
* `JAEGER_VERSION=1.59 docker compose -f path-to-yml-file-v2 up`
* `JAEGER_VERSION=2.0.0 HOTROD_VERSION=1.63.0 docker compose -f docker-compose-v2.yml up`
* Access Jaeger UI at http://localhost:16686 and HotROD app at http://localhost:8080
* Shutdown / cleanup with `docker compose -f path-to-yml-file down`
* Shutdown / cleanup with `docker compose -f docker-compose-v2.yml down`
4 changes: 2 additions & 2 deletions examples/hotrod/docker-compose-v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# To run a specific version of Jaeger, use environment variable, e.g.:
# JAEGER_VERSION=1.52 docker compose up
# JAEGER_VERSION=2.0.0 HOTROD_VERSION=1.63.0 docker compose up

services:
jaeger:
Expand All @@ -17,7 +17,7 @@ services:
- jaeger-example

hotrod:
image: ${REGISTRY:-}jaegertracing/example-hotrod:${JAEGER_VERSION:-latest}
image: ${REGISTRY:-}jaegertracing/example-hotrod:${HOTROD_VERSION:-latest}
# To run the latest trunk build, find the tag at Docker Hub and use the line below
# https://hub.docker.com/r/jaegertracing/example-hotrod-snapshot/tags
#image: jaegertracing/example-hotrod-snapshot:0ab8f2fcb12ff0d10830c1ee3bb52b745522db6c
Expand Down
7 changes: 5 additions & 2 deletions scripts/build-hotrod-image.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ case "$jaeger_version" in
binary="jaeger"
;;
*)
echo "Invalid Jaeger version provided: $jaeger_version"
echo "Invalid Jaeger version provided: $jaeger_version"
print_help
;;
esac
Expand Down Expand Up @@ -99,7 +99,10 @@ make build-${binary}
bash scripts/build-upload-a-docker-image.sh -l -b -c "${binary}" -d cmd/"${binary}" -p "${current_platform}" -t release

echo '::group:: docker compose'
JAEGER_VERSION=$GITHUB_SHA REGISTRY="localhost:5000/" docker compose -f "$docker_compose_file" up -d
JAEGER_VERSION=$GITHUB_SHA \
HOTROD_VERSION=$GITHUB_SHA \
yurishkuro marked this conversation as resolved.
Show resolved Hide resolved
REGISTRY="localhost:5000/" \
docker compose -f "$docker_compose_file" up -d
echo '::endgroup::'

i=0
Expand Down
Loading