v1alpha1

type BlockDevice struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DeviceSpec   `json:"spec,omitempty"`
	Status DeviceStatus `json:"status,omitempty"`
}

type BlockDeviceClaim struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DeviceClaimSpec   `json:"spec,omitempty"`
	Status DeviceClaimStatus `json:"status,omitempty"`
}

type BlockDeviceClaimList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BlockDeviceClaim `json:"items"`
}

type BlockDeviceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BlockDevice `json:"items"`
}

type BlockDeviceNodeAttributes struct {
	// NodeName represents the name of the Kubernetes node resource
	// where the BD should be present
	NodeName string `json:"nodeName,omitempty"`

	// HostName represents the hostname of the Kubernetes node resource
	// where the BD should be present
	HostName string `json:"hostName,omitempty"`
}

type BlockDeviceState string

type BlockDeviceVolumeMode string

type CStorBackup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              CStorBackupSpec   `json:"spec"`
	Status            CStorBackupStatus `json:"status"`
}

type CStorBackupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []CStorBackup `json:"items"`
}

type CStorBackupSpec struct {
	// BackupName is a name of the backup or scheduled backup
	BackupName string `json:"backupName"`

	// VolumeName is a name of the volume for which this backup is destined
	VolumeName string `json:"volumeName"`

	// SnapName is a name of the current backup snapshot
	SnapName string `json:"snapName"`

	// PrevSnapName is the last completed-backup's snapshot name
	PrevSnapName string `json:"prevSnapName"`

	// BackupDest is the remote address for backup transfer
	BackupDest string `json:"backupDest"`

	// LocalSnap is flag to enable local snapshot only
	LocalSnap bool `json:"localSnap"`
}

type CStorBackupStatus string

type CStorCompletedBackup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              CStorBackupSpec `json:"spec"`
}

type CStorCompletedBackupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []CStorCompletedBackup `json:"items"`
}

type CStorPool struct {
	// PoolName contains the name of the cstor pool to be upgraded
	PoolName string `json:"poolName,omitempty"`
	// Options can be used to change the default behaviour of upgrade
	Options *ResourceOptions `json:"options,omitempty"`
}

type CStorPoolCluster struct {
	// CSPCName contains the name of the storage pool claim to be upgraded
	CSPCName string `json:"cspcName,omitempty"`
	// Options can be used to change the default behaviour of upgrade
	Options *ResourceOptions `json:"options,omitempty"`
}

type CStorPoolInstance struct {
	// CSPCName contains the name of the storage pool claim to be upgraded
	CSPIName string `json:"cspiName,omitempty"`
	// Options can be used to change the default behaviour of upgrade
	Options *ResourceOptions `json:"options,omitempty"`
}

type CStorRestore struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"` // set name to restore name + volume name + something like csp tag
	Spec              CStorRestoreSpec            `json:"spec"`
	Status            CStorRestoreStatus          `json:"status"`
}

type CStorRestoreList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []CStorRestore `json:"items"`
}

type CStorRestoreSpec struct {
	RestoreName   string            `json:"restoreName"` // set restore name
	VolumeName    string            `json:"volumeName"`
	RestoreSrc    string            `json:"restoreSrc"` // it can be ip:port in case of restore from remote or volumeName in case of local restore
	MaxRetryCount int               `json:"maxretrycount"`
	RetryCount    int               `json:"retrycount"`
	StorageClass  string            `json:"storageClass,omitempty"`
	Size          resource.Quantity `json:"size,omitempty"`
	Local         bool              `json:"localRestore,omitempty"` // if restore is from local backup/snapshot
}

type CStorRestoreStatus string

type CStorVolume struct {
	// PVName contains the name of the pv associated with the cstor volume
	PVName string `json:"pvName,omitempty"`
	// Options can be used to change the default behaviour of upgrade
	Options *ResourceOptions `json:"options,omitempty"`
}

type DeviceCapacity struct {
	// Storage is the blockdevice capacity in bytes
	Storage uint64 `json:"storage"`

	// PhysicalSectorSize is blockdevice physical-Sector size in bytes
	PhysicalSectorSize uint32 `json:"physicalSectorSize"`

	// LogicalSectorSize is blockdevice logical-sector size in bytes
	LogicalSectorSize uint32 `json:"logicalSectorSize"`
}

