From 8718a23394ba90f86956667f1d1b6dc212b6c009 Mon Sep 17 00:00:00 2001 From: Yuri Shkuro Date: Sat, 23 Nov 2024 13:43:42 -0500 Subject: [PATCH] Make v2 docs the default Signed-off-by: Yuri Shkuro --- Makefile | 2 +- .../docs/next-release-v2/getting-started.md | 6 +--- content/download/_index.md | 10 +++--- data/download.yaml | 22 ++++++++++-- .../layouts/shortcodes/binaries.html | 11 +++--- .../layouts/shortcodes/dockerImages.html | 35 +++++++++++-------- themes/jaeger-docs/layouts/index.html | 2 +- .../jaeger-docs/layouts/partials/navbar.html | 6 ++-- 8 files changed, 57 insertions(+), 37 deletions(-) diff --git a/Makefile b/Makefile index 5c1e1b76..d63abf3c 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ HUGO_THEME = jaeger-docs THEME_DIR := themes/$(HUGO_THEME) client-libs-docs: - @for d in $(shell ls -d content/docs/* | grep -v next-release-v2 | grep -vE '2\.[0-9]+\.[0-9]+'); do \ + @for d in $(shell ls -d content/docs/* | grep -v next-release-v2 | grep -vE '2\.[0-9]+'); do \ cp content/_client_libs/client-libraries.md $$d/; \ cp content/_client_libs/client-features.md $$d/; \ echo "copied content/_client_libs/*.md -> $$d/"; \ diff --git a/content/docs/next-release-v2/getting-started.md b/content/docs/next-release-v2/getting-started.md index bce72b55..cfa9a38f 100644 --- a/content/docs/next-release-v2/getting-started.md +++ b/content/docs/next-release-v2/getting-started.md @@ -17,15 +17,11 @@ docker run --rm --name jaeger \ -p 14250:14250 \ -p 14268:14268 \ -p 9411:9411 \ - jaegertracing/jaeger:{{< currentVersion >}} \ - --set receivers.otlp.protocols.http.endpoint=0.0.0.0:4318 \ - --set receivers.otlp.protocols.grpc.endpoint=0.0.0.0:4317 + jaegertracing/jaeger:{{< currentVersion >}} ``` This runs the "all-in-one" configuration of Jaeger (using a configuration file embedded in the binary) that combines collector and query components in a single process and uses a transient in-memory storage for trace data. You can navigate to `http://localhost:16686` to access the Jaeger UI. See the [APIs page](../apis/) for a list of other exposed ports. -Note: the `--set` flags are necessary because by default OTLP receiver listens on `localhost` and therefore is not accessible from the host network even with port mappings. In the future versions the default will be changed to `0.0.0.0`. - ## Instrumentation Your applications must be instrumented before they can send tracing data to Jaeger. We recommend using the [OpenTelemetry][otel] instrumentation and SDKs. diff --git a/content/download/_index.md b/content/download/_index.md index 122652ad..d5ea32f5 100644 --- a/content/download/_index.md +++ b/content/download/_index.md @@ -5,11 +5,11 @@ title: Download Jaeger Jaeger components can be downloaded in two ways: * As [executable binaries](#binaries) -* As [Docker images](#docker-images) +* As [container images](#docker-images) -## Try Jaeger v2 +## Try Jaeger v2 🎉 -Jaeger v2 executable can be found in the latest [GitHub release](https://github.com/jaegertracing/jaeger/releases/) or as a Docker image [jaegertracing/jaeger](https://hub.docker.com/r/jaegertracing/jaeger/tags). +_November 12, 2024_: Jaeger v2 is a new major release based on the OpenTelemetry Collector framework. Read [the blog post](https://medium.com/jaegertracing/jaeger-v2-released-09a6033d1b10) for more details. ## Binaries @@ -19,9 +19,9 @@ Jaeger binaries are available for macOS, Linux, and Windows. The table below lis You can find the binaries for previous versions on the [GitHub releases page](https://github.com/jaegertracing/jaeger/releases/). -## Docker images +## Container images -The following Docker images are available for the Jaeger project via the `jaegertracing` organization on [Docker Hub](https://hub.docker.com/r/jaegertracing/) and [Quay.io](https://quay.io/organization/jaegertracing): +The following container images are available for the Jaeger project via the `jaegertracing` organization on [Docker Hub](https://hub.docker.com/r/jaegertracing/) and [Quay.io](https://quay.io/organization/jaegertracing): {{< dockerImages >}} diff --git a/data/download.yaml b/data/download.yaml index b13e1b59..ca44b9af 100644 --- a/data/download.yaml +++ b/data/download.yaml @@ -10,37 +10,53 @@ binaries: name: Windows icon: fa-windows docker: +- image: jaeger + description: The only binary you need to run Jaeger v2. + since: "2.0" + major: v2 - image: all-in-one description: Designed for quick local testing. It launches the Jaeger UI, collector, query, and agent, with an in-memory storage component. since: 0.8 + major: v1 - image: example-hotrod description: Sample application "[HotROD](https://github.com/jaegertracing/jaeger/tree/main/examples/hotrod)" that demonstrates features of distributed tracing ([blog post](https://medium.com/@YuriShkuro/take-opentracing-for-a-hotrod-ride-f6e3141f7941)). since: 1.6 -- image: jaeger-agent - description: (deprecated) Receives spans from Jaeger clients and forwards to collector. Designed to run as a sidecar or a host agent. **jaeger-agent** is deprecated and no longer recommended for use, see https://github.com/jaegertracing/jaeger/issues/4739. - since: 0.8 + major: v1 - image: jaeger-collector description: Receives spans from agents or directly from clients and saves them in persistent storage. since: 0.8 + major: v1 - image: jaeger-query description: Serves Jaeger UI and an API that retrieves traces from storage. since: 0.8 + major: v1 - image: jaeger-ingester description: An alternative to collector; reads spans from Kafka topic and saves them to storage. since: 1.7 + major: v1 - image: jaeger-remote-storage description: A service that implements the Remote Storage API on top of another supported backend. Can be used to share a single-node storage backend, like `memory`, across multiple Jaeger processes. since: 1.37 + major: v1 - image: spark-dependencies description: An [Apache Spark](http://spark.apache.org/) job that collects Jaeger spans from storage, analyzes links between services, and stores them for later presentation in the Jaeger UI latest: latest since: 1.3 + major: v1 - image: jaeger-operator description: A [Kubernetes Operator](https://github.com/operator-framework) for packaging, deploying, and managing Jaeger installation. since: 1.6 + major: v1 - image: jaeger-cassandra-schema description: A utility script used to initialize Cassandra keyspace and schema. since: 0.8 + major: v1 - image: jaeger-es-index-cleaner description: A utility script used to purge old indices from Elasticsearch, since ES does not support data TTL. since: 1.3 + major: v1 +- image: jaeger-agent + description: Receives spans from Jaeger clients and forwards to collector. Designed to run as a sidecar or a host agent. **jaeger-agent** is deprecated and no longer recommended for use, see https://github.com/jaegertracing/jaeger/issues/4739. + since: 0.8 + until: 1.62 + major: v1 diff --git a/themes/basetheme/layouts/shortcodes/binaries.html b/themes/basetheme/layouts/shortcodes/binaries.html index 868376c5..c7f46f28 100644 --- a/themes/basetheme/layouts/shortcodes/binaries.html +++ b/themes/basetheme/layouts/shortcodes/binaries.html @@ -1,8 +1,5 @@ -{{ $latest := .Site.Params.binariesLatest }} +{{ $latestXXX := .Site.Params.binariesLatest }} {{ $binaries := .Site.Data.download.binaries }} -{{ $releaseUrl := printf "https://github.com/jaegertracing/jaeger/releases/tag/v%s" $latest }} -{{ $zipUrl := printf "https://github.com/jaegertracing/jaeger/archive/v%s.zip" $latest }} -{{ $tarUrl := printf "https://github.com/jaegertracing/jaeger/archive/v%s.tar.gz" $latest }} {{ $platforms := $binaries.platforms }} @@ -16,6 +13,11 @@ + {{ $versions := slice .Site.Params.binariesLatestV2 .Site.Params.binariesLatest }} + {{ range $latest := $versions }} + {{ $releaseUrl := printf "https://github.com/jaegertracing/jaeger/releases/tag/v%s" $latest }} + {{ $zipUrl := printf "https://github.com/jaegertracing/jaeger/archive/v%s.zip" $latest }} + {{ $tarUrl := printf "https://github.com/jaegertracing/jaeger/archive/v%s.tar.gz" $latest }} + {{ end }}
@@ -63,5 +65,6 @@

\ No newline at end of file diff --git a/themes/basetheme/layouts/shortcodes/dockerImages.html b/themes/basetheme/layouts/shortcodes/dockerImages.html index 23833fd3..6dfced83 100644 --- a/themes/basetheme/layouts/shortcodes/dockerImages.html +++ b/themes/basetheme/layouts/shortcodes/dockerImages.html @@ -1,23 +1,25 @@ {{ $dockerImages := site.Data.download.docker }} -{{ $latest := site.Params.binariesLatest }} +{{ $latestV1 := site.Params.binariesLatest }} +{{ $latestV2 := site.Params.binariesLatestV2 }} + {{ range $dockerImages }} - {{ $org := "jaegertracing" }} - {{ $image := .image }} - {{ $fullImage := printf "%s/%s" $org $image }} - {{ $link := printf "https://hub.docker.com/r/%s/%s" $org $image }} - {{ $description := .description | markdownify }} - {{ $since := .since }} - {{ $latestImg := .latest | default $latest }} - {{ $pullCmd := printf "$ docker pull %s:%s" $fullImage $latestImg | safeHTML }} + {{ $org := "jaegertracing" }} + {{ $image := .image }} + {{ $major := .major }} + {{ $fullImage := printf "%s/%s" $org $image }} + {{ $link := printf "https://hub.docker.com/r/%s/%s" $org $image }} + {{ $since := .since }} + {{ $latest := cond (eq $major "v2") $latestV2 $latestV1}} + {{ $latestImg := .until | default $latest }} +
ImageMajor Description Since version
@@ -25,13 +27,18 @@ - {{ with $description }} -

- {{ . }} -

+ {{ $major }} + 		+ {{ if .until }} +

Deprecated 💀💤❌. Latest available version is {{ $latestImg }}.

{{ end }} +

{{ .description | markdownify }}

+
+ $ docker run {{ $fullImage }}:{{ $latestImg }} --help +
- {{ $pullCmd }} + $ podman run quay.io/{{ $fullImage }}:{{ $latestImg }} --help
diff --git a/themes/jaeger-docs/layouts/index.html b/themes/jaeger-docs/layouts/index.html index bec72d70..ce8f8c0e 100644 --- a/themes/jaeger-docs/layouts/index.html +++ b/themes/jaeger-docs/layouts/index.html @@ -32,7 +32,7 @@ {{ warnf "Post: %v" $v.title }} {{ end }} -{{ partial "home/hero.html" (dict "posts" $posts "title" site.Title "tagline" site.Params.tagline "latestVersion" site.Params.latest) }} +{{ partial "home/hero.html" (dict "posts" $posts "title" site.Title "tagline" site.Params.tagline "latestVersion" site.Params.latestV2) }} {{ partial "home/why.html" . }} {{ partial "home/features.html" . }} {{ partial "home/articles.html" (dict "posts" $posts "imgLinks" $imgLinks) }} diff --git a/themes/jaeger-docs/layouts/partials/navbar.html b/themes/jaeger-docs/layouts/partials/navbar.html index e3c8bd33..aea32258 100644 --- a/themes/jaeger-docs/layouts/partials/navbar.html +++ b/themes/jaeger-docs/layouts/partials/navbar.html @@ -77,8 +77,7 @@ {{ $docVersion := index (split $docPath "/") 1 }} - - {{ $matchVersion := cond ($isDocsPage) $majorMinorVersion $latestV1 }} + {{ $matchVersion := cond ($isDocsPage) $majorMinorVersion $latestV2 }} {{ if and (eq $docVersion $matchVersion) (not .Params.hasparent) }} {{ .Title }} @@ -86,8 +85,7 @@ {{ with .Params.children }} {{ range . }} - - {{ $url := cond $isDocsPage (printf "/docs/%s/%s" $majorMinorVersion .url) (printf "/docs/%s/%s" $latestV1 .url) }} + {{ $url := cond $isDocsPage (printf "/docs/%s/%s" $majorMinorVersion .url) (printf "/docs/%s/%s" $latestV2 .url) }} ○ {{ if .navtitle }}{{ .navtitle }}{{ else }}{{ .title }}{{ end }}