@@ -32,8 +32,20 @@ command:
32
32
helm install my-otel-demo open-telemetry/opentelemetry-demo
33
33
```
34
34
35
- > ** Note** The OpenTelemetry Demo Helm chart version 0.11.0 or greater is
36
- > required to perform all usage methods mentioned below.
35
+ {{% alert title="Note" color="info" %}}
36
+
37
+ The OpenTelemetry Demo Helm chart does not support being upgraded from one
38
+ version to another. If you need to upgrade the chart, you must first delete the
39
+ existing release and then install the new version.
40
+
41
+ {{% /alert %}}
42
+
43
+ {{% alert title="Note" color="info" %}}
44
+
45
+ The OpenTelemetry Demo Helm chart version 0.11.0 or greater is required to
46
+ perform all usage methods mentioned below.
47
+
48
+ {{% /alert %}}
37
49
38
50
## Install using kubectl
39
51
@@ -44,8 +56,20 @@ cluster.
44
56
kubectl apply --namespace otel-demo -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-demo/main/kubernetes/opentelemetry-demo.yaml
45
57
```
46
58
47
- > ** Note** These manifests are generated from the Helm chart and are provided
48
- > for convenience. It is recommended to use the Helm chart for installation.
59
+ {{% alert title="Note" color="info" %}}
60
+
61
+ The OpenTelemetry Demo Kubernetes manifests do not support being upgraded from
62
+ one version to another. If you need to upgrade the demo, you must first delete
63
+ the existing resources and then install the new version.
64
+
65
+ {{% /alert %}}
66
+
67
+ {{% alert title="Note" color="info" %}}
68
+
69
+ These manifests are generated from the Helm chart and are provided for
70
+ convenience. It is recommended to use the Helm chart for installation.
71
+
72
+ {{% /alert %}}
49
73
50
74
## Use the Demo
51
75
@@ -63,10 +87,14 @@ To expose the frontendproxy service use the following command (replace
63
87
kubectl port-forward svc/my-otel-demo-frontendproxy 8080:8080
64
88
```
65
89
66
- > ** Note** : ` kubectl port-forward ` will proxy the port until the process
67
- > terminates. You may need to create separate terminal sessions for each use of
68
- > ` kubectl port-forward ` , and use <kbd >Ctrl-C</kbd > to terminate the process
69
- > when done.
90
+ {{% alert title="Note" color="info" %}}
91
+
92
+ ` kubectl port-forward ` proxies the port until the process terminates. You might
93
+ need to create separate terminal sessions for each use of
94
+ ` kubectl port-forward ` , and use <kbd >Ctrl-C</kbd > to terminate the process when
95
+ done.
96
+
97
+ {{% /alert %}}
70
98
71
99
With the frontendproxy port-forward set up, you can access:
72
100
@@ -84,9 +112,13 @@ options. {{% /alert %}}
84
112
85
113
#### Configure ingress resources
86
114
87
- > ** Note** Kubernetes clusters may not have the proper infrastructure components
88
- > to enable LoadBalancer service types or ingress resources. Verify your cluster
89
- > has the proper support before using these configuration options.
115
+ {{% alert title="Note" color="info" %}}
116
+
117
+ Kubernetes clusters might not have the proper infrastructure components to
118
+ enable LoadBalancer service types or ingress resources. Verify your cluster has
119
+ the proper support before using these configuration options.
120
+
121
+ {{% /alert %}}
90
122
91
123
Each demo component (ie: frontendproxy) offers a way to have its Kubernetes
92
124
service type configured. By default, these will not be created, but you can
@@ -144,23 +176,6 @@ components:
144
176
value: http://otel-demo.my-domain.com/otlp-http/v1/traces
145
177
` ` `
146
178
147
- # ### Installation with a values file
148
-
149
- To install the Helm chart with a custom `my-values-file.yaml` values file use :
150
-
151
- ` ` ` shell
152
- helm install my-otel-demo open-telemetry/opentelemetry-demo --values my-values-file.yaml
153
- ` ` `
154
-
155
- With the frontendproxy and Collector exposed, you can access the demo UI at the
156
- base path for the frontendproxy. Other demo components can be accessed at the
157
- following sub-paths :
158
-
159
- - Web store : ` /` (base)
160
- - Grafana : ` /grafana`
161
- - Load Generator UI : ` /loadgen/` (must include trailing slash)
162
- - Jaeger UI : ` /jaeger/ui`
163
-
164
179
# # Bring your own backend
165
180
166
181
Likely you want to use the web store as a demo application for an observability
0 commit comments