Skip to content

Commit 9d1e782

Browse files
Add documentation for creating a fork (#447)
1 parent 96d0611 commit 9d1e782

File tree

2 files changed

+78
-0
lines changed

2 files changed

+78
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ In case you need to run a specific suite of tests you can execute
163163
- [Lightstep](https://github.com/lightstep/opentelemetry-demo)
164164
- [New Relic](https://github.com/newrelic/opentelemetry-demo)
165165

166+
See [Forking](./docs/forking.md) for more information about creating your own fork.
167+
166168
## Contributing
167169

168170
See [CONTRIBUTING.md](CONTRIBUTING.md)

docs/forking.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Forking this Repository
2+
3+
This repository is designed to be forked and used as a tool to show off what you
4+
are doing with OpenTelemetry.
5+
6+
Setting up a fork or a demo usually only requires overriding some environment
7+
variables and possibly replacing some container images.
8+
9+
Live demos can be added to the [README](https://github.com/open-telemetry/opentelemetry-demo/blob/main/README.md?plain=1#L186)
10+
11+
## Building Custom Images
12+
13+
Docker Compose uses `IMAGE_VERSION` and `IMAGE_NAME` from `.env` to tag all
14+
images. Modify these values in order to push or pull custom images from your
15+
container registry of choice.
16+
17+
## Configuring the Collector
18+
19+
The collector is configured to export traces to jaeger and metrics to prometheus
20+
in
21+
[otelcol-config.yml](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/otelcollector/otelcol-config.yml)
22+
23+
You may wish to make a copy of
24+
[otelcol-config-extras.yml](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/otelcollector/otelcol-config-extras.yml)
25+
for your fork and to modify the relevant volume mounts for the collector in
26+
[docker-compose.yaml](https://github.com/open-telemetry/opentelemetry-demo/blob/main/docker-compose.yml)
27+
28+
## Configuring the Collector [Helm/Kubernetes]
29+
30+
The [helm
31+
charts](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-demo)
32+
allow for easy customization of collector configuration using a custom values
33+
file:
34+
35+
```yaml
36+
opentelemetry-collector:
37+
config:
38+
exporters:
39+
otlp:
40+
endpoint: "your-otlp-endpoint.com:4317"
41+
headers:
42+
"x-vendor-api-key": "YOUR_API_KEY"
43+
service:
44+
pipelines:
45+
metrics:
46+
exporters:
47+
- otlp
48+
traces:
49+
exporters:
50+
- otlp
51+
- jaeger
52+
```
53+
54+
Save this file and pass it into helm:
55+
56+
```shell
57+
helm install opentelemetry-demo
58+
open-telemetry/opentelemetry-demo --values opentelemetry-demo-values.yaml
59+
```
60+
61+
Values provided in this way will be merged with the default values.
62+
63+
## Image Overrides [Helm/Kubernetes]
64+
65+
Each service has a key `imageOverride` which accepts a map of image override
66+
options, for example:
67+
68+
```yaml
69+
components:
70+
adService:
71+
imageOverride:
72+
repository: "my-repo"
73+
tag: "my-tag"
74+
pullSecrets: {}
75+
pullPolicy: Always
76+
```

0 commit comments

Comments
 (0)