v1alpha1

package
v0.4.2-RC1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 29, 2019 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the openebs v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=openebs.io

Package v1alpha1 contains API Schema definitions for the openebs v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=openebs.io

Index

Constants

View Source 
const (
	// DiskResourceKind is the kind of Disk CRD
	DiskResourceKind = "Disk"
	// DiskResourceListKind is the list kind for Disk
	DiskResourceListKind = "DiskList"
	// DiskResourcePlural is the plural form used for disk
	DiskResourcePlural = "disks"
	// DiskResourceShort is the short name used for disk CRD
	DiskResourceShort = "disk"
	// DiskResourceName is the name of the disk resource
	DiskResourceName = DiskResourcePlural + "." + GroupName

	// BlockDeviceResourceKind is the kind of block device CRD
	BlockDeviceResourceKind = "BlockDevice"
	// BlockDeviceResourceListKind is the list kind for block device
	BlockDeviceResourceListKind = "BlockDeviceList"
	// BlockDeviceResourcePlural is the plural form used for block device
	BlockDeviceResourcePlural = "blockdevices"
	// BlockDeviceResourceShort is the short name used for block device CRD
	BlockDeviceResourceShort = "bd"
	// BlockDeviceResourceName is the name of the block device resource
	BlockDeviceResourceName = BlockDeviceResourcePlural + "." + GroupName

	// BlockDeviceClaimResourceKind is the kind of block device claim CRD
	BlockDeviceClaimResourceKind = "BlockDeviceClaim"
	// BlockDeviceClaimResourceListKind is the list kind for block device claim
	BlockDeviceClaimResourceListKind = "BlockDeviceClaimList"
	// BlockDeviceClaimResourcePlural is the plural form used for block device claim
	BlockDeviceClaimResourcePlural = "blockdeviceclaims"
	// BlockDeviceClaimResourceShort is the short name used for block device claim CRD
	BlockDeviceClaimResourceShort = "bdc"
	// BlockDeviceClaimResourceName is the name of the block device claim resource
	BlockDeviceClaimResourceName = BlockDeviceClaimResourcePlural + "." + GroupName
)
View Source 
const (
	// GroupName is the group of apis
	GroupName = "openebs.io"
	// APIVersion is the version for the apis
	APIVersion = "v1alpha1"
)
View Source 
const (
	// ResourceStorage defines the storage required as v1.Quantity
	ResourceStorage v1.ResourceName = "storage"
)

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: APIVersion}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

Functions

This section is empty.

Types

type BlockDevice 

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

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

BlockDevice is the Schema for the devices API +k8s:openapi-gen=true

func (*BlockDevice) DeepCopy 

func (in *BlockDevice) DeepCopy() *BlockDevice

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BlockDevice.

func (*BlockDevice) DeepCopyInto 

func (in *BlockDevice) DeepCopyInto(out *BlockDevice)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BlockDevice) DeepCopyObject 

func (in *BlockDevice) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BlockDeviceClaim 

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

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

BlockDeviceClaim is the Schema for the block device claim API

func (*BlockDeviceClaim) DeepCopy 

func (in *BlockDeviceClaim) DeepCopy() *BlockDeviceClaim

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BlockDeviceClaim.

func (*BlockDeviceClaim) DeepCopyInto 

func (in *BlockDeviceClaim) DeepCopyInto(out *BlockDeviceClaim)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BlockDeviceClaim) DeepCopyObject 

func (in *BlockDeviceClaim) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BlockDeviceClaimList 

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

BlockDeviceClaimList contains a list of BlockDeviceClaim

func (*BlockDeviceClaimList) DeepCopy 

func (in *BlockDeviceClaimList) DeepCopy() *BlockDeviceClaimList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BlockDeviceClaimList.

func (*BlockDeviceClaimList) DeepCopyInto 

func (in *BlockDeviceClaimList) DeepCopyInto(out *BlockDeviceClaimList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BlockDeviceClaimList) DeepCopyObject 

