v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +groupName=openebs.io

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type Disk
  • func (in *Disk) DeepCopy() *Disk
  • func (in *Disk) DeepCopyInto(out *Disk)
  • func (in *Disk) DeepCopyObject() runtime.Object
• type DiskCapacity
  • func (in *DiskCapacity) DeepCopy() *DiskCapacity
  • func (in *DiskCapacity) DeepCopyInto(out *DiskCapacity)
• type DiskDetails
  • func (in *DiskDetails) DeepCopy() *DiskDetails
  • func (in *DiskDetails) DeepCopyInto(out *DiskDetails)
• type DiskDevLink
  • func (in *DiskDevLink) DeepCopy() *DiskDevLink
  • func (in *DiskDevLink) DeepCopyInto(out *DiskDevLink)
• type DiskList
  • func (in *DiskList) DeepCopy() *DiskList
  • func (in *DiskList) DeepCopyInto(out *DiskList)
  • func (in *DiskList) DeepCopyObject() runtime.Object
• type DiskSpec
  • func (in *DiskSpec) DeepCopy() *DiskSpec
  • func (in *DiskSpec) DeepCopyInto(out *DiskSpec)
• type DiskStat
  • func (in *DiskStat) DeepCopy() *DiskStat
  • func (in *DiskStat) DeepCopyInto(out *DiskStat)
• type DiskStatus
  • func (in *DiskStatus) DeepCopy() *DiskStatus
  • func (in *DiskStatus) DeepCopyInto(out *DiskStatus)
• type Partition
• type Temperature
  • func (in *Temperature) DeepCopy() *Temperature
  • func (in *Temperature) DeepCopyInto(out *Temperature)

Variables

var (
	//SchemeBuilder applies all the stored functions to the scheme, will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	//AddToScheme  applies all the stored functions to the scheme,  will stay in k8s.io/kubernetes.
	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: openebsio.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Disk

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

	Spec   DiskSpec   `json:"spec"`
	Status DiskStatus `json:"status"`
	Stats  DiskStat   `json:"stats"`
}

Disk describes disk resource.

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
}

DiskDetails contains basic and static info of a disk

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

type DiskDevLink 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
}

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"`

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

DiskList is a list of Disk object resources

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 ..)
	FileSystem       string        `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)
	DevLinks         []DiskDevLink `json:"devlinks,omitempty"`         //DevLinks contains soft links of one disk
}

DiskSpec is the specification for the disk stored as CRD

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 DiskStatus

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

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 Partition

type Partition struct {
	PartitionType  string `json:"partitionType"`
	FileSystemType string `json:"fileSystemType"`
}

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.