Skip to content

Commit

Permalink
add helm chart to main readme (open-telemetry#255)
Browse files Browse the repository at this point in the history
* add helm chart

* changelog update

* pr feedback

* nit

* add to prerequisites
  • Loading branch information
cartersocha committed Aug 3, 2022
1 parent 662f734 commit 512135d
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 7 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
47 changes: 40 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,33 @@ 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:

```shell
git clone https://github.com/open-telemetry/opentelemetry-demo.git
```

### Open Folder
#### Open Folder

- Navigate to the cloned folder:

```shell
cd opentelemetry-demo/
```

### Gradle Update [Windows Only]
#### Gradle Update [Windows Only]

- Navigate to the Java Ad Service folder to install and update Gradle:

Expand All @@ -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):
Expand All @@ -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:

Expand All @@ -65,7 +70,7 @@ Once the images are built and containers are started you can access:

- Grafana: <http://localhost:3000/>

### 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
Expand Down Expand Up @@ -108,6 +113,34 @@ 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 Helm
chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-demo)
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.

#### Prerequisites

- Pre-existing Kubernetes Cluster
- Helm 3.0+

#### Install 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 |
Expand Down

0 comments on commit 512135d

Please sign in to comment.