storage

type CommonStorageDriverConfigExternal struct {
	Version           int      `json:"version"`
	StorageDriverName string   `json:"storageDriverName"`
	StoragePrefix     *string  `json:"storagePrefix"`
	SerialNumbers     []string `json:"serialNumbers"`
}

type IscsiAccessInfo struct {
	IscsiTargetPortal string  `json:"iscsiTargetPortal,omitempty"`
	IscsiTargetIQN    string  `json:"iscsiTargetIqn,omitempty"`
	IscsiLunNumber    int32   `json:"iscsiLunNumber,omitempty"`
	IscsiInterface    string  `json:"iscsiInterface,omitempty"`
	IscsiIgroup       string  `json:"iscsiIgroup,omitempty"`
	IscsiVAGs         []int64 `json:"iscsiVags,omitempty"`
}

type NfsAccessInfo struct {
	NfsServerIP string `json:"nfsServerIp,omitempty"`
	NfsPath     string `json:"nfsPath,omitempty"`
}

type PersistentStorageBackendConfig struct {
	OntapConfig             *dvp.OntapStorageDriverConfig     `json:"ontap_config,omitempty"`
	SolidfireConfig         *dvp.SolidfireStorageDriverConfig `json:"solidfire_config,omitempty"`
	EseriesConfig           *dvp.ESeriesStorageDriverConfig   `json:"eseries_config,omitempty"`
	FakeStorageDriverConfig *fake.FakeStorageDriverConfig     `json:"fake_config,omitempty"`
}

type StorageBackend struct {
	Driver StorageDriver
	Name   string
	//TODO: the granualarity of online should probably be a StoragePool, not the whole backend, which in the case of ONTAP can be the whole cluster.
	Online  bool
	Storage map[string]*StoragePool
}

type StorageBackendExternal struct {
	Name    string                          `json:"name"`
	Config  interface{}                     `json:"config"`
	Storage map[string]*StoragePoolExternal `json:"storage"`
	Online  bool                            `json:"online"`
	Volumes []string                        `json:"volumes"`
}

type StorageBackendPersistent struct {
	Version string                         `json:"version"`
	Config  PersistentStorageBackendConfig `json:"config"`
	Name    string                         `json:"name"`
	Online  bool                           `json:"online"`
}

type StorageDriver interface {
	dvp.StorageDriver
	TridentDriver
}

type StoragePool struct {
	Name string
	// A Trident storage pool can potentially satisfy more than one storage
	// class.
	StorageClasses []string
	Volumes        map[string]*Volume
	Backend        *StorageBackend
	Attributes     map[string]sa.Offer
}

type StoragePoolExternal struct {
	Name           string   `json:"name"`
	StorageClasses []string `json:"storageClasses"`
	//TODO: can't have an interface here for unmarshalling
	Attributes map[string]sa.Offer `json:"storageAttributes"`
	Volumes    []string            `json:"volumes"`
}

type TridentDriver interface {
	CreatePrepare(volConfig *VolumeConfig) bool
	// CreateFollowup adds necessary information for accessing the volume
	// to VolumeConfig.
	CreateFollowup(volConfig *VolumeConfig) error
	// GetInternalVolumeName will return a name that satisfies any character
	// constraints present on the backend and that will be unique to Trident.
	// The latter requirement should generally be done by prepending the
	// value of CommonStorageDriver.SnapshotPrefix to the name.
	GetInternalVolumeName(name string) string
	GetStorageBackendSpecs(backend *StorageBackend) error
	GetVolumeOpts(
		volConfig *VolumeConfig,
		pool *StoragePool,
		requests map[string]storage_attribute.Request,
	) (map[string]string, error)
	GetProtocol() config.Protocol
	GetDriverName() string
	StoreConfig(b *PersistentStorageBackendConfig)
	// GetExternalConfig returns a version of the driver configuration that
	// lacks confidential information, such as usernames and passwords.
	GetExternalConfig() interface{}
}

type Volume struct {
	Config  *VolumeConfig
	Backend *StorageBackend
	Pool    *StoragePool
}

type VolumeAccessInfo struct {
	IscsiAccessInfo
	NfsAccessInfo
}

type VolumeConfig struct {
	Version         string            `json:"version"`
	Name            string            `json:"name"`
	InternalName    string            `json:"internalName"`
	Size            string            `json:"size"`
	Protocol        config.Protocol   `json:"protocol"`
	SnapshotPolicy  string            `json:"snapshotPolicy,omitempty"`
	ExportPolicy    string            `json:"exportPolicy,omitempty"`
	SnapshotDir     string            `json:"snapshotDirectory,omitempty"`
	UnixPermissions string            `json:"unixPermissions,omitempty"`
	StorageClass    string            `json:"storageClass,omitempty"`
	AccessMode      config.AccessMode `json:"accessMode,omitempty"`
	AccessInfo      VolumeAccessInfo  `json:"accessInformation"`
	BlockSize       string            `json:"blockSize"`
	FileSystem      string            `json:"fileSystem"`
}

type VolumeExternal struct {
	Config  *VolumeConfig
	Backend string `json:"backend"`
	Pool    string `json:"pool"`
}