type DeviceClaimDetails struct {
	// BlockVolumeMode represents whether to claim a device in Block mode or Filesystem mode.
	// These are use cases of BlockVolumeMode:
	// 1) Not specified: VolumeMode check will not be effective
	// 2) VolumeModeBlock: BD should not have any filesystem or mountpoint
	// 3) VolumeModeFileSystem: BD should have a filesystem and mountpoint. If DeviceFormat is
	//    specified then the format should match with the FSType in BD
	BlockVolumeMode BlockDeviceVolumeMode `json:"blockVolumeMode,omitempty"`

	//Format of the device required, eg:ext4, xfs
	DeviceFormat string `json:"formatType,omitempty"`

	//AllowPartition represents whether to claim a full block device or a device that is a partition
	AllowPartition bool `json:"allowPartition,omitempty"`
}

type DeviceClaimPhase string

type DeviceClaimResources struct {
	// Requests describes the minimum resources required. eg: if storage resource of 10G is
	// requested minimum capacity of 10G should be available
	Requests corev1.ResourceList `json:"requests"`
}

type DeviceClaimSpec struct {

	// Selector is used to find block devices to be considered for claiming
	Selector *metav1.LabelSelector `json:"selector,omitempty"`

	// Resources will help with placing claims on Capacity, IOPS
	Resources DeviceClaimResources `json:"resources"`

	// DeviceType represents the type of drive like SSD, HDD etc.,
	DeviceType string `json:"deviceType"`

	// HostName from where blockdevice has to be claimed.
	HostName string `json:"hostName"`

	// Details of the device to be claimed
	Details DeviceClaimDetails `json:"deviceClaimDetails,omitempty"`

	// BlockDeviceName is the reference to the block-device backing this claim
	BlockDeviceName string `json:"blockDeviceName,omitempty"`

	// BlockDeviceNodeAttributes is the attributes on the node from which a BD should
	// be selected for this claim. It can include nodename, failure domain etc.
	BlockDeviceNodeAttributes BlockDeviceNodeAttributes `json:"blockDeviceNodeAttributes,omitempty"`
}

type DeviceClaimState string

type DeviceClaimStatus struct {
	Phase DeviceClaimPhase `json:"phase"`
}

type DeviceDetails struct {
	// DeviceType represents the type of device like
	// sparse, disk, partition, lvm, raid
	DeviceType string `json:"deviceType"`

	// DriveType is the type of backing drive, HDD/SSD
	DriveType string `json:"driveType"`

	// LogicalBlockSize is the logical block size in bytes
	// reported by /sys/class/block/sda/queue/logical_block_size
	LogicalBlockSize uint32 `json:"logicalBlockSize"`

	// PhysicalBlockSize is the physical block size in bytes
	// reported by /sys/class/block/sda/queue/physical_block_size
	PhysicalBlockSize uint32 `json:"physicalBlockSize"`

	// HardwareSectorSize is the hardware sector size in bytes
	HardwareSectorSize uint32 `json:"hardwareSectorSize"`

	// Model is model of disk
	Model string `json:"model"`

	// Compliance is standards/specifications version implmented by device firmware
	//  such as SPC-1, SPC-2, etc
	Compliance string `json:"compliance"`

	// Serial is serial number of disk
	Serial string `json:"serial"`

	// Vendor is vendor of disk
	Vendor string `json:"vendor"`

	// disk firmware revision
	FirmwareRevision string `json:"firmwareRevision"`
}

type DeviceDevLink struct {
	// Kind is the type of link like by-id or by-path.
	Kind string `json:"kind,omitempty"`

	// Links are the soft links of Type type
	Links []string `json:"links,omitempty"`
}

type DeviceSpec struct {
	// NodeAttributes has the details of the node on which BD is attached
	NodeAttributes NodeAttribute `json:"nodeAttributes"`

	// Path contain devpath (e.g. /dev/sdb)
	Path string `json:"path"`

	// Capacity
	Capacity DeviceCapacity `json:"capacity"`

	// Details contain static attributes of BD like model,serial, and so forth
	Details DeviceDetails `json:"details"`

	// Reference to the BDC which has claimed this BD
	ClaimRef *v1.ObjectReference `json:"claimRef,omitempty"`

	// DevLinks contains soft links of a block device like
	// /dev/by-id/...
	// /dev/by-uuid/...
	DevLinks []DeviceDevLink `json:"devlinks"`

	// FileSystem contains mountpoint and filesystem type
	FileSystem FileSystemInfo `json:"filesystem,omitempty"`

	// Partitioned represents if BlockDevice has partions or not (YES/NO)
	// Currently always default to NO.
	// TODO @kmova to be implemented/deprecated
	Partitioned string `json:"partitioned"`

	// ParentDevice was intented to store the UUID of the parent
	// Block Device as is the case for partitioned block devices.
	//
	// For example:
	// /dev/sda is the parent for /dev/sdap1
	// TODO @kmova to be implemented/deprecated
	ParentDevice string `json:"parentDevice,omitempty"`

	// AggregateDevice was intended to store the hierachical
	// information in cases of LVM. However this is currently
	// not implemented and may need to be re-looked into for
	// better design.
	// TODO @kmova to be implemented/deprecated
	AggregateDevice string `json:"aggregateDevice,omitempty"`
}

