storageconfig: move provisioned rate

Move `base.ProvisionedRateSpec` to `storageconfig.ProvisionedRate`.

Epic: none
Release note: None

Author: RaduBerinde

pkg/base/store_spec.go

@@ -50,43 +50,37 @@ func GetAbsoluteFSPath(fieldName string, p string) (string, error) {
 	return ret, nil
 }
 
-// ProvisionedRateSpec is an optional part of the StoreSpec.
-type ProvisionedRateSpec struct {
-	// ProvisionedBandwidth is the bandwidth provisioned for this store in bytes/s.
-	ProvisionedBandwidth int64
-}
-
-func newStoreProvisionedRateSpec(
+func parseStoreProvisionedRate(
 	field redact.SafeString, value string,
-) (ProvisionedRateSpec, error) {
+) (storageconfig.ProvisionedRate, error) {
 	split := strings.Split(value, "=")
 	if len(split) != 2 {
-		return ProvisionedRateSpec{}, errors.Errorf("%s field has invalid value %s", field, value)
+		return storageconfig.ProvisionedRate{}, errors.Errorf("%s field has invalid value %s", field, value)
 	}
 	subField := split[0]
 	subValue := split[1]
 	if subField != "bandwidth" {
-		return ProvisionedRateSpec{}, errors.Errorf("%s field does not have bandwidth sub-field", field)
+		return storageconfig.ProvisionedRate{}, errors.Errorf("%s field does not have bandwidth sub-field", field)
 	}
 	if len(subValue) == 0 {
-		return ProvisionedRateSpec{}, errors.Errorf("%s field has no value specified for bandwidth", field)
+		return storageconfig.ProvisionedRate{}, errors.Errorf("%s field has no value specified for bandwidth", field)
 	}
 	if len(subValue) <= 2 || subValue[len(subValue)-2:] != "/s" {
-		return ProvisionedRateSpec{},
+		return storageconfig.ProvisionedRate{},
 			errors.Errorf("%s field does not have bandwidth sub-field %s ending in /s",
 				field, subValue)
 	}
 	bandwidthString := subValue[:len(subValue)-2]
 	bandwidth, err := humanizeutil.ParseBytes(bandwidthString)
 	if err != nil {
-		return ProvisionedRateSpec{},
+		return storageconfig.ProvisionedRate{},
 			errors.Wrapf(err, "could not parse bandwidth in field %s", field)
 	}
 	if bandwidth == 0 {
-		return ProvisionedRateSpec{},
+		return storageconfig.ProvisionedRate{},
 			errors.Errorf("%s field is trying to set bandwidth to 0", field)
 	}
-	return ProvisionedRateSpec{ProvisionedBandwidth: bandwidth}, nil
+	return storageconfig.ProvisionedRate{ProvisionedBandwidth: bandwidth}, nil
 }
 
 // StoreSpec contains the details that can be specified in the cli pertaining
@@ -110,8 +104,8 @@ type StoreSpec struct {
 	PebbleOptions string
 	// EncryptionOptions is set if encryption is enabled.
 	EncryptionOptions *storageconfig.EncryptionOptions
-	// ProvisionedRateSpec is optional.
-	ProvisionedRateSpec ProvisionedRateSpec
+	// ProvisionedRate is optional.
+	ProvisionedRate storageconfig.ProvisionedRate
 }
 
 // String returns a fully parsable version of the store spec.
@@ -154,9 +148,9 @@ func (ss StoreSpec) String() string {
 		fmt.Fprint(&buffer, optsStr)
 		fmt.Fprint(&buffer, ",")
 	}
-	if ss.ProvisionedRateSpec.ProvisionedBandwidth > 0 {
+	if ss.ProvisionedRate.ProvisionedBandwidth > 0 {
 		fmt.Fprintf(&buffer, "provisioned-rate=bandwidth=%s/s,",
-			humanizeutil.IBytes(ss.ProvisionedRateSpec.ProvisionedBandwidth))
+			humanizeutil.IBytes(ss.ProvisionedRate.ProvisionedBandwidth))
 	}
 	// Trim the extra comma from the end if it exists.
 	if l := buffer.Len(); l > 0 {
@@ -303,11 +297,11 @@ func NewStoreSpec(value string) (StoreSpec, error) {
 			}
 			ss.PebbleOptions = buf.String()
 		case "provisioned-rate":
-			rateSpec, err := newStoreProvisionedRateSpec("provisioned-rate", value)
+			rateSpec, err := parseStoreProvisionedRate("provisioned-rate", value)
 			if err != nil {
 				return StoreSpec{}, err
 			}
-			ss.ProvisionedRateSpec = rateSpec
+			ss.ProvisionedRate = rateSpec
 
 		default:
 			return StoreSpec{}, fmt.Errorf("%s is not a valid store field", field)

pkg/base/store_spec_test.go

@@ -148,7 +148,7 @@ target_file_size=2097152`
 
 		// provisioned rate
 		{"path=/mnt/hda1,provisioned-rate=bandwidth=200MiB/s", "",
-			StoreSpec{Path: "/mnt/hda1", ProvisionedRateSpec: base.ProvisionedRateSpec{ProvisionedBandwidth: 200 << 20}}},
+			StoreSpec{Path: "/mnt/hda1", ProvisionedRate: storageconfig.ProvisionedRate{ProvisionedBandwidth: 200 << 20}}},
 		{"path=/mnt/hda1,provisioned-rate=bandwidth=200MiB", "provisioned-rate field does not have bandwidth sub-field 200MiB ending in /s", StoreSpec{}},
 		{"path=/mnt/hda1,provisioned-rate=200MiB/s", "provisioned-rate field has invalid value 200MiB/s", StoreSpec{}},
 		{"path=/mnt/hda1,provisioned-rate=bandwidth=0B/s", "provisioned-rate field is trying to set bandwidth to 0", StoreSpec{}},

pkg/server/node.go

@@ -52,6 +52,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/storage"
 	"github.com/cockroachdb/cockroach/pkg/storage/disk"
 	"github.com/cockroachdb/cockroach/pkg/storage/fs"
+	"github.com/cockroachdb/cockroach/pkg/storage/storageconfig"
 	"github.com/cockroachdb/cockroach/pkg/util"
 	"github.com/cockroachdb/cockroach/pkg/util/admission"
 	"github.com/cockroachdb/cockroach/pkg/util/admission/admissionpb"
@@ -1254,7 +1255,7 @@ func (n *Node) UpdateIOThreshold(id roachpb.StoreID, threshold *admissionpb.IOTh
 // diskStatsMap encapsulates all the logic for populating DiskStats for
 // admission.StoreMetrics.
 type diskStatsMap struct {
-	provisionedRate map[roachpb.StoreID]base.ProvisionedRateSpec
+	provisionedRate map[roachpb.StoreID]storageconfig.ProvisionedRate
 	diskMonitors    map[roachpb.StoreID]kvserver.DiskStatsMonitor
 }
 
@@ -1298,7 +1299,7 @@ func (dsm *diskStatsMap) initDiskStatsMap(
 	specs []base.StoreSpec, engines []storage.Engine, diskManager monitorManagerInterface,
 ) error {
 	*dsm = diskStatsMap{
-		provisionedRate: make(map[roachpb.StoreID]base.ProvisionedRateSpec),
+		provisionedRate: make(map[roachpb.StoreID]storageconfig.ProvisionedRate),
 		diskMonitors:    make(map[roachpb.StoreID]kvserver.DiskStatsMonitor),
 	}
 	for i := range engines {
@@ -1313,7 +1314,7 @@ func (dsm *diskStatsMap) initDiskStatsMap(
 		if err != nil {
 			return err
 		}
-		dsm.provisionedRate[id.StoreID] = specs[i].ProvisionedRateSpec
+		dsm.provisionedRate[id.StoreID] = specs[i].ProvisionedRate
 		dsm.diskMonitors[id.StoreID] = monitor
 	}
 	return nil

pkg/server/node_test.go

@@ -30,6 +30,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/storage"
 	"github.com/cockroachdb/cockroach/pkg/storage/disk"
 	"github.com/cockroachdb/cockroach/pkg/storage/fs"
+	"github.com/cockroachdb/cockroach/pkg/storage/storageconfig"
 	"github.com/cockroachdb/cockroach/pkg/testutils"
 	"github.com/cockroachdb/cockroach/pkg/testutils/serverutils"
 	"github.com/cockroachdb/cockroach/pkg/util/admission"
@@ -1142,13 +1143,13 @@ func TestDiskStatsMap(t *testing.T) {
 
 	specs := []base.StoreSpec{
 		{
-			ProvisionedRateSpec: base.ProvisionedRateSpec{
+			ProvisionedRate: storageconfig.ProvisionedRate{
 				ProvisionedBandwidth: 0,
 			},
 			Path: "foo",
 		},
 		{
-			ProvisionedRateSpec: base.ProvisionedRateSpec{
+			ProvisionedRate: storageconfig.ProvisionedRate{
 				ProvisionedBandwidth: 200,
 			},
 			Path: "bar",

pkg/storage/storageconfig/BUILD.bazel

@@ -6,6 +6,7 @@ go_library(
         "encryption_spec.go",
         "node.go",
         "size.go",
+        "store.go",
         "wal_failover.go",
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/storage/storageconfig",

pkg/storage/storageconfig/store.go

@@ -0,0 +1,14 @@
+// Copyright 2025 The Cockroach Authors.
+//
+// Use of this software is governed by the CockroachDB Software License
+// included in the /LICENSE file.
+
+package storageconfig
+
+// ProvisionedRate defines the provisioned rate for a store.
+type ProvisionedRate struct {
+	// ProvisionedBandwidth is the bandwidth provisioned for a store in bytes/s.
+	ProvisionedBandwidth int64
+	// In the future, we may add more fields here for IOPS or separate read and
+	// write bandwidth.
+}