From 66bfcaea89064d0ec33137ccb1bd00a6bb4eed80 Mon Sep 17 00:00:00 2001 From: cartersocha Date: Wed, 3 Aug 2022 10:19:09 -0700 Subject: [PATCH 1/5] add helm chart --- README.md | 46 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 39 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 59045561a9..882cf66ddc 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,17 @@ This repo is a work in progress. If you'd like to help, check out our ## Local Quickstart -### Pre-requisites +- [Docker](#docker) +- [Kubernetes](#kubernetes) + +### Docker + +#### Pre-requisites - Docker - [Docker Compose](https://docs.docker.com/compose/install/#install-compose) v2.0.0+ -### Clone Repo +#### Clone Repo - Clone the Webstore Demo repository: @@ -26,7 +31,7 @@ This repo is a work in progress. If you'd like to help, check out our git clone https://github.com/open-telemetry/opentelemetry-demo.git ``` -### Open Folder +#### Open Folder - Navigate to the cloned folder: @@ -34,7 +39,7 @@ git clone https://github.com/open-telemetry/opentelemetry-demo.git cd opentelemetry-demo/ ``` -### Gradle Update [Windows Only] +#### Gradle Update [Windows Only] - Navigate to the Java Ad Service folder to install and update Gradle: @@ -44,7 +49,7 @@ cd .\src\adservice\ .\gradlew wrapper --gradle-version 7.4.2 ``` -### Run Docker Compose +#### Run Docker Compose - Start the demo (It can take ~20min the first time the command is executed as all the images will be build): @@ -53,7 +58,7 @@ all the images will be build): docker compose up ``` -### Verify the Webstore & the Telemetry +#### Verify the Webstore & the Telemetry Once the images are built and containers are started you can access: @@ -65,7 +70,7 @@ Once the images are built and containers are started you can access: - Grafana: -### Bring your own backend +#### Bring your own backend Likely you want to use the Webstore as a demo application for an observability backend you already have (e.g. an existing instance of Jaeger, Zipkin or one of @@ -108,6 +113,33 @@ After updating the `otelcol-config.yml` start the demo by running `docker compose up`. After a while you should see the traces flowing into your backend as well. +### Kubernetes + +We provide a [OpenTelemetry +Demo](https://github.com/open-telemetry/opentelemetry-demo) helm chart to +quickly get a kubernetes cluster running. + +[Helm](https://helm.sh) must be installed to use the charts. +Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. + +#### Prerequisites + +- Helm 3.0+ + +#### Installing the Chart + +Add OpenTelemetry Helm repository: + +```console +helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts +``` + +To install the chart with the release name my-otel-demo, run the following command: + +```console +helm install my-otel-demo open-telemetry/opentelemetry-demo +``` + ## Screenshots from the Online Boutique | Home Page | Checkout Screen | From feff9955c76b55805b2c20669f2350460f02a8d3 Mon Sep 17 00:00:00 2001 From: cartersocha Date: Wed, 3 Aug 2022 10:20:31 -0700 Subject: [PATCH 2/5] changelog update --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ea51adbe27..3672a839a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -51,3 +51,5 @@ significant modifications will be credited to OpenTelemetry Authors. ([#244](https://github.com/open-telemetry/opentelemetry-demo/pull/244)) * Pulling java agent from the Java instrumentation releases instead. ([#253](https://github.com/open-telemetry/opentelemetry-demo/pull/253)) +* Added explicit support for Kubernetes. +([#255](https://github.com/open-telemetry/opentelemetry-demo/pull/255)) From 95fb96cd3018219648190a3739238e48941c3fe4 Mon Sep 17 00:00:00 2001 From: cartersocha Date: Wed, 3 Aug 2022 13:36:00 -0700 Subject: [PATCH 3/5] pr feedback --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 882cf66ddc..3183733698 100644 --- a/README.md +++ b/README.md @@ -115,9 +115,9 @@ your backend as well. ### Kubernetes -We provide a [OpenTelemetry -Demo](https://github.com/open-telemetry/opentelemetry-demo) helm chart to -quickly get a kubernetes cluster running. +We provide a [OpenTelemetry Demo Helm +chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-demo) +to quickly deploy the demo to an existing Kubernetes cluster. [Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. From 74b7bbfdeea2e3ee4844e350d68b1a35e5f22bd8 Mon Sep 17 00:00:00 2001 From: cartersocha Date: Wed, 3 Aug 2022 13:37:13 -0700 Subject: [PATCH 4/5] nit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3183733698..273ffe7f7b 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ your backend as well. We provide a [OpenTelemetry Demo Helm chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-demo) -to quickly deploy the demo to an existing Kubernetes cluster. +to help deploy the demo to an existing Kubernetes cluster. [Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. From 068922773dd89b4154cc906d0e120a713b2d572c Mon Sep 17 00:00:00 2001 From: cartersocha Date: Wed, 3 Aug 2022 13:42:11 -0700 Subject: [PATCH 5/5] add to prerequisites --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 273ffe7f7b..b070ef7080 100644 --- a/README.md +++ b/README.md @@ -124,9 +124,10 @@ Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. #### Prerequisites +- Pre-existing Kubernetes Cluster - Helm 3.0+ -#### Installing the Chart +#### Install the Chart Add OpenTelemetry Helm repository: