feat(operator): Add support for the volume API (#13369)

Co-authored-by: Periklis Tsirakidis <[email protected]>

Author: jatinsu

operator/apis/loki/v1/lokistack_types.go

@@ -643,6 +643,13 @@ type QueryLimitSpec struct {
 	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors="urn:alm:descriptor:com.tectonic.ui:number",displayName="Cardinality Limit"
 	CardinalityLimit int32 `json:"cardinalityLimit,omitempty"`
+
+	// MaxVolumeSeries defines the maximum number of aggregated series in a log-volume response
+	//
+	// +optional
+	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors="urn:alm:descriptor:com.tectonic.ui:number",displayName="Max Volume Series"
+	MaxVolumeSeries int32 `json:"maxVolumeSeries,omitempty"`
 }
 
 // BlockedQueryType defines which type of query a blocked query should apply to.

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.1
-    createdAt: "2024-06-12T17:07:27Z"
+    createdAt: "2024-07-02T16:13:52Z"
     description: The Community Loki Operator provides Kubernetes native deployment
       and management of Loki and related logging components.
     features.operators.openshift.io/disconnected: "true"
@@ -384,6 +384,12 @@ spec:
         path: limits.global.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.global.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout
@@ -495,6 +501,12 @@ spec:
         path: limits.tenants.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.tenants.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout

operator/bundle/community-openshift/manifests/loki.grafana.com_lokistacks.yaml

@@ -191,6 +191,11 @@ spec:
                               that is returned by a metric query.
                             format: int32
                             type: integer
+                          maxVolumeSeries:
+                            description: MaxVolumeSeries defines the maximum number
+                              of aggregated series in a log-volume response
+                            format: int32
+                            type: integer
                           queryTimeout:
                             default: 3m
                             description: Timeout when querying ingesters or storage
@@ -366,6 +371,11 @@ spec:
                                 that is returned by a metric query.
                               format: int32
                               type: integer
+                            maxVolumeSeries:
+                              description: MaxVolumeSeries defines the maximum number
+                                of aggregated series in a log-volume response
+                              format: int32
+                              type: integer
                             queryTimeout:
                               default: 3m
                               description: Timeout when querying ingesters or storage

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.1
-    createdAt: "2024-06-12T17:07:25Z"
+    createdAt: "2024-07-02T16:13:50Z"
     description: The Community Loki Operator provides Kubernetes native deployment
       and management of Loki and related logging components.
     operators.operatorframework.io/builder: operator-sdk-unknown
@@ -377,6 +377,12 @@ spec:
         path: limits.global.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.global.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout
@@ -488,6 +494,12 @@ spec:
         path: limits.tenants.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.tenants.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout

operator/bundle/community/manifests/loki.grafana.com_lokistacks.yaml

@@ -191,6 +191,11 @@ spec:
                               that is returned by a metric query.
                             format: int32
                             type: integer
+                          maxVolumeSeries:
+                            description: MaxVolumeSeries defines the maximum number
+                              of aggregated series in a log-volume response
+                            format: int32
+                            type: integer
                           queryTimeout:
                             default: 3m
                             description: Timeout when querying ingesters or storage
@@ -366,6 +371,11 @@ spec:
                                 that is returned by a metric query.
                               format: int32
                               type: integer
+                            maxVolumeSeries:
+                              description: MaxVolumeSeries defines the maximum number
+                                of aggregated series in a log-volume response
+                              format: int32
+                              type: integer
                             queryTimeout:
                               default: 3m
                               description: Timeout when querying ingesters or storage

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-06-12T17:07:29Z"
+    createdAt: "2024-07-02T16:13:54Z"
     description: |
       The Loki Operator for OCP provides a means for configuring and managing a Loki stack for cluster logging.
       ## Prerequisites and Requirements
@@ -397,6 +397,12 @@ spec:
         path: limits.global.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.global.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout
@@ -508,6 +514,12 @@ spec:
         path: limits.tenants.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.tenants.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout

operator/bundle/openshift/manifests/loki.grafana.com_lokistacks.yaml

@@ -191,6 +191,11 @@ spec:
                               that is returned by a metric query.
                             format: int32
                             type: integer
+                          maxVolumeSeries:
+                            description: MaxVolumeSeries defines the maximum number
+                              of aggregated series in a log-volume response
+                            format: int32
+                            type: integer
                           queryTimeout:
                             default: 3m
                             description: Timeout when querying ingesters or storage
@@ -366,6 +371,11 @@ spec:
                                 that is returned by a metric query.
                               format: int32
                               type: integer
+                            maxVolumeSeries:
+                              description: MaxVolumeSeries defines the maximum number
+                                of aggregated series in a log-volume response
+                              format: int32
+                              type: integer
                             queryTimeout:
                               default: 3m
                               description: Timeout when querying ingesters or storage

operator/config/crd/bases/loki.grafana.com_lokistacks.yaml

@@ -173,6 +173,11 @@ spec:
                               that is returned by a metric query.
                             format: int32
                             type: integer
+                          maxVolumeSeries:
+                            description: MaxVolumeSeries defines the maximum number
+                              of aggregated series in a log-volume response
+                            format: int32
+                            type: integer
                           queryTimeout:
                             default: 3m
                             description: Timeout when querying ingesters or storage
@@ -348,6 +353,11 @@ spec:
                                 that is returned by a metric query.
                               format: int32
                               type: integer
+                            maxVolumeSeries:
+                              description: MaxVolumeSeries defines the maximum number
+                                of aggregated series in a log-volume response
+                              format: int32
+                              type: integer
                             queryTimeout:
                               default: 3m
                               description: Timeout when querying ingesters or storage

operator/config/manifests/community-openshift/bases/loki-operator.clusterserviceversion.yaml

@@ -297,6 +297,12 @@ spec:
         path: limits.global.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.global.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout
@@ -408,6 +414,12 @@ spec:
         path: limits.tenants.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.tenants.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout

operator/config/manifests/community/bases/loki-operator.clusterserviceversion.yaml

@@ -290,6 +290,12 @@ spec:
         path: limits.global.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.global.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout
@@ -401,6 +407,12 @@ spec:
         path: limits.tenants.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.tenants.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout

operator/config/manifests/openshift/bases/loki-operator.clusterserviceversion.yaml

@@ -309,6 +309,12 @@ spec:
         path: limits.global.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.global.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout
@@ -420,6 +426,12 @@ spec:
         path: limits.tenants.queries.maxQuerySeries
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
+      - description: MaxVolumeSeries defines the maximum number of aggregated series
+          in a log-volume response
+        displayName: Max Volume Series
+        path: limits.tenants.queries.maxVolumeSeries
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:number
       - description: Timeout when querying ingesters or storage during the execution
           of a query request.
         displayName: Query Timeout

operator/docs/operator/api.md

@@ -3165,6 +3165,18 @@ int32
 <p>CardinalityLimit defines the cardinality limit for index queries.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>maxVolumeSeries</code><br/>
+<em>
+int32
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>MaxVolumeSeries defines the maximum number of aggregated series in a log-volume response</p>
+</td>
+</tr>
 </tbody>
 </table>