openebs

Documentation

Index

• Constants
• Variables
• type ClientSet
  • func (c *ClientSet) CheckCVRStatus(pvc, ns string, status v1alpha1.CStorVolumeReplicaPhase) bool
  • func (c *ClientSet) CheckSnapshot(pvc, pvcNs, snapshot string) (bool, error)
  • func (c *ClientSet) CreateSPC(spcYAML string) error
  • func (c *ClientSet) CreateVolume(pvcYAML, pvcNs string, wait bool) error
  • func (c *ClientSet) DeleteVolume(pvcYAML, pvcNs string) error
  • func (c *ClientSet) DumpLogs()
  • func (c *ClientSet) GetCStorBackups(backup, ns string) (*v1alpha1.CStorBackupList, error)
  • func (c *ClientSet) GetCStorCompletedBackups(backup, ns string) (*v1alpha1.CStorCompletedBackupList, error)
  • func (c *ClientSet) IsBackupResourcesExist(backup, pvc, ns string) (bool, error)
  • func (c *ClientSet) WaitForHealthyCVR(pvc *v1.PersistentVolumeClaim) error

Constants

const (
	// OpenEBSNs openebs Namespace
	OpenEBSNs = "openebs"

	// PVDeploymentLabel for target pod Deployment
	PVDeploymentLabel = "openebs.io/persistent-volume"
)

const (
	// SPCYaml yaml for SPC CR
	SPCYaml = `` /* 287-byte string literal not displayed */

	// SCYaml for SC CR
	SCYaml = `` /* 322-byte string literal not displayed */

	// PVCYaml for PVC CR
	PVCYaml = `` /* 213-byte string literal not displayed */

)

const (

	// CVRMaxRetry count to check CVR updated state
	CVRMaxRetry = 5
)

Variables

var (
	// Client for openebs ClientSet
	Client *ClientSet

	// SPCName for SPC
	SPCName string

	// PVCName for PVC
	PVCName string

	// AppPVC created by openebs
	AppPVC *corev1.PersistentVolumeClaim
)

Types

type ClientSet

type ClientSet struct {
	clientset.Interface
}

ClientSet interface for OpenEBS API

func (*ClientSet) CheckCVRStatus

func (c *ClientSet) CheckCVRStatus(pvc, ns string, status v1alpha1.CStorVolumeReplicaPhase) bool

CheckCVRStatus check CVR status for given PVC

func (*ClientSet) CheckSnapshot

func (c *ClientSet) CheckSnapshot(pvc, pvcNs, snapshot string) (bool, error)

CheckSnapshot check if given snapshot is created or not

func (*ClientSet) CreateSPC

func (c *ClientSet) CreateSPC(spcYAML string) error

CreateSPC create SPC for given YAML

func (*ClientSet) CreateVolume

func (c *ClientSet) CreateVolume(pvcYAML, pvcNs string, wait bool) error

CreateVolume create volume from given PVC yaml

func (*ClientSet) DeleteVolume

func (c *ClientSet) DeleteVolume(pvcYAML, pvcNs string) error

DeleteVolume delete volume for given PVC YAML

func (*ClientSet) DumpLogs

func (c *ClientSet) DumpLogs()

DumpLogs will dump openebs logs

func (*ClientSet) GetCStorBackups

func (c *ClientSet) GetCStorBackups(backup, ns string) (*v1alpha1.CStorBackupList, error)

GetCStorBackups returns cstorbackup list for the given backup

func (*ClientSet) GetCStorCompletedBackups

func (c *ClientSet) GetCStorCompletedBackups(backup, ns string) (*v1alpha1.CStorCompletedBackupList, error)

GetCStorCompletedBackups returns cstorcompletedbackup list for the given backup

func (*ClientSet) IsBackupResourcesExist

func (c *ClientSet) IsBackupResourcesExist(backup, pvc, ns string) (bool, error)

IsBackupResourcesExist checks if backupResources, for the given backup, exist or not

func (*ClientSet) WaitForHealthyCVR

func (c *ClientSet) WaitForHealthyCVR(pvc *v1.PersistentVolumeClaim) error

WaitForHealthyCVR wait till CVR for given PVC becomes healthy