Add backend pool reporting to Solidfire driver

This change enables the Solidfire driver to discover and report a set of non-overlapping, discrete storage pools that exist on the Solidfire backend.

Author: jwebster7

storage_drivers/solidfire/solidfire_san.go

@@ -283,6 +283,13 @@ func (d *SANStorageDriver) Initialize(
 		return errors.New("error encountered validating SolidFire driver on init")
 	}
 
+	// Identify non-overlapping storage backend pools on the driver backend.
+	pools, err := drivers.EncodeStorageBackendPools(ctx, commonConfig, d.getStorageBackendPools(ctx))
+	if err != nil {
+		return fmt.Errorf("failed to encode storage backend pools: %v", err)
+	}
+	d.Config.BackendPools = pools
+
 	// log cluster node serial numbers asynchronously since the API can take a long time
 	go d.getNodeSerialNumbers(ctx, config.CommonStorageDriverConfig)
 
@@ -1583,6 +1590,19 @@ func (d *SANStorageDriver) GetStorageBackendPhysicalPoolNames(context.Context) [
 	return []string{}
 }
 
+// getStorageBackendPools determines any non-overlapping, discrete storage pools present on a driver's storage backend.
+func (d *SANStorageDriver) getStorageBackendPools(ctx context.Context) []drivers.SolidfireStorageBackendPool {
+	fields := LogFields{"Method": "getStorageBackendPools", "Type": "SANStorageDriver"}
+	Logc(ctx).WithFields(fields).Debug(">>>> getStorageBackendPools")
+	defer Logc(ctx).WithFields(fields).Debug("<<<< getStorageBackendPools")
+
+	// For this driver, a discrete storage pool is composed of the following:
+	// 1. AccountID
+	// 2. Tenant name
+	// For now, SolidFire will only report 1 storage pool.
+	return []drivers.SolidfireStorageBackendPool{{AccountID: d.AccountID, TenantName: d.Config.TenantName}}
+}
+
 func (d *SANStorageDriver) GetInternalVolumeName(ctx context.Context, name string) string {
 	if tridentconfig.UsingPassthroughStore {
 		// With a passthrough store, the name mapping must remain reversible

storage_drivers/solidfire/solidfire_san_test.go

@@ -188,3 +188,14 @@ func TestValidateStoragePrefix(t *testing.T) {
 		})
 	}
 }
+
+func TestGetStorageBackendPools(t *testing.T) {
+	d := newTestSolidfireSANDriver()
+	backendPools := d.getStorageBackendPools(context.Background())
+
+	// These backend pools are derived from the driver's configuration. If that changes in the helper
+	// "newTestSolidfireSANDriver", these assertions will need to be adjusted as well.
+	assert.Equal(t, len(backendPools), 1, "unexpected set of backend pools")
+	assert.Equal(t, d.Config.TenantName, backendPools[0].TenantName, "tenant name didn't match")
+	assert.Equal(t, d.AccountID, backendPools[0].AccountID, "account ID didn't match")
+}

storage_drivers/types.go

@@ -152,7 +152,8 @@ type OntapStorageDriverPool struct {
 // StorageBackendPool is a type constraint that enables drivers to generically report non-overlapping storage pools
 // within a backend.
 type StorageBackendPool interface {
-	OntapFlexGroupStorageBackendPool | OntapStorageBackendPool | OntapEconomyStorageBackendPool
+	OntapFlexGroupStorageBackendPool | OntapStorageBackendPool | OntapEconomyStorageBackendPool |
+		SolidfireStorageBackendPool
 }
 
 // OntapFlexGroupStorageBackendPool is a non-overlapping section of an ONTAP flexgroup backend that may be used for
@@ -351,6 +352,13 @@ type SolidfireStorageDriverPool struct {
 	SolidfireStorageDriverConfigDefaults `json:"defaults"`
 }
 
+// SolidfireStorageBackendPool is a non-overlapping section of a SolidFire backend that may be used for
+// provisioning storage.
+type SolidfireStorageBackendPool struct {
+	AccountID  int64  `json:"accountID,string"`
+	TenantName string `json:"tenantName"`
+}
+
 type SolidfireStorageDriverConfigDefaults struct {
 	CommonStorageDriverConfigDefaults
 }