type DeviceStatus struct {
	// claim state of the block device
	ClaimState DeviceClaimState `json:"claimState"`

	// State is the current state of the blockdevice (Active/Inactive)
	State BlockDeviceState `json:"state"`
}

type FileSystemInfo struct {
	//Type represents the FileSystem type of the block device
	Type string `json:"fsType,omitempty"`

	//MountPoint represents the mountpoint of the block device.
	Mountpoint string `json:"mountPoint,omitempty"`
}

type JivaVolume struct {
	// PVName contains the name of the pv associated with the jiva volume
	PVName string `json:"pvName,omitempty"`
	// Options can be used to change the default behaviour of upgrade
	Options *ResourceOptions `json:"options,omitempty"`
}

type MigrateCStorPool struct {
	// SPCName contains the name of the storage pool claim to be migrated
	SPCName string `json:"spcName,omitempty"`
	// If a CSPC with the same name as SPC already exists then we can rename
	// SPC during migration using Rename
	Rename string `json:"rename,omitempty"`
}

type MigrateCStorVolume struct {
	// PVName contains the name of the pv associated with the cstor volume to be migrated
	PVName string `json:"pvName,omitempty"`
}

type MigratePhase string

type MigrateResource struct {
	// MigrateCStorVolume contains the details of the cstor volume to be migrated
	MigrateCStorVolume *MigrateCStorVolume `json:"cstorVolume,omitempty"`
	// MigrateCStorPool contains the details of the cstor pool to be migrated
	MigrateCStorPool *MigrateCStorPool `json:"cstorPool,omitempty"`
}

type MigrationDetailedStatuses struct {
	Step string `json:"step,omitempty"`
	// StartTime of a MigrateStep
	StartTime metav1.Time `json:"startTime,omitempty"`
	// LastUpdatedTime of a MigrateStep
	LastUpdatedTime metav1.Time `json:"lastUpdatedAt,omitempty"`
	// Phase indicates if the MigrateStep is waiting, errored or completed.
	Phase StepPhase `json:"phase,omitempty"`
	// A human-readable message indicating details about why the migrationStep
	// is in this state
	Message string `json:"message,omitempty"`
	// Reason is a brief CamelCase string that describes any failure and is meant
	// for machine parsing and tidy display in the CLI
	Reason string `json:"reason,omitempty"`
}

type MigrationTask struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Spec i.e. specifications of the MigrationTask
	Spec MigrationTaskSpec `json:"spec"`
	// Status of MigrationTask
	Status MigrationTaskStatus `json:"status,omitempty"`
}

type MigrationTaskList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// Items are the list of migration task items
	Items []MigrationTask `json:"items"`
}

type MigrationTaskSpec struct {
	MigrateResource `json:",inline"`
}

type MigrationTaskStatus struct {
	// Phase indicates if a migrationTask is started, success or errored
	Phase MigratePhase `json:"phase,omitempty"`
	// StartTime of Migrate
	StartTime metav1.Time `json:"startTime,omitempty"`
	// CompletedTime of Migrate
	CompletedTime metav1.Time `json:"completedTime,omitempty"`
	// MigrationDetailedStatuses contains the list of statuses of each step
	MigrationDetailedStatuses []MigrationDetailedStatuses `json:"migrationDetailedStatuses,omitempty"`
	// Retries is the number of times the job attempted to migration the resource
	Retries int `json:"retries,omitempty"`
}

type NodeAttribute struct {
	// NodeName is the name of the Kubernetes node resource on which the device is attached
	NodeName string `json:"nodeName"`
}

type Options struct {
	// Timeout is maximum seconds to wait at any given step in the upgrade
	Timeout int `json:"timeout,omitempty"`
}

