iscsi,nfs,nvmeof: toml versioning

Add a new "metadata" field to the promoter config, which stores a schema version.
LINBIT · Nov 6, 2023 · 8723022 · 8723022
1 parent c44ad61
commit 8723022
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 3 deletions.
diff --git a/pkg/iscsi/iscsi.go b/pkg/iscsi/iscsi.go
@@ -383,7 +383,7 @@ func (i *ISCSI) DeleteVolume(ctx context.Context, iqn Iqn, lun int) (*ResourceCo
 		if rscCfg.Volumes[j].Number == lun {
 			err = i.cli.ResourceDefinitions.DeleteVolumeDefinition(ctx, iqn.WWN(), lun)
 			if err != nil && err != client.NotFoundError {
-				return nil, fmt.Errorf("failed to delete volume definition")
+				return nil, fmt.Errorf("failed to delete volume definition: %w", err)
 			}
 
 			rscCfg.Volumes = append(rscCfg.Volumes[:j], rscCfg.Volumes[j+1:]...)

diff --git a/pkg/iscsi/resource_config.go b/pkg/iscsi/resource_config.go
@@ -20,6 +20,7 @@ import (
 
 const (
 	DefaultISCSIPort = 3260
+	CurrentVersion   = 1
 )
 
 type ResourceConfig struct {
@@ -399,5 +400,8 @@ func (r *ResourceConfig) ToPromoter(deployment []client.ResourceWithVolumes) (*r
 				TargetAs:            "Requires",
 			},
 		},
+		Metadata: reactor.PromoterMetadata{
+			LinstorGatewaySchemaVersion: CurrentVersion,
+		},
 	}, nil
 }
diff --git a/pkg/nfs/resource_config.go b/pkg/nfs/resource_config.go
@@ -22,6 +22,7 @@ import (
 const (
 	ExportBasePath = "/srv/gateway-exports"
 	DefaultNFSPort = 2049
+	CurrentVersion = 1
 )
 
 var (
@@ -496,6 +497,9 @@ func (r *ResourceConfig) ToPromoter(deployment []client.ResourceWithVolumes) (*r
 				TargetAs:            "BindsTo",
 			},
 		},
+		Metadata: reactor.PromoterMetadata{
+			LinstorGatewaySchemaVersion: CurrentVersion,
+		},
 	}, nil
 }
 

diff --git a/pkg/nvmeof/resource_config.go b/pkg/nvmeof/resource_config.go
@@ -19,8 +19,11 @@ import (
 	"github.com/LINBIT/linstor-gateway/pkg/reactor"
 )
 
-const IDFormat = "nvmeof-%s"
-const DefaultPort = 4420
+const (
+	IDFormat       = "nvmeof-%s"
+	DefaultPort    = 4420
+	CurrentVersion = 1
+)
 
 type ResourceConfig struct {
 	NQN           Nqn                   `json:"nqn"`
@@ -245,6 +248,9 @@ func (r *ResourceConfig) ToPromoter(deployment []client.ResourceWithVolumes) (*r
 				TargetAs:            "Requires",
 			},
 		},
+		Metadata: reactor.PromoterMetadata{
+			LinstorGatewaySchemaVersion: CurrentVersion,
+		},
 	}, nil
 }
 

diff --git a/pkg/reactor/reactor.go b/pkg/reactor/reactor.go
@@ -23,10 +23,17 @@ type Config struct {
 	Promoter []PromoterConfig `toml:"promoter,omitempty"`
 }
 
+// PromoterMetadata is a custom extension to the drbd-reactor config format.
+// It stores fields specific to linstor-gateway.
+type PromoterMetadata struct {
+	LinstorGatewaySchemaVersion int `toml:"linstor-gateway-schema-version"`
+}
+
 // PromoterConfig is the configuration for drbd-reactors "promoter" plugin.
 type PromoterConfig struct {
 	ID        string                            `toml:"id"`
 	Resources map[string]PromoterResourceConfig `toml:"resources,omitempty"`
+	Metadata  PromoterMetadata                  `toml:"metadata,omitempty"`
 }
 
 // DeployedResources fetches the current state of the resources referenced in the promoter config.

diff --git a/pkg/upgrade/iscsi.go b/pkg/upgrade/iscsi.go
@@ -13,6 +13,10 @@ func upgradeIscsi(ctx context.Context, linstor *client.Client, name string, forc
 	if err != nil {
 		return false, err
 	}
+	if cfg.Metadata.LinstorGatewaySchemaVersion > iscsi.CurrentVersion {
+		return false, fmt.Errorf("schema version %d is not supported",
+			cfg.Metadata.LinstorGatewaySchemaVersion)
+	}
 
 	parsedCfg, err := iscsi.FromPromoter(cfg, resourceDefinition, volumeDefinitions)
 	if err != nil {