store client information on storageconsumer status

- adds new fields to existing RPC message - these fields are updated in status of corresponding storageconsumer CRs - the status will be helpful for exporting new metrics Signed-off-by: Leela Venkaiah G <[email protected]>
red-hat-storage · Oct 31, 2023 · 4686adb · 4686adb
1 parent c97cd5a
commit 4686adb
Show file tree

Hide file tree

Showing 14 changed files with 265 additions and 106 deletions.
diff --git a/api/v1alpha1/storageconsumer_types.go b/api/v1alpha1/storageconsumer_types.go
@@ -62,6 +62,16 @@ type StorageConsumerStatus struct {
 	CephResources []*CephResourcesSpec `json:"cephResources,omitempty"`
 	// Timestamp of last heartbeat received from consumer
 	LastHeartbeat metav1.Time `json:"lastHeartbeat,omitempty"`
+	// Information of storage client received from consumer
+	Client ClientStatus `json:"client,omitempty"`
+}
+
+// ClientStatus is the information pushed from connected storage client
+type ClientStatus struct {
+	// StorageClient Platform Version
+	PlatformVersion string `json:"platformVersion"`
+	// StorageClient Operator Version
+	OperatorVersion string `json:"operatorVersion"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/ocs.openshift.io_storageconsumers.yaml b/config/crd/bases/ocs.openshift.io_storageconsumers.yaml
@@ -66,6 +66,19 @@ spec:
                       type: string
                   type: object
                 type: array
+              client:
+                description: Information of storage client received from consumer
+                properties:
+                  operatorVersion:
+                    description: StorageClient Operator Version
+                    type: string
+                  platformVersion:
+                    description: StorageClient Platform Version
+                    type: string
+                required:
+                - operatorVersion
+                - platformVersion
+                type: object
               lastHeartbeat:
                 description: Timestamp of last heartbeat received from consumer
                 format: date-time

diff --git a/deploy/csv-templates/crds/ocs/ocs.openshift.io_storageconsumers.yaml b/deploy/csv-templates/crds/ocs/ocs.openshift.io_storageconsumers.yaml
@@ -66,6 +66,19 @@ spec:
                       type: string
                   type: object
                 type: array
+              client:
+                description: Information of storage client received from consumer
+                properties:
+                  operatorVersion:
+                    description: StorageClient Operator Version
+                    type: string
+                  platformVersion:
+                    description: StorageClient Platform Version
+                    type: string
+                required:
+                - operatorVersion
+                - platformVersion
+                type: object
               lastHeartbeat:
                 description: Timestamp of last heartbeat received from consumer
                 format: date-time

diff --git a/deploy/ocs-operator/manifests/storageconsumer.crd.yaml b/deploy/ocs-operator/manifests/storageconsumer.crd.yaml
@@ -65,6 +65,19 @@ spec:
                       type: string
                   type: object
                 type: array
+              client:
+                description: Information of storage client received from consumer
+                properties:
+                  operatorVersion:
+                    description: StorageClient Operator Version
+                    type: string
+                  platformVersion:
+                    description: StorageClient Platform Version
+                    type: string
+                required:
+                - operatorVersion
+                - platformVersion
+                type: object
               lastHeartbeat:
                 description: Timestamp of last heartbeat received from consumer
                 format: date-time

diff --git a/services/provider/client/client.go b/services/provider/client/client.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"time"
 
+	cs "github.com/red-hat-storage/ocs-operator/v4/services/provider/clientstatus"
 	pb "github.com/red-hat-storage/ocs-operator/v4/services/provider/pb"
 
 	"google.golang.org/grpc"
@@ -188,13 +189,18 @@ func (cc *OCSProviderClient) GetStorageClassClaimConfig(ctx context.Context, con
 	return cc.Client.GetStorageClassClaimConfig(apiCtx, req)
 }
 
-func (cc *OCSProviderClient) ReportStatus(ctx context.Context, consumerUUID string) (*pb.ReportStatusResponse, error) {
+func NewStorageClientStatus() cs.StorageClientStatus {
+	return &pb.ReportStatusRequest{}
+}
+
+func (cc *OCSProviderClient) ReportStatus(ctx context.Context, consumerUUID string, status cs.StorageClientStatus) (*pb.ReportStatusResponse, error) {
 	if cc.Client == nil || cc.clientConn == nil {
 		return nil, fmt.Errorf("Provider client is closed")
 	}
-	req := &pb.ReportStatusRequest{
-		StorageConsumerUUID: consumerUUID,
-	}
+
+	// panic if the request wasn't constructed using "NewStorageClientStatus()"
+	req := status.(*pb.ReportStatusRequest)
+	req.StorageConsumerUUID = consumerUUID
 	apiCtx, cancel := context.WithTimeout(ctx, cc.timeout)
 	defer cancel()
 

diff --git a/services/provider/clientstatus/status.go b/services/provider/clientstatus/status.go
@@ -0,0 +1,9 @@
+package clientstatus
+
+type StorageClientStatus interface {
+	GetPlatformVersion() string
+	GetOperatorVersion() string
+
+	SetPlatformVersion(string) StorageClientStatus
+	SetOperatorVersion(string) StorageClientStatus
+}
diff --git a/services/provider/pb/provider.pb.go b/services/provider/pb/provider.pb.go
diff --git a/services/provider/pb/storageclient_status.go b/services/provider/pb/storageclient_status.go
@@ -0,0 +1,26 @@
+package providerpb
+
+import (
+	cs "github.com/red-hat-storage/ocs-operator/v4/services/provider/clientstatus"
+)
+
+// ensure ReportStatusRequest satisfies StorageClientStatus interface
+var _ cs.StorageClientStatus = &ReportStatusRequest{}
+
+func (r *ReportStatusRequest) GetPlatformVersion() string {
+	return r.ClientPlatformVersion
+}
+
+func (r *ReportStatusRequest) GetOperatorVersion() string {
+	return r.ClientOperatorVersion
+}
+
+func (r *ReportStatusRequest) SetPlatformVersion(version string) cs.StorageClientStatus {
+	r.ClientPlatformVersion = version
+	return r
+}
+
+func (r *ReportStatusRequest) SetOperatorVersion(version string) cs.StorageClientStatus {
+	r.ClientOperatorVersion = version
+	return r
+}
diff --git a/services/provider/proto/provider.proto b/services/provider/proto/provider.proto
@@ -155,6 +155,8 @@ message StorageClassClaimConfigResponse{
 
 message ReportStatusRequest{
     string storageConsumerUUID = 1;
+    string clientPlatformVersion = 2;
+    string clientOperatorVersion = 3;
 }
 
 message ReportStatusResponse{}