Merge pull request noobaa#1826 from aayushchouhan09/quota-warn

Added a warning when quota exceeding the available space

Author: aayushchouhan09

pkg/bucket/bucket.go

@@ -2,6 +2,7 @@ package bucket
 
 import (
 	"fmt"
+	"os"
 	"strconv"
 
 	"github.com/noobaa/noobaa-operator/v5/pkg/bucketclass"
@@ -131,6 +132,9 @@ func RunCreate(cmd *cobra.Command, args []string) {
 	if err != nil {
 		log.Fatal(err)
 	}
+	nb.WarnIfQuotaCappedByFree(bucketName, nil, nbClient, &quota, func(format string, args ...interface{}) {
+		fmt.Fprintf(os.Stderr, "Warning: "+format+"\n", args...)
+	})
 }
 
 // RunUpdate runs a CLI command
@@ -169,6 +173,9 @@ func RunUpdate(cmd *cobra.Command, args []string) {
 	if err != nil {
 		log.Fatal(err)
 	}
+	nb.WarnIfQuotaCappedByFree(bucketName, nil, nbClient, updateParams.Quota, func(format string, args ...interface{}) {
+		fmt.Fprintf(os.Stderr, "Warning: "+format+"\n", args...)
+	})
 }
 
 // RunDelete runs a CLI command

pkg/cosi/provisioner.go

@@ -388,6 +388,10 @@ func (r *APIRequest) CreateBucket(
 		Quota: quotaConfig,
 	}
 
+	nb.WarnIfQuotaCappedByFree(r.BucketName, nil, r.SysClient.NBClient, quotaConfig, func(format string, args ...interface{}) {
+		log.Warnf("QUOTA_WARN: "+format, args...)
+	})
+
 	err = r.SysClient.NBClient.UpdateBucketAPI(*createBucketParams)
 	if err != nil {
 		return fmt.Errorf("failed to update bucket %q with error: %v", r.BucketName, err)

pkg/nb/quota.go

@@ -0,0 +1,42 @@
+package nb
+
+import "math/big"
+
+// WarnIfQuotaCappedByFree emits a best-effort warning when the configured size quota exceeds
+// the bucket's effective free capacity, meaning raising the quota will not increase Data Space Avail
+func WarnIfQuotaCappedByFree(bucketName string, bucket *BucketInfo, nbClient Client, quota *QuotaConfig, warnf func(format string, args ...interface{})) {
+	if quota == nil || quota.Size == nil || warnf == nil {
+		return
+	}
+	requestedQuotaBytes, ok := QuotaSizeToBytes(quota.Size)
+	if !ok {
+		return
+	}
+
+	if bucket == nil {
+		if nbClient == nil {
+			return
+		}
+		b, err := nbClient.ReadBucketAPI(ReadBucketParams{Name: bucketName})
+		if err != nil {
+			return
+		}
+		bucket = &b
+	}
+
+	cap := bucket.DataCapacity
+	if bucket.BucketType == "NAMESPACE" || cap == nil || cap.Free == nil || cap.Size == nil {
+		return
+	}
+
+	// warn if (quota - used) > free, meaning free space is the binding constraint
+	// use big.Int to avoid int64 overflow for large capacity values
+	quotaMinusUsed := new(big.Int).Sub(big.NewInt(requestedQuotaBytes), cap.Size.ToBig())
+	if quotaMinusUsed.Cmp(cap.Free.ToBig()) > 0 {
+		warnf("bucket %q size quota (%s) exceeds current effective free capacity (%s); Data Space Avail will remain capped (min(free, quota-used))",
+			bucketName,
+			IntToHumanBytes(requestedQuotaBytes),
+			BigIntToHumanBytes(cap.Free),
+		)
+	}
+}

pkg/nb/types.go

@@ -3,6 +3,7 @@ package nb
 import (
 	"encoding/json"
 	"math"
+	"math/big"
 	"reflect"
 	"strconv"
 
@@ -167,6 +168,11 @@ func (n *BigInt) ToString() string {
 	return strconv.FormatInt((n.N + (n.Peta * petaInBytes)), 10)
 }
 
+// ToBig converts bigInt to a math/big.Int for overflow-safe arithmetic
+func (n *BigInt) ToBig() *big.Int {
+	return new(big.Int).Add(big.NewInt(n.N), new(big.Int).Mul(big.NewInt(n.Peta), big.NewInt(petaInBytes)))
+}
+
 // PoolInfo is a struct of pool info returned by the API
 type PoolInfo struct {
 	Name         string `json:"name"`
@@ -816,6 +822,46 @@ func GetBytesAndUnits(bi int64, prec int) (float64, string) {
 	return f, units[u]
 }
 
+// QuotaSizeToBytes converts a NooBaa quota size config (value + unit like "G") to bytes using base-2 units
+// Returns ok=false if the input is invalid or out of int64 range
+func QuotaSizeToBytes(q *SizeQuotaConfig) (bytes int64, ok bool) {
+	if q == nil || q.Value <= 0 {
+		return 0, false
+	}
+
+	var pow int
+	switch q.Unit {
+	case "": // bytes, pow stays 0
+	case "K":
+		pow = 1
+	case "M":
+		pow = 2
+	case "G":
+		pow = 3
+	case "T":
+		pow = 4
+	case "P":
+		pow = 5
+	case "E":
+		pow = 6
+	case "Z":
+		pow = 7
+	case "Y":
+		pow = 8
+	default:
+		return 0, false
+	}
+
+	f := q.Value * math.Pow(1024, float64(pow))
+	if math.IsNaN(f) || math.IsInf(f, 0) {
+		return 0, false
+	}
+	if f > math.MaxInt64 {
+		return 0, false
+	}
+	return int64(math.Round(f)), true
+}
+
 // UInt64ToBigInt convert uint64 based value to BigInt value
 func UInt64ToBigInt(value uint64) BigInt {
 	return BigInt{

pkg/obc/obc.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"os"
 	"time"
 
 	nbv1 "github.com/noobaa/noobaa-operator/v5/pkg/apis/noobaa/v1alpha1"
@@ -493,6 +494,9 @@ func RunStatus(cmd *cobra.Command, args []string) {
 			fmt.Printf("  %-22s : %s\n", "Data Space Avail", nb.BigIntToHumanBytes(b.DataCapacity.AvailableSizeToUpload))
 			fmt.Printf("  %-22s : %s\n", "Num Objects Avail", b.DataCapacity.AvailableQuantityToUpload.ToString())
 		}
+		nb.WarnIfQuotaCappedByFree(b.Name, b, nil, b.Quota, func(format string, args ...interface{}) {
+			fmt.Fprintf(os.Stderr, "Warning: "+format+"\n", args...)
+		})
 		fmt.Printf("\n")
 	}
 }

pkg/obc/provisioner.go

@@ -535,6 +535,9 @@ func (r *BucketRequest) UpdateBucket() error {
 	if quotaConfig.IsEqual(bucket.Quota) {
 		r.Provisioner.Logger.Infof("UpdateBucket: no changes in quota config")
 	} else {
+		nb.WarnIfQuotaCappedByFree(r.BucketName, &bucket, nil, quotaConfig, func(format string, args ...interface{}) {
+			log.Warnf("QUOTA_WARN: "+format, args...)
+		})
 		createBucketParams := &nb.CreateBucketParams{
 			Name:  r.BucketName,
 			Quota: quotaConfig,