func (in *BlockDeviceClaimList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BlockDeviceList 

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

BlockDeviceList contains a list of BlockDevice

func (*BlockDeviceList) DeepCopy 

func (in *BlockDeviceList) DeepCopy() *BlockDeviceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BlockDeviceList.

func (*BlockDeviceList) DeepCopyInto 

func (in *BlockDeviceList) DeepCopyInto(out *BlockDeviceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BlockDeviceList) DeepCopyObject 

func (in *BlockDeviceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BlockDeviceNodeAttributes added in v0.4.2 

type BlockDeviceNodeAttributes struct {
	NodeName string `json:"nodeName,omitempty"`
	HostName string `json:"hostName,omitempty"`
}

BlockDeviceNodeAttributes contains the attributes of the node from which the BD should be selected for claiming

type BlockDeviceState added in v0.4.2 

type BlockDeviceState string

BlockDeviceState defines the observed state of the disk 

const (
	// BlockDeviceActive is the state for a block device that is connected to the node
	BlockDeviceActive BlockDeviceState = "Active"
	// BlockDeviceInactive is the state for a block device that is disconnected from a node
	BlockDeviceInactive BlockDeviceState = "Inactive"
	// BlockDeviceUnknown is the state for a block device whose state (attached/detached) cannot
	// be determined at this time.
	BlockDeviceUnknown BlockDeviceState = "Unknown"
)

type BlockDeviceVolumeMode 

type BlockDeviceVolumeMode string

BlockDeviceVolumeMode specifies the type in which the BlockDevice can be used 

const (
	// VolumeModeBlock specifies that the block device needs to be used as a raw block
	VolumeModeBlock BlockDeviceVolumeMode = "Block"
	// VolumeModeFileSystem specifies that block device will be used with a filesystem already existing
	VolumeModeFileSystem BlockDeviceVolumeMode = "FileSystem"
)

type DeviceCapacity 

type DeviceCapacity struct {
	Storage            uint64 `json:"storage"`            // blockdevice capacity in bytes
	PhysicalSectorSize uint32 `json:"physicalSectorSize"` // blockdevice physical-Sector size in bytes
	LogicalSectorSize  uint32 `json:"logicalSectorSize"`  // blockdevice logical-sector size in bytes
}

DeviceCapacity defines the physical and logical size of the block device

func (*DeviceCapacity) DeepCopy 

func (in *DeviceCapacity) DeepCopy() *DeviceCapacity

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceCapacity.

func (*DeviceCapacity) DeepCopyInto 

func (in *DeviceCapacity) DeepCopyInto(out *DeviceCapacity)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceClaimDetails 

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: DeviceFormat and MountPoint will not be considered
	// 2) VolumeModeBlock: DeviceFormat and MountPoint checks will be used as empty strings irrespective
	//    of the value they hold
	// 3) VolumeModeFileSystem: DeviceFormat and MountPoint will be used for exact matches
	BlockVolumeMode BlockDeviceVolumeMode `json:"blockVolumeMode, omitempty"`
	DeviceFormat    string                `json:"formatType,omitempty"`     //Format of the device required, eg:ext4, xfs
	AllowPartition  bool                  `json:"allowPartition,omitempty"` //AllowPartition represents whether to claim a full block device or a device that is a partition
}

DeviceClaimDetails defines the details of the block device that should be claimed

func (*DeviceClaimDetails) DeepCopy 

func (in *DeviceClaimDetails) DeepCopy() *DeviceClaimDetails

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceClaimDetails.

func (*DeviceClaimDetails) DeepCopyInto 

func (in *DeviceClaimDetails) DeepCopyInto(out *DeviceClaimDetails)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceClaimPhase 

type DeviceClaimPhase string

DeviceClaimPhase is a typed string for phase field of BlockDeviceClaim. 

const (
	// BlockDeviceClaimStatusEmpty represents that the BlockDeviceClaim was just created.
	BlockDeviceClaimStatusEmpty DeviceClaimPhase = ""

	// BlockDeviceClaimStatusPending represents BlockDeviceClaim has not been assigned devices yet. Rather
	// search is going on for matching devices.
	BlockDeviceClaimStatusPending DeviceClaimPhase = "Pending"

	// BlockDeviceClaimStatusInvalidCapacity represents BlockDeviceClaim has invalid capacity request i.e. 0/-1
	BlockDeviceClaimStatusInvalidCapacity DeviceClaimPhase = "Invalid Capacity Request"

	// BlockDeviceClaimStatusDone represents BlockDeviceClaim has been assigned backing blockdevice and ready for use.
	BlockDeviceClaimStatusDone DeviceClaimPhase = "Bound"
)

BlockDeviceClaim CR, when created pass through phases before it got some Devices Assigned. Given below table, have all phases which BlockDeviceClaim CR can go before it is marked done.

type DeviceClaimResources 

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 v1.ResourceList `json:"requests"`
}

DeviceClaimResources defines the request by the claim, eg, Storage, IOPS

