[chore] Improve replication factor documentation (grafana#1042)

* Improve replication factor documentation Signed-off-by: Israel Blancas <[email protected]> * Update apis/tempo/v1alpha1/tempostack_types.go Co-authored-by: Andreas Gerstmayr <[email protected]> * Apply changes requested in CR Signed-off-by: Israel Blancas <[email protected]> --------- Signed-off-by: Israel Blancas <[email protected]> Co-authored-by: Andreas Gerstmayr <[email protected]>
tempooperatorbot · Oct 3, 2024 · 78b5cea · 78b5cea
1 parent f4cb97c
commit 78b5cea
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 18 deletions.
diff --git a/apis/tempo/v1alpha1/tempostack_types.go b/apis/tempo/v1alpha1/tempostack_types.go
@@ -103,7 +103,7 @@ type TempoStackSpec struct {
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Tempo Component Templates"
 	Template TempoTemplateSpec `json:"template,omitempty"`
 
-	// ReplicationFactor is used to define how many component replicas should exist.
+	// The replication factor is a configuration setting that determines how many ingesters need to acknowledge the data from the distributors before accepting a span.
 	//
 	// +optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Replication Factor"

diff --git a/bundle/community/manifests/tempo-operator.clusterserviceversion.yaml b/bundle/community/manifests/tempo-operator.clusterserviceversion.yaml
@@ -74,7 +74,7 @@ metadata:
     capabilities: Deep Insights
     categories: Logging & Tracing,Monitoring
     containerImage: ghcr.io/grafana/tempo-operator/tempo-operator:v0.13.0
-    createdAt: "2024-09-21T07:00:19Z"
+    createdAt: "2024-10-03T09:33:24Z"
     description: Create and manage deployments of Tempo, a high-scale distributed
       tracing backend.
     operatorframework.io/cluster-monitoring: "true"
@@ -718,8 +718,9 @@ spec:
           0 to 1.
         displayName: Sampling Fraction
         path: observability.tracing.sampling_fraction
-      - description: ReplicationFactor is used to define how many component replicas
-          should exist.
+      - description: The replication factor is a configuration setting that determines
+          how many ingesters need to acknowledge the data from the distributors before
+          accepting a span.
         displayName: Replication Factor
         path: replicationFactor
       - description: Resources defines resources configuration.

diff --git a/bundle/community/manifests/tempo.grafana.com_tempostacks.yaml b/bundle/community/manifests/tempo.grafana.com_tempostacks.yaml
@@ -293,8 +293,9 @@ spec:
                     type: object
                 type: object
               replicationFactor:
-                description: ReplicationFactor is used to define how many component
-                  replicas should exist.
+                description: The replication factor is a configuration setting that
+                  determines how many ingesters need to acknowledge the data from
+                  the distributors before accepting a span.
                 type: integer
               resources:
                 description: Resources defines resources configuration.

diff --git a/bundle/openshift/manifests/tempo-operator.clusterserviceversion.yaml b/bundle/openshift/manifests/tempo-operator.clusterserviceversion.yaml
@@ -74,7 +74,7 @@ metadata:
     capabilities: Deep Insights
     categories: Logging & Tracing,Monitoring
     containerImage: ghcr.io/grafana/tempo-operator/tempo-operator:v0.13.0
-    createdAt: "2024-09-21T07:00:18Z"
+    createdAt: "2024-10-03T09:33:23Z"
     description: Create and manage deployments of Tempo, a high-scale distributed
       tracing backend.
     operatorframework.io/cluster-monitoring: "true"
@@ -718,8 +718,9 @@ spec:
           0 to 1.
         displayName: Sampling Fraction
         path: observability.tracing.sampling_fraction
-      - description: ReplicationFactor is used to define how many component replicas
-          should exist.
+      - description: The replication factor is a configuration setting that determines
+          how many ingesters need to acknowledge the data from the distributors before
+          accepting a span.
         displayName: Replication Factor
         path: replicationFactor
       - description: Resources defines resources configuration.

diff --git a/bundle/openshift/manifests/tempo.grafana.com_tempostacks.yaml b/bundle/openshift/manifests/tempo.grafana.com_tempostacks.yaml
@@ -293,8 +293,9 @@ spec:
                     type: object
                 type: object
               replicationFactor:
-                description: ReplicationFactor is used to define how many component
-                  replicas should exist.
+                description: The replication factor is a configuration setting that
+                  determines how many ingesters need to acknowledge the data from
+                  the distributors before accepting a span.
                 type: integer
               resources:
                 description: Resources defines resources configuration.

diff --git a/config/crd/bases/tempo.grafana.com_tempostacks.yaml b/config/crd/bases/tempo.grafana.com_tempostacks.yaml
@@ -289,8 +289,9 @@ spec:
                     type: object
                 type: object
               replicationFactor:
-                description: ReplicationFactor is used to define how many component
-                  replicas should exist.
+                description: The replication factor is a configuration setting that
+                  determines how many ingesters need to acknowledge the data from
+                  the distributors before accepting a span.
                 type: integer
               resources:
                 description: Resources defines resources configuration.

diff --git a/config/manifests/community/bases/tempo-operator.clusterserviceversion.yaml b/config/manifests/community/bases/tempo-operator.clusterserviceversion.yaml
@@ -647,8 +647,9 @@ spec:
           0 to 1.
         displayName: Sampling Fraction
         path: observability.tracing.sampling_fraction
-      - description: ReplicationFactor is used to define how many component replicas
-          should exist.
+      - description: The replication factor is a configuration setting that determines
+          how many ingesters need to acknowledge the data from the distributors before
+          accepting a span.
         displayName: Replication Factor
         path: replicationFactor
       - description: Resources defines resources configuration.

diff --git a/config/manifests/openshift/bases/tempo-operator.clusterserviceversion.yaml b/config/manifests/openshift/bases/tempo-operator.clusterserviceversion.yaml
@@ -647,8 +647,9 @@ spec:
           0 to 1.
         displayName: Sampling Fraction
         path: observability.tracing.sampling_fraction
-      - description: ReplicationFactor is used to define how many component replicas
-          should exist.
+      - description: The replication factor is a configuration setting that determines
+          how many ingesters need to acknowledge the data from the distributors before
+          accepting a span.
         displayName: Replication Factor
         path: replicationFactor
       - description: Resources defines resources configuration.

diff --git a/docs/spec/tempo.grafana.com_tempostacks.yaml b/docs/spec/tempo.grafana.com_tempostacks.yaml
@@ -54,7 +54,7 @@ spec:                                    # TempoStackSpec defines the desired st
     tracing:                             # Tracing defines a config for operands.
       jaeger_agent_endpoint: "localhost:6831" # JaegerAgentEndpoint defines the jaeger endpoint data gets send to.
       sampling_fraction: ""              # SamplingFraction defines the sampling ratio. Valid values are 0 to 1.
-  replicationFactor: 0                   # ReplicationFactor is used to define how many component replicas should exist.
+  replicationFactor: 0                   # The replication factor is a configuration setting that determines how many ingesters need to acknowledge the data from the distributors before accepting a span.
   retention:                             # Retention period defined by dataset. User can specify how long data should be stored.
     global:                              # Global is used to configure global retention.
       traces: ""                         # Traces defines retention period. Supported parameter suffixes are "s", "m" and "h". example: 336h default: value is 48h.