Skip to content

Commit

Permalink
[v2] Update versions in README (#6206)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?
- README was referring to 1.59 version as example

## Description of the changes
- Update to refer to 2.0.0
- Clean-up

## How was this change tested?
- CI

---------

Signed-off-by: Yuri Shkuro <[email protected]>
  • Loading branch information
yurishkuro authored Nov 13, 2024
1 parent 6e695b3 commit 61ad598
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
13 changes: 6 additions & 7 deletions cmd/jaeger/README.md
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.
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
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
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 \
REGISTRY="localhost:5000/" \
docker compose -f "$docker_compose_file" up -d
echo '::endgroup::'

i=0
Expand Down

0 comments on commit 61ad598

Please sign in to comment.