type ResourceOptions struct {
	// IgnoreStepsOnError allows to ignore steps which failed
	IgnoreStepsOnError []string `json:"ignoreStepsOnError,omitempty"`
}

type ResourceSpec struct {
	// JivaVolume contains the details of the jiva volume to be upgraded
	JivaVolume *JivaVolume `json:"jivaVolume,omitempty"`
	// CStorVolume contains the details of the cstor volume to be upgraded
	CStorVolume *CStorVolume `json:"cstorVolume,omitempty"`
	// CStorPool contains the details of the cstor pool to be upgraded
	CStorPool *CStorPool `json:"cstorPool,omitempty"`
	// StoragePoolClaim contains the details of the storage pool claim to be upgraded
	StoragePoolClaim *StoragePoolClaim `json:"storagePoolClaim,omitempty"`
	// CStorPoolInstance contains the details of the cstor pool to be upgraded
	CStorPoolInstance *CStorPoolInstance `json:"cstorPoolInstance,omitempty"`
	// CStorPoolCluster contains the details of the storage pool claim to be upgraded
	CStorPoolCluster *CStorPoolCluster `json:"cstorPoolCluster,omitempty"`
}

type Status struct {
	// Phase indicates if the UpgradeStep is waiting, errored or completed.
	Phase StepPhase `json:"phase,omitempty"`
	// A human-readable message indicating details about why the upgradeStep
	// is in this state
	Message string `json:"message,omitempty"`
	// Reason is a brief CamelCase string that describes any failure and is meant
	// for machine parsing and tidy display in the CLI
	Reason string `json:"reason,omitempty"`
}

type StepPhase string

type StoragePoolClaim struct {
	// SPCName contains the name of the storage pool claim to be upgraded
	SPCName string `json:"spcName,omitempty"`
	// Options can be used to change the default behaviour of upgrade
	Options *ResourceOptions `json:"options,omitempty"`
}

type UpgradeDetailedStatuses struct {
	Step UpgradeStep `json:"step,omitempty"`
	// StartTime of a UpgradeStep
	// +nullable
	StartTime metav1.Time `json:"startTime,omitempty"`
	// LastUpdatedTime of a UpgradeStep
	// +nullable
	LastUpdatedTime metav1.Time `json:"lastUpdatedAt,omitempty"`
	// Status of a UpgradeStep
	Status `json:",inline"`
}

type UpgradePhase string

type UpgradeStep string

type UpgradeTask struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Spec i.e. specifications of the UpgradeTask
	Spec UpgradeTaskSpec `json:"spec"`
	// Status of UpgradeTask
	Status UpgradeTaskStatus `json:"status,omitempty"`
}

type UpgradeTaskList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// Items are the list of upgrade task items
	Items []UpgradeTask `json:"items"`
}

type UpgradeTaskSpec struct {
	// FromVersion is the current version of the resource.
	FromVersion string `json:"fromVersion"`
	// ToVersion is the upgraded version of the resource. It should be same
	// as the version of control plane components version.
	ToVersion string `json:"toVersion"`
	// Options contains the optional flags that can be passed during upgrade.
	Options *Options `json:"options,omitempty"`
	// ResourceSpec contains the details of the resource that has to upgraded.
	ResourceSpec `json:",inline"`
	// ImagePrefix contains the url prefix of the image url. This field is
	// optional. If not present upgrade takes the previously present ImagePrefix.
	ImagePrefix string `json:"imagePrefix,omitempty"`
	// ImageTag contains the customized tag for ToVersion if any. This field is
	// optional. If not present upgrade takes the ToVersion as the ImageTag
	ImageTag string `json:"imageTag,omitempty"`
}

type UpgradeTaskStatus struct {
	// Phase indicates if a upgradeTask is started, success or errored
	Phase UpgradePhase `json:"phase,omitempty"`
	// StartTime of Upgrade
	// +nullable
	StartTime metav1.Time `json:"startTime,omitempty"`
	// CompletedTime of Upgrade
	// +nullable
	CompletedTime metav1.Time `json:"completedTime,omitempty"`
	// UpgradeDetailedStatuses contains the list of statuses of each step
	UpgradeDetailedStatuses []UpgradeDetailedStatuses `json:"upgradeDetailedStatuses,omitempty"`
	// Retries is the number of times the job attempted to upgrade the resource
	Retries int `json:"retries,omitempty"`
}