func (*DeviceClaimResources) DeepCopy 

func (in *DeviceClaimResources) DeepCopy() *DeviceClaimResources

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceClaimResources.

func (*DeviceClaimResources) DeepCopyInto 

func (in *DeviceClaimResources) DeepCopyInto(out *DeviceClaimResources)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceClaimSpec 

type DeviceClaimSpec struct {
	Resources       DeviceClaimResources `json:"resources"`                    // the resources in the claim like Capacity, IOPS
	DeviceType      string               `json:"deviceType"`                   // DeviceType represents the type of drive like SSD, HDD etc.,
	HostName        string               `json:"hostName"`                     // Node name from where blockdevice has to be claimed.
	Details         DeviceClaimDetails   `json:"deviceClaimDetails,omitempty"` // Details of the device to be claimed
	BlockDeviceName string               `json:"blockDeviceName,omitempty"`    // BlockDeviceName is the reference to the block-device backing this claim
	// 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"`
}

DeviceClaimSpec defines the desired state of BlockDeviceClaim

func (*DeviceClaimSpec) DeepCopy 

func (in *DeviceClaimSpec) DeepCopy() *DeviceClaimSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceClaimSpec.

func (*DeviceClaimSpec) DeepCopyInto 

func (in *DeviceClaimSpec) DeepCopyInto(out *DeviceClaimSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceClaimState 

type DeviceClaimState string

DeviceClaimState defines the observed claim state of BlockDevice 

const (
	// BlockDeviceUnclaimed represents that the block device is not bound to any BDC,
	// all cleanup jobs have been completed and is available for claiming.
	BlockDeviceUnclaimed DeviceClaimState = "Unclaimed"
	// BlockDeviceReleased represents that the block device is released from the BDC,
	// pending cleanup jobs
	BlockDeviceReleased DeviceClaimState = "Released"
	// BlockDeviceClaimed represents that the block device is bound to a BDC
	BlockDeviceClaimed DeviceClaimState = "Claimed"
)

type DeviceClaimStatus 

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

DeviceClaimStatus defines the observed state of BlockDeviceClaim

func (*DeviceClaimStatus) DeepCopy 

func (in *DeviceClaimStatus) DeepCopy() *DeviceClaimStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceClaimStatus.

func (*DeviceClaimStatus) DeepCopyInto 

func (in *DeviceClaimStatus) DeepCopyInto(out *DeviceClaimStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceDetails 

type DeviceDetails struct {
	DeviceType       string `json:"deviceType"`       // DeviceType represents the type of drive like SSD, HDD etc.,
	Model            string `json:"model"`            // Model is model of disk
	Compliance       string `json:"compliance"`       // Implemented standards/specifications version such as SPC-1, SPC-2, etc
	Serial           string `json:"serial"`           // Serial is serial no of disk
	Vendor           string `json:"vendor"`           // Vendor is vendor of disk
	FirmwareRevision string `json:"firmwareRevision"` // disk firmware revision
}

DeviceDetails represent certain hardware/static attributes of the block device

func (*DeviceDetails) DeepCopy 

func (in *DeviceDetails) DeepCopy() *DeviceDetails

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceDetails.

func (*DeviceDetails) DeepCopyInto 

func (in *DeviceDetails) DeepCopyInto(out *DeviceDetails)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. 

type DeviceDevLink struct {
	Kind  string   `json:"kind,omitempty"`  // Kind is the type of link like by-id or by-path.
	Links []string `json:"links,omitempty"` // Links are the soft links of Type type
}

DeviceDevLink holds the maping between type and links like by-id type or by-path type link

func (*DeviceDevLink) DeepCopy 

func (in *DeviceDevLink) DeepCopy() *DeviceDevLink

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceDevLink.

func (*DeviceDevLink) DeepCopyInto 

func (in *DeviceDevLink) DeepCopyInto(out *DeviceDevLink)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceInfo 

type DeviceInfo struct {
	DeviceUID string `json:"blockDeviceUID"` //Cross reference to BlockDevice CR backed by this disk
}

func (*DeviceInfo) DeepCopy 

func (in *DeviceInfo) DeepCopy() *DeviceInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceInfo.

func (*DeviceInfo) DeepCopyInto 

func (in *DeviceInfo) DeepCopyInto(out *DeviceInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceSpec 

type DeviceSpec struct {
	// NodeAttributes has the details of the node in which this BD is attached
	NodeAttributes  NodeAttribute       `json:"nodeAttributes"`
	Path            string              `json:"path"`                      //Path contain devpath (e.g. /dev/sdb)
	Capacity        DeviceCapacity      `json:"capacity"`                  //Capacity
	Details         DeviceDetails       `json:"details"`                   //Details contains static attributes (model, serial ..)
	ClaimRef        *v1.ObjectReference `json:"claimRef,omitempty"`        // Reference to the BDC which has claimed this BD
	DevLinks        []DeviceDevLink     `json:"devlinks"`                  //DevLinks contains soft links of one disk
	FileSystem      FileSystemInfo      `json:"filesystem,omitempty"`      //FileSystem contains mountpoint and filesystem type
	Partitioned     string              `json:"partitioned"`               //BlockDevice has partions or not (YES/NO)
	ParentDevice    string              `json:"parentDevice,omitempty"`    //ParentDevice has the UUID of the parent device
	AggregateDevice string              `json:"aggregateDevice,omitempty"` //AggregateDevice has the UUID of the aggregate device created from this device
}

DeviceSpec defines the desired state of BlockDevice

func (*DeviceSpec) DeepCopy 

func (in *DeviceSpec) DeepCopy() *DeviceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceSpec.

func (*DeviceSpec) DeepCopyInto 

func (in *DeviceSpec) DeepCopyInto(out *DeviceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeviceStatus 

type DeviceStatus struct {
	ClaimState DeviceClaimState `json:"claimState"` // claim state of the block device
	State      BlockDeviceState `json:"state"`      // current state of the blockdevice (Active/Inactive)
}

DeviceStatus defines the observed state of BlockDevice

func (*DeviceStatus) DeepCopy 

func (in *DeviceStatus) DeepCopy() *DeviceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeviceStatus.

func (*DeviceStatus) DeepCopyInto 

func (in *DeviceStatus) DeepCopyInto(out *DeviceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Disk 

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

	Spec   DiskSpec   `json:"spec,omitempty"`
	Status DiskStatus `json:"status,omitempty"`
	Stats  DiskStat   `json:"stats,omitempty"`
	Device DeviceInfo `json:"deviceInfo"`
}

Disk is the Schema for the disks API +k8s:openapi-gen=true

func (*Disk) DeepCopy 

func (in *Disk) DeepCopy() *Disk

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Disk.

func (*Disk) DeepCopyInto 

func (in *Disk) DeepCopyInto(out *Disk)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Disk) DeepCopyObject 

func (in *Disk) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DiskCapacity 

type DiskCapacity struct {
	Storage            uint64 `json:"storage"`            // disk size in bytes
	PhysicalSectorSize uint32 `json:"physicalSectorSize"` // disk physical-Sector size in bytes
	LogicalSectorSize  uint32 `json:"logicalSectorSize"`  // disk logical-sector size in bytes
}

func (*DiskCapacity) DeepCopy 

func (in *DiskCapacity) DeepCopy() *DiskCapacity

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskCapacity.

func (*DiskCapacity) DeepCopyInto 

func (in *DiskCapacity) DeepCopyInto(out *DiskCapacity)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DiskDetails 

type DiskDetails struct {
	RotationRate     uint16 `json:"rotationRate"`     // Disk rotation speed if disk is not SSD
	DriveType        string `json:"driveType"`        // DriveType represents the type of drive like SSD, HDD etc.,
	Model            string `json:"model"`            // Model is model of disk
	Compliance       string `json:"compliance"`       // Implemented standards/specifications version such as SPC-1, SPC-2, etc
	Serial           string `json:"serial"`           // Serial is serial no of disk
	Vendor           string `json:"vendor"`           // Vendor is vendor of disk
	FirmwareRevision string `json:"firmwareRevision"` // disk firmware revision
}

func (*DiskDetails) DeepCopy 

func (in *DiskDetails) DeepCopy() *DiskDetails

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskDetails.

func (*DiskDetails) DeepCopyInto 

func (in *DiskDetails) DeepCopyInto(out *DiskDetails)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. 

type DiskDevLink struct {
	Kind  string   `json:"kind"`  // Kind is the type of link like by-id or by-path.
	Links []string `json:"links"` // Links are the soft links of Type type
}

DiskDevlink holds the maping between type and links like by-id type or by-path type link

func (*DiskDevLink) DeepCopy 

func (in *DiskDevLink) DeepCopy() *DiskDevLink

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskDevLink.

func (*DiskDevLink) DeepCopyInto 

func (in *DiskDevLink) DeepCopyInto(out *DiskDevLink)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DiskList 

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

DiskList contains a list of Disk

func (*DiskList) DeepCopy 

func (in *DiskList) DeepCopy() *DiskList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskList.

func (*DiskList) DeepCopyInto 

func (in *DiskList) DeepCopyInto(out *DiskList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DiskList) DeepCopyObject 

func (in *DiskList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DiskSpec 

type DiskSpec struct {
	Path             string         `json:"path"`                       //Path contain devpath (e.g. /dev/sdb)
	Capacity         DiskCapacity   `json:"capacity"`                   //Capacity
	Details          DiskDetails    `json:"details"`                    //Details contains static attributes (model, serial ..)
	DevLinks         []DiskDevLink  `json:"devlinks"`                   //DevLinks contains soft links of one disk
	FileSystem       FileSystemInfo `json:"fileSystem,omitempty"`       //Contains the data about filesystem on the disk
	PartitionDetails []Partition    `json:"partitionDetails,omitempty"` //Details of partitions in the disk (filesystem, partition type)
}

DiskSpec defines the desired state of Disk

func (*DiskSpec) DeepCopy 

func (in *DiskSpec) DeepCopy() *DiskSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskSpec.

func (*DiskSpec) DeepCopyInto 

func (in *DiskSpec) DeepCopyInto(out *DiskSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DiskStat 

type DiskStat struct {
	TempInfo              Temperature `json:"diskTemperature"`
	TotalBytesRead        uint64      `json:"totalBytesRead"`
	TotalBytesWritten     uint64      `json:"totalBytesWritten"`
	DeviceUtilizationRate float64     `json:"deviceUtilizationRate"`
	PercentEnduranceUsed  float64     `json:"percentEnduranceUsed"`
}

func (*DiskStat) DeepCopy 

func (in *DiskStat) DeepCopy() *DiskStat

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskStat.

func (*DiskStat) DeepCopyInto 

func (in *DiskStat) DeepCopyInto(out *DiskStat)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DiskState added in v0.4.2 

type DiskState string

DiskState defines the observed state of the disk 

const (
	// DiskActive is the state for a physical disk that is connected to the node
	DiskActive DiskState = "Active"
	// DiskInactive is the state for a physical disk that is disconnected from a node
	DiskInactive DiskState = "Inactive"
	// DiskUnknown is the state for a physical disk whose state (attached/detached) cannot
	// be determined at this time.
	DiskUnknown DiskState = "Unknown"
)

type DiskStatus 

type DiskStatus struct {
	State DiskState `json:"state"` //current state of the disk (Active/Inactive)
}

DiskStatus defines the observed state of Disk

func (*DiskStatus) DeepCopy 

func (in *DiskStatus) DeepCopy() *DiskStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskStatus.

func (*DiskStatus) DeepCopyInto 

func (in *DiskStatus) DeepCopyInto(out *DiskStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FileSystemInfo 

type FileSystemInfo struct {
	Type       string `json:"fsType,omitempty"`     //Type represents the FileSystem type of the block device
	Mountpoint string `json:"mountPoint,omitempty"` //MountPoint represents the mountpoint of the block device.
}

FileSystemInfo defines the filesystem type and mountpoint of the device if it exists

func (*FileSystemInfo) DeepCopy 

func (in *FileSystemInfo) DeepCopy() *FileSystemInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FileSystemInfo.

func (*FileSystemInfo) DeepCopyInto 

func (in *FileSystemInfo) DeepCopyInto(out *FileSystemInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NodeAttribute added in v0.4.2 

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

NodeAttribute defines the various attributes of the node

type Partition 

type Partition struct {
	PartitionType string         `json:"partitionType"`
	FileSystem    FileSystemInfo `json:"fileSystem,omitempty"`
}

Partition represents the partition information of the disk

func (*Partition) DeepCopy 

func (in *Partition) DeepCopy() *Partition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Partition.

func (*Partition) DeepCopyInto 

func (in *Partition) DeepCopyInto(out *Partition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Temperature 

type Temperature struct {
	CurrentTemperature int16 `json:"currentTemperature"`
	HighestTemperature int16 `json:"highestTemperature"`
	LowestTemperature  int16 `json:"lowestTemperature"`
}

func (*Temperature) DeepCopy 

func (in *Temperature) DeepCopy() *Temperature

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Temperature.

func (*Temperature) DeepCopyInto 

func (in *Temperature) DeepCopyInto(out *Temperature)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.