|
| 1 | +# Building the Splunk version of the OpenTelemetry Demo Webstore |
| 2 | + |
| 3 | +Welcome to the Splunk fork of the OpenTelemetry Demo repository! |
| 4 | +This fork streamlines the default OpenTelemetry Demo by removing components not used with Splunk and updating several services to better demonstrate Splunk Observability (O11y) features. |
| 5 | + |
| 6 | + |
| 7 | +## Getting Started |
| 8 | + |
| 9 | +This deployment assumes you are using Kubernetes — for example, with platforms such as minikube or k3s. |
| 10 | +The deployment manifests are located in the kubernetes/ folder, with the main file named opentelemetry-demo.yaml. |
| 11 | + |
| 12 | +This file has been adapted to deploy both: |
| 13 | +* The default OpenTelemetry Demo services, and |
| 14 | +* Splunk-specific components and configurations. |
| 15 | + |
| 16 | +### Adapted Services |
| 17 | + |
| 18 | +The following services have been updated or added in this Splunk version: |
| 19 | + |
| 20 | +* Frontend-proxy |
| 21 | +* Frontend |
| 22 | +* Image-provider |
| 23 | +* Accounting |
| 24 | +* Payment |
| 25 | +* Recommendation |
| 26 | +* Ad |
| 27 | +* Cart |
| 28 | + |
| 29 | +### Building the Services |
| 30 | + |
| 31 | +Each service directory under src/ contains a build script used to create its container image. |
| 32 | +For example, the Ad Service build script is located at: |
| 33 | +[ad service build script](src/ad/build-ad.sh) |
| 34 | + |
| 35 | +Run the script directly. If executed without parameters, it displays the required usage information: |
| 36 | + |
| 37 | +```bash |
| 38 | +❌ Error: No version provided. |
| 39 | +Usage: ./build-ad.sh <version> [-cc] |
| 40 | +``` |
| 41 | + |
| 42 | +Ech script willl require a version tag such as 0.0.1 when running the script. |
| 43 | +Use the optional -cc flag to force a clean build and repull all base images and layers. |
| 44 | + |
| 45 | +After the build completes, the resulting image is pushed to: **ghcr.io/splunk/opentelemetry-demo/** |
| 46 | + |
| 47 | +If you have permission to push to this registry, make sure you are logged in beforehand. |
| 48 | +Otherwise, you can modify the build script to push the image to your own container registry and update the deployment file accordingly. |
0 commit comments