From 3901a735fdb4f07b4b279bb9af564ea0a81bb5f8 Mon Sep 17 00:00:00 2001 From: Brian Oldfield Date: Fri, 22 Nov 2024 09:14:46 -0800 Subject: [PATCH] addressing doc lint issues Signed-off-by: Brian Oldfield --- charts/tempo-distributed/README.md | 5 +++-- charts/tempo-distributed/values.yaml | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/charts/tempo-distributed/README.md b/charts/tempo-distributed/README.md index d0ff3ab320..e4a93e4904 100755 --- a/charts/tempo-distributed/README.md +++ b/charts/tempo-distributed/README.md @@ -509,7 +509,7 @@ The memcached default args are removed and should be provided manually. The sett | global.image.registry | string | `"docker.io"` | Overrides the Docker registry globally for all images, excluding enterprise. | | global.priorityClassName | string | `nil` | Overrides the priorityClassName for all pods | | global_overrides.per_tenant_override_config | string | `"/runtime-config/overrides.yaml"` | | -| ingester.addIngesterNamePrefix | bool | `false` | Optionally allow adding 'tempo-' prefix to Ingester StatefulSet names, this is helpful when running multiple LTGM components in a single namespace. | +| ingester.addNamePrefix | bool | `false` | Optionally allow adding 'tempo-' prefix to Ingester StatefulSet names, this is helpful when running multiple LTGM components in a single namespace. | | ingester.affinity | string | Soft node and soft zone anti-affinity | Affinity for ingester pods. Passed through `tpl` and, thus, to be configured as string | | ingester.annotations | object | `{}` | Annotations for the ingester StatefulSet | | ingester.appProtocol | object | `{"grpc":null}` | Adds the appProtocol field to the ingester service. This allows ingester to work with istio protocol selection. | @@ -552,7 +552,7 @@ The memcached default args are removed and should be provided manually. The sett | ingester.priorityClassName | string | `nil` | The name of the PriorityClass for ingester pods | | ingester.replicas | int | `3` | Number of replicas for the ingester | | ingester.resources | object | `{}` | Resource requests and limits for the ingester | -| ingester.rolloutGroupPrefix | string | `null` | Optionally add supplied prefix to the Ingester StatefulSet rollout-group label. This is helpful when running multiple LTGM components in a single namespace. | +| ingester.rolloutGroupPrefix | string | `""` | Optionally add supplied prefix to the Ingester StatefulSet rollout-group label. This is helpful when running multiple LTGM components in a single namespace. | | ingester.service.annotations | object | `{}` | Annotations for ingester service | | ingester.service.internalTrafficPolicy | string | `"Cluster"` | https://kubernetes.io/docs/concepts/services-networking/service-traffic-policy/ | | ingester.service.type | string | `"ClusterIP"` | Type of the service: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types | @@ -576,6 +576,7 @@ The memcached default args are removed and should be provided manually. The sett | ingester.zoneAwareReplication.zones[2].extraAffinity | object | `{}` | extraAffinity adds user defined custom affinity rules (merged with generated rules) | | ingester.zoneAwareReplication.zones[2].nodeSelector | string | `nil` | nodeselector to restrict where pods of this zone can be placed. E.g.: nodeSelector: topology.kubernetes.io/zone: zone-c | | ingester.zoneAwareReplication.zones[2].storageClass | string | `nil` | Ingester data Persistent Volume Storage Class If defined, storageClassName: If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning If undefined or set to null (the default), then fall back to the value of `ingester.persistentVolume.storageClass`. | +| ingester.zoneNamespacedServiceName | bool | `false` | Optionally namespace StatefulSet serviceName with zone. ex: temp-ingester-zone-a | | license.contents | string | `"NOTAVALIDLICENSE"` | | | license.external | bool | `false` | | | license.secretName | string | `"{{ include \"tempo.resourceName\" (dict \"ctx\" . \"component\" \"license\") }}"` | | diff --git a/charts/tempo-distributed/values.yaml b/charts/tempo-distributed/values.yaml index 9092694975..49439f0e49 100755 --- a/charts/tempo-distributed/values.yaml +++ b/charts/tempo-distributed/values.yaml @@ -294,11 +294,11 @@ ingester: # If set to "-", then use `storageClassName: ""`, which disables dynamic provisioning # If undefined or set to null (the default), then fall back to the value of `ingester.persistentVolume.storageClass`. storageClass: null - # optionally allow adding 'tempo-' prefix to ingester name label + # -- Optionally allow adding 'tempo-' prefix to Ingester StatefulSet names, this is helpful when running multiple LTGM components in a single namespace. addNamePrefix: false - # optionally allow adding arbitrary prefix to the ingester rollout-group label + # -- Optionally add supplied prefix to the Ingester StatefulSet rollout-group label. This is helpful when running multiple LTGM components in a single namespace. rolloutGroupPrefix: '' - # optionally namespace StatefulSet serviceName with zone. ex: temp-ingester-zone-a + # -- Optionally namespace StatefulSet serviceName with zone. ex: temp-ingester-zone-a zoneNamespacedServiceName: false # Configuration for the metrics-generator