Skip to content

Commit 99decf5

Browse files
[tempo-distributed] standardize .helmignore (#81)
* [tempo-distributed] standardize .helmignore Signed-off-by: TheRealNoob <mike1118@live.com> * fix linting Signed-off-by: TheRealNoob <mike1118@live.com> * fix linting Signed-off-by: TheRealNoob <mike1118@live.com> --------- Signed-off-by: TheRealNoob <mike1118@live.com> Co-authored-by: Jan-Otto Kröpke <mail@jkroepke.de>
1 parent e3add81 commit 99decf5

File tree

5 files changed

+44
-43
lines changed

5 files changed

+44
-43
lines changed

charts/tempo-distributed/.helmignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,7 @@
2121
.idea/
2222
*.tmproj
2323
.vscode/
24-
doc.yaml
25-
README.tpl
24+
# Helm plugin tooling
25+
ci/
26+
tests/
27+
*.gotmpl

charts/tempo-distributed/Chart.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@ apiVersion: v2
22
name: tempo-distributed
33
description: Grafana Tempo in MicroService mode
44
type: application
5-
version: 2.1.1
5+
version: 2.1.2
66
# renovate: docker=docker.io/grafana/tempo
77
appVersion: 2.10.0
88
kubeVersion: "^1.25.0-0"
9-
engine: gotpl
109
home: https://grafana.com/docs/tempo/latest/
1110
icon: https://raw.githubusercontent.com/grafana/tempo/main/cmd/tempo/app/static/tempo-icon.png
1211
sources:

charts/tempo-distributed/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# tempo-distributed
22

3-
![Version: 2.1.1](https://img.shields.io/badge/Version-2.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.10.0](https://img.shields.io/badge/AppVersion-2.10.0-informational?style=flat-square)
3+
![Version: 2.1.2](https://img.shields.io/badge/Version-2.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.10.0](https://img.shields.io/badge/AppVersion-2.10.0-informational?style=flat-square)
44

55
Grafana Tempo in MicroService mode
66

@@ -18,9 +18,9 @@ Kubernetes: `^1.25.0-0`
1818
| https://grafana.github.io/helm-charts | grafana-agent-operator(grafana-agent-operator) | 0.5.2 |
1919
| https://grafana.github.io/helm-charts | rollout_operator(rollout-operator) | 0.41.0 |
2020

21-
## Chart Repo
21+
## Chart Repository
2222

23-
Add the following repo to use the chart:
23+
Add the following repository to use the chart:
2424

2525
```console
2626
helm repo add grafana-community https://grafana-community.github.io/helm-charts
@@ -191,7 +191,7 @@ tempo:
191191
If you had ingester persistence enabled, you might need to manually change ownership of files in your PV if your CSI doesn't support fsGroup
192192

193193
### From Chart version >= 0.22.0
194-
Align Istio GRPC named port syntax. For example,
194+
Align Istio gRPC named port syntax. For example,
195195

196196
- otlp-grpc -> grpc-otlp
197197
- distributor-otlp-grpc -> grpc-distributor-otlp
@@ -257,7 +257,7 @@ Perform a regular Helm upgrade on the existing release. The new Deployment/State
257257

258258
By default all tracing protocols are disabled and you need to specify which protocols to enable for ingestion.
259259

260-
For example to enable Jaeger grpc thrift http and zipkin protocols:
260+
For example to enable Jaeger gRPC thrift http and zipkin protocols:
261261
```yaml
262262
traces:
263263
jaeger:
@@ -376,7 +376,7 @@ The memcached default args are removed and should be provided manually. The sett
376376
| distributor.affinity | string | Hard node and soft zone anti-affinity | Affinity for distributor pods. Passed through `tpl` and, thus, to be configured as string |
377377
| distributor.annotations | object | `{}` | Annotations for distributor deployment |
378378
| distributor.appProtocol | object | `{"grpc":null}` | Adds the appProtocol field to the distributor service. This allows distributor to work with istio protocol selection. |
379-
| distributor.appProtocol.grpc | string | `nil` | Set the optional grpc service protocol. Ex: "grpc", "http2" or "https" |
379+
| distributor.appProtocol.grpc | string | `nil` | Set the optional gRPC service protocol. Ex: "gRPC", "http2" or "https" |
380380
| distributor.autoscaling.behavior | object | `{}` | Autoscaling behavior configuration for the distributor |
381381
| distributor.autoscaling.enabled | bool | `false` | Enable autoscaling for the distributor |
382382
| distributor.autoscaling.maxReplicas | int | `3` | Maximum autoscaling replicas for the distributor |
@@ -601,7 +601,7 @@ The memcached default args are removed and should be provided manually. The sett
601601
| ingester.affinity | string | Soft node and soft zone anti-affinity | Affinity for ingester pods. Passed through `tpl` and, thus, to be configured as string |
602602
| ingester.annotations | object | `{}` | Annotations for the ingester StatefulSet |
603603
| ingester.appProtocol | object | `{"grpc":null}` | Adds the appProtocol field to the ingester service. This allows ingester to work with istio protocol selection. |
604-
| ingester.appProtocol.grpc | string | `nil` | Set the optional grpc service protocol. Ex: "grpc", "http2" or "https" |
604+
| ingester.appProtocol.grpc | string | `nil` | Set the optional gRPC service protocol. Ex: "gRPC", "http2" or "https" |
605605
| ingester.autoscaling.behavior | object | `{}` | Autoscaling behavior configuration for the ingester |
606606
| ingester.autoscaling.enabled | bool | `false` | Enable autoscaling for the ingester. WARNING: Autoscaling ingesters can result in lost data. Only do this if you know what you're doing. |
607607
| ingester.autoscaling.maxReplicas | int | `3` | Maximum autoscaling replicas for the ingester |
@@ -768,7 +768,7 @@ The memcached default args are removed and should be provided manually. The sett
768768
| metricsGenerator.affinity | string | Hard node and soft zone anti-affinity | Affinity for metrics-generator pods. Passed through `tpl` and, thus, to be configured as string |
769769
| metricsGenerator.annotations | object | `{}` | Annotations for the metrics-generator StatefulSet |
770770
| metricsGenerator.appProtocol | object | `{"grpc":null}` | Adds the appProtocol field to the metricsGenerator service. This allows metricsGenerator to work with istio protocol selection. |
771-
| metricsGenerator.appProtocol.grpc | string | `nil` | Set the optional grpc service protocol. Ex: "grpc", "http2" or "https" |
771+
| metricsGenerator.appProtocol.grpc | string | `nil` | Set the optional gRPC service protocol. Ex: "gRPC", "http2" or "https" |
772772
| metricsGenerator.config | object | `{"metrics_ingestion_time_range_slack":"30s","processor":{"service_graphs":{"dimensions":[],"histogram_buckets":[0.1,0.2,0.4,0.8,1.6,3.2,6.4,12.8],"max_items":10000,"wait":"10s","workers":10},"span_metrics":{"dimensions":[],"histogram_buckets":[0.002,0.004,0.008,0.016,0.032,0.064,0.128,0.256,0.512,1.02,2.05,4.1]}},"registry":{"collection_interval":"15s","external_labels":{},"stale_duration":"15m"},"storage":{"path":"/var/tempo/wal","remote_write":[],"remote_write_add_org_id_header":true,"remote_write_flush_deadline":"1m","wal":null},"traces_storage":{"path":"/var/tempo/traces"}}` | More information on configuration: https://grafana.com/docs/tempo/latest/configuration/#metrics-generator |
773773
| metricsGenerator.config.processor.service_graphs | object | `{"dimensions":[],"histogram_buckets":[0.1,0.2,0.4,0.8,1.6,3.2,6.4,12.8],"max_items":10000,"wait":"10s","workers":10}` | For processors to be enabled and generate metrics, pass the names of the processors to `overrides.defaults.metrics_generator.processors` value like `[service-graphs, span-metrics]`. |
774774
| metricsGenerator.config.processor.service_graphs.dimensions | list | `[]` | The resource and span attributes to be added to the service graph metrics, if present. |
@@ -867,14 +867,14 @@ The memcached default args are removed and should be provided manually. The sett
867867
| querier.affinity | string | Hard node and soft zone anti-affinity | Affinity for querier pods. Passed through `tpl` and, thus, to be configured as string |
868868
| querier.annotations | object | `{}` | Annotations for querier deployment |
869869
| querier.appProtocol | object | `{"grpc":null}` | Adds the appProtocol field to the querier service. This allows querier to work with istio protocol selection. |
870-
| querier.appProtocol.grpc | string | `nil` | Set the optional grpc service protocol. Ex: "grpc", "http2" or "https" |
870+
| querier.appProtocol.grpc | string | `nil` | Set the optional gRPC service protocol. Ex: "gRPC", "http2" or "https" |
871871
| querier.autoscaling.behavior | object | `{}` | Autoscaling behavior configuration for the querier |
872872
| querier.autoscaling.enabled | bool | `false` | Enable autoscaling for the querier |
873873
| querier.autoscaling.maxReplicas | int | `3` | Maximum autoscaling replicas for the querier |
874874
| querier.autoscaling.minReplicas | int | `1` | Minimum autoscaling replicas for the querier |
875875
| querier.autoscaling.targetCPUUtilizationPercentage | int | `60` | Target CPU utilisation percentage for the querier |
876876
| querier.autoscaling.targetMemoryUtilizationPercentage | string | `nil` | Target memory utilisation percentage for the querier |
877-
| querier.config.frontend_worker.grpc_client_config | object | `{}` | grpc client configuration |
877+
| querier.config.frontend_worker.grpc_client_config | object | `{}` | gRPC client configuration |
878878
| querier.config.max_concurrent_queries | int | `20` | This value controls the overall number of simultaneous subqueries that the querier will service at once. It does not distinguish between the types of queries. |
879879
| querier.config.search.query_timeout | string | `"30s"` | Timeout for search requests |
880880
| querier.config.trace_by_id.query_timeout | string | `"10s"` | Timeout for trace lookup requests |
@@ -909,7 +909,7 @@ The memcached default args are removed and should be provided manually. The sett
909909
| queryFrontend.affinity | string | Hard node and soft zone anti-affinity | Affinity for query-frontend pods. Passed through `tpl` and, thus, to be configured as string |
910910
| queryFrontend.annotations | object | `{}` | Annotations for the query-frontend Deployment |
911911
| queryFrontend.appProtocol | object | `{"grpc":null}` | Adds the appProtocol field to the queryFrontend service. This allows queryFrontend to work with istio protocol selection. |
912-
| queryFrontend.appProtocol.grpc | string | `nil` | Set the optional grpc service protocol. Ex: "grpc", "http2" or "https" |
912+
| queryFrontend.appProtocol.grpc | string | `nil` | Set the optional gRPC service protocol. Ex: "gRPC", "http2" or "https" |
913913
| queryFrontend.autoscaling.behavior | object | `{}` | Autoscaling behavior configuration for the query-frontend |
914914
| queryFrontend.autoscaling.enabled | bool | `false` | Enable autoscaling for the query-frontend |
915915
| queryFrontend.autoscaling.maxReplicas | int | `3` | Maximum autoscaling replicas for the query-frontend |
@@ -929,7 +929,7 @@ The memcached default args are removed and should be provided manually. The sett
929929
| queryFrontend.config.search.max_spans_per_span_set | int | `100` | The maximum allowed value of spans per span set. 0 disables this limit. |
930930
| queryFrontend.config.search.target_bytes_per_job | int | `104857600` | The target number of bytes for each job to handle when performing a backend search |
931931
| queryFrontend.config.trace_by_id | object | `{"query_shards":50}` | Trace by ID lookup configuration |
932-
| queryFrontend.config.trace_by_id.query_shards | int | `50` | The number of shards to split a trace by id query into. |
932+
| queryFrontend.config.trace_by_id.query_shards | int | `50` | The number of shards to split a trace by ID query into. |
933933
| queryFrontend.extraArgs | list | `[]` | Additional CLI args for the query-frontend |
934934
| queryFrontend.extraContainers | list | `[]` | Containers to add to the query-frontend pods |
935935
| queryFrontend.extraEnv | list | `[]` | Environment variables to add to the query-frontend pods |
@@ -970,7 +970,7 @@ The memcached default args are removed and should be provided manually. The sett
970970
| queryFrontend.replicas | int | `1` | Number of replicas for the query-frontend |
971971
| queryFrontend.resources | object | `{}` | Resource requests and limits for the query-frontend |
972972
| queryFrontend.service.annotations | object | `{}` | Annotations for queryFrontend service |
973-
| queryFrontend.service.grpcPort | int | `9095` | grpc Port of the query-frontend service |
973+
| queryFrontend.service.grpcPort | int | `9095` | gRPC Port of the query-frontend service |
974974
| queryFrontend.service.httpMetricsPort | int | `3200` | http Metrics port of the query-frontend service |
975975
| queryFrontend.service.labels | object | `{}` | Labels for queryFrontend service |
976976
| queryFrontend.service.loadBalancerIP | string | `""` | If type is LoadBalancer you can assign the IP to the LoadBalancer |
@@ -998,16 +998,16 @@ The memcached default args are removed and should be provided manually. The sett
998998
| server.httpListenPort | int | `3200` | HTTP server listen host |
999999
| server.http_server_read_timeout | string | `"30s"` | Read timeout for HTTP server |
10001000
| server.http_server_write_timeout | string | `"30s"` | Write timeout for HTTP server |
1001-
| server.logFormat | string | `"logfmt"` | Log format. Can be set to logfmt (default) or json. |
1001+
| server.logFormat | string | `"logfmt"` | Log format. Can be set to logfmt (default) or JSON. |
10021002
| server.logLevel | string | `"info"` | Log level. Can be set to debug, info (default), warn, error |
10031003
| serviceAccount.annotations | object | `{}` | Annotations for the service account |
10041004
| serviceAccount.automountServiceAccountToken | bool | `false` | |
10051005
| serviceAccount.create | bool | `true` | Specifies whether a ServiceAccount should be created |
10061006
| serviceAccount.imagePullSecrets | list | `[]` | Image pull secrets for the service account |
10071007
| serviceAccount.labels | object | `{}` | Labels for the service account |
10081008
| serviceAccount.name | string | `nil` | The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template |
1009-
| storage.admin.backend | string | `"filesystem"` | The supported storage backends are gcs, s3 and azure, as specified in https://grafana.com/docs/enterprise-traces/latest/configure/reference/#admin_client_config |
1010-
| storage.trace.backend | string | `"local"` | The supported storage backends are gcs, s3 and azure, as specified in https://grafana.com/docs/tempo/latest/configuration/#storage |
1009+
| storage.admin.backend | string | `"filesystem"` | The supported storage backends are gcs, s3 and Azure, as specified in https://grafana.com/docs/enterprise-traces/latest/configure/reference/#admin_client_config |
1010+
| storage.trace.backend | string | `"local"` | The supported storage backends are gcs, s3 and Azure, as specified in https://grafana.com/docs/tempo/latest/configuration/#storage |
10111011
| storage.trace.block.dedicated_columns | list | `[]` | Lis with dedicated attribute columns (only for vParquet3 or later) |
10121012
| storage.trace.block.version | string | `nil` | The supported block versions are specified here https://grafana.com/docs/tempo/latest/configuration/parquet/ |
10131013
| storage.trace.blocklist_poll | string | `"5m"` | How often to repoll the backend for new blocks |
@@ -1060,8 +1060,8 @@ The memcached default args are removed and should be provided manually. The sett
10601060
| tokengenJob.image.tag | string | `nil` | Docker image tag for the tokengenJob image. Overrides `tempo.image.tag` |
10611061
| tokengenJob.initContainers | list | `[]` | |
10621062
| tokengenJob.storeTokenInSecret | bool | `false` | |
1063-
| traces.jaeger.grpc.enabled | bool | `false` | Enable Tempo to ingest Jaeger GRPC traces |
1064-
| traces.jaeger.grpc.receiverConfig | object | `{}` | Jaeger GRPC receiver config |
1063+
| traces.jaeger.grpc.enabled | bool | `false` | Enable Tempo to ingest Jaeger gRPC traces |
1064+
| traces.jaeger.grpc.receiverConfig | object | `{}` | Jaeger gRPC receiver config |
10651065
| traces.jaeger.thriftBinary.enabled | bool | `false` | Enable Tempo to ingest Jaeger Thrift Binary traces |
10661066
| traces.jaeger.thriftBinary.receiverConfig | object | `{}` | Jaeger Thrift Binary receiver config |
10671067
| traces.jaeger.thriftCompact.enabled | bool | `false` | Enable Tempo to ingest Jaeger Thrift Compact traces |
@@ -1071,9 +1071,9 @@ The memcached default args are removed and should be provided manually. The sett
10711071
| traces.kafka | object | `{}` | Enable Tempo to ingest traces from Kafka. Reference: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kafkareceiver |
10721072
| traces.opencensus.enabled | bool | `false` | Enable Tempo to ingest Open Census traces |
10731073
| traces.opencensus.receiverConfig | object | `{}` | Open Census receiver config |
1074-
| traces.otlp.grpc.enabled | bool | `false` | Enable Tempo to ingest Open Telemetry GRPC traces |
1074+
| traces.otlp.grpc.enabled | bool | `false` | Enable Tempo to ingest Open Telemetry gRPC traces |
10751075
| traces.otlp.grpc.port | int | `4317` | Default OTLP gRPC port |
1076-
| traces.otlp.grpc.receiverConfig | object | `{}` | GRPC receiver advanced config |
1076+
| traces.otlp.grpc.receiverConfig | object | `{}` | gRPC receiver advanced config |
10771077
| traces.otlp.http.enabled | bool | `false` | Enable Tempo to ingest Open Telemetry HTTP traces |
10781078
| traces.otlp.http.receiverConfig | object | `{}` | HTTP receiver advanced config |
10791079
| traces.zipkin.enabled | bool | `false` | Enable Tempo to ingest Zipkin traces |

charts/tempo-distributed/README.md.gotmpl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
{{ template "chart.requirementsSection" . }}
1010

11-
## Chart Repo
11+
## Chart Repository
1212

13-
Add the following repo to use the chart:
13+
Add the following repository to use the chart:
1414

1515
```console
1616
helm repo add grafana-community https://grafana-community.github.io/helm-charts
@@ -183,7 +183,7 @@ tempo:
183183
If you had ingester persistence enabled, you might need to manually change ownership of files in your PV if your CSI doesn't support fsGroup
184184

185185
### From Chart version >= 0.22.0
186-
Align Istio GRPC named port syntax. For example,
186+
Align Istio gRPC named port syntax. For example,
187187

188188
- otlp-grpc -> grpc-otlp
189189
- distributor-otlp-grpc -> grpc-distributor-otlp
@@ -249,7 +249,7 @@ Perform a regular Helm upgrade on the existing release. The new Deployment/State
249249

250250
By default all tracing protocols are disabled and you need to specify which protocols to enable for ingestion.
251251

252-
For example to enable Jaeger grpc thrift http and zipkin protocols:
252+
For example to enable Jaeger gRPC thrift http and zipkin protocols:
253253
```yaml
254254
traces:
255255
jaeger:

0 commit comments

Comments
 (0)