chore(operator): fix API documentation relative to OTEL (#14246)

grafana · Sep 25, 2024 · eaedd97 · eaedd97
1 parent 5978f13
commit eaedd97
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 65 deletions.
diff --git a/operator/apis/loki/v1/lokistack_types.go b/operator/apis/loki/v1/lokistack_types.go
@@ -887,7 +887,7 @@ type OTLPResourceAttributesSpec struct {
 // tenants.
 type GlobalOTLPSpec struct {
 	// IndexedResourceAttributes contains the global configuration for resource attributes
-	// to store them as index labels or structured metadata or drop them altogether.
+	// to store them as index labels.
 	//
 	// +optional
 	// +kubebuilder:validation:Optional
@@ -909,15 +909,15 @@ type OTLPSpec struct {
 	ResourceAttributes *OTLPResourceAttributesSpec `json:"resourceAttributes,omitempty"`
 
 	// ScopeAttributes contains the configuration for scope attributes
-	// to store them as index labels or structured metadata or drop them altogether.
+	// to store them as structured metadata or drop them altogether.
 	//
 	// +optional
 	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Scope Attributes"
 	ScopeAttributes []OTLPAttributesSpec `json:"scopeAttributes,omitempty"`
 
 	// LogAttributes contains the configuration for log attributes
-	// to store them as index labels or structured metadata or drop them altogether.
+	// to store them as structured metadata or drop them altogether.
 	//
 	// +optional
 	// +kubebuilder:validation:Optional

diff --git a/operator/bundle/community-openshift/manifests/loki-operator.clusterserviceversion.yaml b/operator/bundle/community-openshift/manifests/loki-operator.clusterserviceversion.yaml
@@ -150,7 +150,7 @@ metadata:
     categories: OpenShift Optional, Logging & Tracing
     certified: "false"
     containerImage: docker.io/grafana/loki-operator:0.6.2
-    createdAt: "2024-09-09T09:16:58Z"
+    createdAt: "2024-09-25T09:56:42Z"
     description: The Community Loki Operator provides Kubernetes native deployment
       and management of Loki and related logging components.
     features.operators.openshift.io/disconnected: "true"
@@ -362,12 +362,11 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
       - description: IndexedResourceAttributes contains the global configuration for
-          resource attributes to store them as index labels or structured metadata
-          or drop them altogether.
+          resource attributes to store them as index labels.
         displayName: Indexed Resource Attributes
         path: limits.global.otlp.indexedResourceAttributes
       - description: LogAttributes contains the configuration for log attributes to
-          store them as index labels or structured metadata or drop them altogether.
+          store them as structured metadata or drop them altogether.
         displayName: Log Attributes
         path: limits.global.otlp.logAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -408,7 +407,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
       - description: ScopeAttributes contains the configuration for scope attributes
-          to store them as index labels or structured metadata or drop them altogether.
+          to store them as structured metadata or drop them altogether.
         displayName: Scope Attributes
         path: limits.global.otlp.scopeAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -518,7 +517,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
       - description: LogAttributes contains the configuration for log attributes to
-          store them as index labels or structured metadata or drop them altogether.
+          store them as structured metadata or drop them altogether.
         displayName: Log Attributes
         path: limits.tenants.otlp.logAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -559,7 +558,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
       - description: ScopeAttributes contains the configuration for scope attributes
-          to store them as index labels or structured metadata or drop them altogether.
+          to store them as structured metadata or drop them altogether.
         displayName: Scope Attributes
         path: limits.tenants.otlp.scopeAttributes
       - description: Action defines the indexing action for the selected attributes.

diff --git a/operator/bundle/community-openshift/manifests/loki.grafana.com_lokistacks.yaml b/operator/bundle/community-openshift/manifests/loki.grafana.com_lokistacks.yaml
@@ -173,14 +173,14 @@ spec:
                           indexedResourceAttributes:
                             description: |-
                               IndexedResourceAttributes contains the global configuration for resource attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as index labels.
                             items:
                               type: string
                             type: array
                           logAttributes:
                             description: |-
                               LogAttributes contains the configuration for log attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as structured metadata or drop them altogether.
                             items:
                               description: |-
                                 OTLPAttributesSpec contains the configuration for a set of attributes
@@ -256,7 +256,7 @@ spec:
                           scopeAttributes:
                             description: |-
                               ScopeAttributes contains the configuration for scope attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as structured metadata or drop them altogether.
                             items:
                               description: |-
                                 OTLPAttributesSpec contains the configuration for a set of attributes
@@ -437,7 +437,7 @@ spec:
                             logAttributes:
                               description: |-
                                 LogAttributes contains the configuration for log attributes
-                                to store them as index labels or structured metadata or drop them altogether.
+                                to store them as structured metadata or drop them altogether.
                               items:
                                 description: |-
                                   OTLPAttributesSpec contains the configuration for a set of attributes
@@ -513,7 +513,7 @@ spec:
                             scopeAttributes:
                               description: |-
                                 ScopeAttributes contains the configuration for scope attributes
-                                to store them as index labels or structured metadata or drop them altogether.
+                                to store them as structured metadata or drop them altogether.
                               items:
                                 description: |-
                                   OTLPAttributesSpec contains the configuration for a set of attributes

diff --git a/operator/bundle/community/manifests/loki-operator.clusterserviceversion.yaml b/operator/bundle/community/manifests/loki-operator.clusterserviceversion.yaml
@@ -150,7 +150,7 @@ metadata:
     categories: OpenShift Optional, Logging & Tracing
     certified: "false"
     containerImage: docker.io/grafana/loki-operator:0.6.2
-    createdAt: "2024-09-09T09:16:56Z"
+    createdAt: "2024-09-25T09:56:40Z"
     description: The Community Loki Operator provides Kubernetes native deployment
       and management of Loki and related logging components.
     operators.operatorframework.io/builder: operator-sdk-unknown
@@ -355,12 +355,11 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
       - description: IndexedResourceAttributes contains the global configuration for
-          resource attributes to store them as index labels or structured metadata
-          or drop them altogether.
+          resource attributes to store them as index labels.
         displayName: Indexed Resource Attributes
         path: limits.global.otlp.indexedResourceAttributes
       - description: LogAttributes contains the configuration for log attributes to
-          store them as index labels or structured metadata or drop them altogether.
+          store them as structured metadata or drop them altogether.
         displayName: Log Attributes
         path: limits.global.otlp.logAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -401,7 +400,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
       - description: ScopeAttributes contains the configuration for scope attributes
-          to store them as index labels or structured metadata or drop them altogether.
+          to store them as structured metadata or drop them altogether.
         displayName: Scope Attributes
         path: limits.global.otlp.scopeAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -511,7 +510,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
       - description: LogAttributes contains the configuration for log attributes to
-          store them as index labels or structured metadata or drop them altogether.
+          store them as structured metadata or drop them altogether.
         displayName: Log Attributes
         path: limits.tenants.otlp.logAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -552,7 +551,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
       - description: ScopeAttributes contains the configuration for scope attributes
-          to store them as index labels or structured metadata or drop them altogether.
+          to store them as structured metadata or drop them altogether.
         displayName: Scope Attributes
         path: limits.tenants.otlp.scopeAttributes
       - description: Action defines the indexing action for the selected attributes.

diff --git a/operator/bundle/community/manifests/loki.grafana.com_lokistacks.yaml b/operator/bundle/community/manifests/loki.grafana.com_lokistacks.yaml
@@ -173,14 +173,14 @@ spec:
                           indexedResourceAttributes:
                             description: |-
                               IndexedResourceAttributes contains the global configuration for resource attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as index labels.
                             items:
                               type: string
                             type: array
                           logAttributes:
                             description: |-
                               LogAttributes contains the configuration for log attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as structured metadata or drop them altogether.
                             items:
                               description: |-
                                 OTLPAttributesSpec contains the configuration for a set of attributes
@@ -256,7 +256,7 @@ spec:
                           scopeAttributes:
                             description: |-
                               ScopeAttributes contains the configuration for scope attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as structured metadata or drop them altogether.
                             items:
                               description: |-
                                 OTLPAttributesSpec contains the configuration for a set of attributes
@@ -437,7 +437,7 @@ spec:
                             logAttributes:
                               description: |-
                                 LogAttributes contains the configuration for log attributes
-                                to store them as index labels or structured metadata or drop them altogether.
+                                to store them as structured metadata or drop them altogether.
                               items:
                                 description: |-
                                   OTLPAttributesSpec contains the configuration for a set of attributes
@@ -513,7 +513,7 @@ spec:
                             scopeAttributes:
                               description: |-
                                 ScopeAttributes contains the configuration for scope attributes
-                                to store them as index labels or structured metadata or drop them altogether.
+                                to store them as structured metadata or drop them altogether.
                               items:
                                 description: |-
                                   OTLPAttributesSpec contains the configuration for a set of attributes

diff --git a/operator/bundle/openshift/manifests/loki-operator.clusterserviceversion.yaml b/operator/bundle/openshift/manifests/loki-operator.clusterserviceversion.yaml
@@ -150,7 +150,7 @@ metadata:
     categories: OpenShift Optional, Logging & Tracing
     certified: "false"
     containerImage: quay.io/openshift-logging/loki-operator:0.1.0
-    createdAt: "2024-09-09T09:17:00Z"
+    createdAt: "2024-09-25T09:56:44Z"
     description: |
       The Loki Operator for OCP provides a means for configuring and managing a Loki stack for cluster logging.
       ## Prerequisites and Requirements
@@ -375,12 +375,11 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
       - description: IndexedResourceAttributes contains the global configuration for
-          resource attributes to store them as index labels or structured metadata
-          or drop them altogether.
+          resource attributes to store them as index labels.
         displayName: Indexed Resource Attributes
         path: limits.global.otlp.indexedResourceAttributes
       - description: LogAttributes contains the configuration for log attributes to
-          store them as index labels or structured metadata or drop them altogether.
+          store them as structured metadata or drop them altogether.
         displayName: Log Attributes
         path: limits.global.otlp.logAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -421,7 +420,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
       - description: ScopeAttributes contains the configuration for scope attributes
-          to store them as index labels or structured metadata or drop them altogether.
+          to store them as structured metadata or drop them altogether.
         displayName: Scope Attributes
         path: limits.global.otlp.scopeAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -531,7 +530,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
       - description: LogAttributes contains the configuration for log attributes to
-          store them as index labels or structured metadata or drop them altogether.
+          store them as structured metadata or drop them altogether.
         displayName: Log Attributes
         path: limits.tenants.otlp.logAttributes
       - description: Action defines the indexing action for the selected attributes.
@@ -572,7 +571,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
       - description: ScopeAttributes contains the configuration for scope attributes
-          to store them as index labels or structured metadata or drop them altogether.
+          to store them as structured metadata or drop them altogether.
         displayName: Scope Attributes
         path: limits.tenants.otlp.scopeAttributes
       - description: Action defines the indexing action for the selected attributes.

diff --git a/operator/bundle/openshift/manifests/loki.grafana.com_lokistacks.yaml b/operator/bundle/openshift/manifests/loki.grafana.com_lokistacks.yaml
@@ -173,14 +173,14 @@ spec:
                           indexedResourceAttributes:
                             description: |-
                               IndexedResourceAttributes contains the global configuration for resource attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as index labels.
                             items:
                               type: string
                             type: array
                           logAttributes:
                             description: |-
                               LogAttributes contains the configuration for log attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as structured metadata or drop them altogether.
                             items:
                               description: |-
                                 OTLPAttributesSpec contains the configuration for a set of attributes
@@ -256,7 +256,7 @@ spec:
                           scopeAttributes:
                             description: |-
                               ScopeAttributes contains the configuration for scope attributes
-                              to store them as index labels or structured metadata or drop them altogether.
+                              to store them as structured metadata or drop them altogether.
                             items:
                               description: |-
                                 OTLPAttributesSpec contains the configuration for a set of attributes
@@ -437,7 +437,7 @@ spec:
                             logAttributes:
                               description: |-
                                 LogAttributes contains the configuration for log attributes
-                                to store them as index labels or structured metadata or drop them altogether.
+                                to store them as structured metadata or drop them altogether.
                               items:
                                 description: |-
                                   OTLPAttributesSpec contains the configuration for a set of attributes
@@ -513,7 +513,7 @@ spec:
                             scopeAttributes:
                               description: |-
                                 ScopeAttributes contains the configuration for scope attributes
-                                to store them as index labels or structured metadata or drop them altogether.
+                                to store them as structured metadata or drop them altogether.
                               items:
                                 description: |-
                                   OTLPAttributesSpec contains the configuration for a set of attributes