storage

package
v0.0.0-...-ddb5be7 Latest Latest
Warning

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

 Go to latest Published: Feb 3, 2025 License: Apache-2.0 Imports: 18 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	// APIGroup represents storageCluster api group.
	APIGroup = "ocs.openshift.io"
	// APIVersion represents version of storageCluster api.
	APIVersion = "v1"
	// StorageClusterKind represents kind of storageCluster object.
	StorageClusterKind = "StorageCluster"
)

Variables

This section is empty.

Functions

func GetPersistentVolumeClaimGVR 

func GetPersistentVolumeClaimGVR() schema.GroupVersionResource

GetPersistentVolumeClaimGVR returns the GroupVersionResource for the PersistentVolumeClaim.

Types

type AdditionalOptions 

type AdditionalOptions func(builder *ClassBuilder) (*ClassBuilder, error)

AdditionalOptions additional options for storageclass object.

type ClassBuilder 

type ClassBuilder struct {
	// Storageclass definition. Used to create the storageclass object.
	Definition *storageV1.StorageClass
	// Created storageclass object
	Object *storageV1.StorageClass
	// contains filtered or unexported fields
}

ClassBuilder provides struct for storageclass object containing connection to the cluster and the storageclass definitions.

func NewClassBuilder 

func NewClassBuilder(apiClient *clients.Settings, name, provisioner string) *ClassBuilder

NewClassBuilder creates a new instance of ClassBuilder.

func PullClass 

func PullClass(apiClient *clients.Settings, name string) (*ClassBuilder, error)

PullClass pulls an existing storage class into a ClassBuilder struct.

func (*ClassBuilder) Create 

func (builder *ClassBuilder) Create() (*ClassBuilder, error)

Create generates a storageclass in cluster and stores the created object in struct.

func (*ClassBuilder) Delete 

func (builder *ClassBuilder) Delete() error

Delete removes a storageclass.

func (*ClassBuilder) DeleteAndWait 

func (builder *ClassBuilder) DeleteAndWait(timeout time.Duration) error

DeleteAndWait deletes the StorageClass and waits up to timeout until it has been removed.

func (*ClassBuilder) Exists 

func (builder *ClassBuilder) Exists() bool

Exists checks whether the given storageclass exists.

func (*ClassBuilder) Update 

func (builder *ClassBuilder) Update(force bool) (*ClassBuilder, error)

Update renovates the existing storageclass object with the storageclass definition in builder.

func (*ClassBuilder) WaitUntilDeleted 

func (builder *ClassBuilder) WaitUntilDeleted(timeout time.Duration) error

WaitUntilDeleted waits for the duration of timeout or until the StorageClass has been deleted.

func (*ClassBuilder) WithOptions 

func (builder *ClassBuilder) WithOptions(options ...AdditionalOptions) *ClassBuilder

WithOptions creates a storageclass with generic mutation options.

func (*ClassBuilder) WithParameter 

func (builder *ClassBuilder) WithParameter(parameterKey, parameterValue string) *ClassBuilder

WithParameter adds a parameter to the storage class definition.

func (*ClassBuilder) WithReclaimPolicy 

func (builder *ClassBuilder) WithReclaimPolicy(
	reclaimPolicy corev1.PersistentVolumeReclaimPolicy) *ClassBuilder

WithReclaimPolicy adds a reclaimPolicy to the storageclass definition.

func (*ClassBuilder) WithVolumeBindingMode 

func (builder *ClassBuilder) WithVolumeBindingMode(
	bindingMode storageV1.VolumeBindingMode) *ClassBuilder

WithVolumeBindingMode adds a volumeBindingMode to the storage class definition.

type ObjectBucketClaimBuilder 

type ObjectBucketClaimBuilder struct {
	// ObjectBucketClaim definition. Used to create objectBucketClaim object with minimum set of required elements.
	Definition *noobaav1alpha1.ObjectBucketClaim
	// Created objectBucketClaim object on the cluster.
	Object *noobaav1alpha1.ObjectBucketClaim
	// contains filtered or unexported fields
}

ObjectBucketClaimBuilder provides struct for the objectBucketClaim object.

func NewObjectBucketClaimBuilder 

func NewObjectBucketClaimBuilder(
	apiClient *clients.Settings, name, nsname string) *ObjectBucketClaimBuilder

NewObjectBucketClaimBuilder creates new instance of builder.

func PullObjectBucketClaim 

func PullObjectBucketClaim(apiClient *clients.Settings, name, nsname string) (*ObjectBucketClaimBuilder, error)

PullObjectBucketClaim retrieves an existing objectBucketClaim object from the cluster.

func (*ObjectBucketClaimBuilder) Create 

func (builder *ObjectBucketClaimBuilder) Create() (*ObjectBucketClaimBuilder, error)

Create makes a objectBucketClaim in the cluster and stores the created object in struct.

func (*ObjectBucketClaimBuilder) Delete 

func (builder *ObjectBucketClaimBuilder) Delete() error

Delete removes objectBucketClaim from a cluster.

func (*ObjectBucketClaimBuilder) Exists 

func (builder *ObjectBucketClaimBuilder) Exists() bool

Exists checks whether the given objectBucketClaim exists.

func (*ObjectBucketClaimBuilder) Get 

func (builder *ObjectBucketClaimBuilder) Get() (*noobaav1alpha1.ObjectBucketClaim, error)

Get returns objectBucketClaim object if found.

func (*ObjectBucketClaimBuilder) Update 

func (builder *ObjectBucketClaimBuilder) Update() (*ObjectBucketClaimBuilder, error)

Update renovates the existing objectBucketClaim object with objectBucketClaim definition in builder.

func (*ObjectBucketClaimBuilder) WithGenerateBucketName 

func (builder *ObjectBucketClaimBuilder) WithGenerateBucketName(
	generateBucketName string) *ObjectBucketClaimBuilder

WithGenerateBucketName sets the objectBucketClaim operator's generateBucketName configuration.

func (*ObjectBucketClaimBuilder) WithStorageClassName 

func (builder *ObjectBucketClaimBuilder) WithStorageClassName(
	storageClassName string) *ObjectBucketClaimBuilder

WithStorageClassName sets the objectBucketClaim operator's storageClassName configuration.

type PVBuilder 

type PVBuilder struct {
	// PersistentVolume definition. Used to create a persistentvolume object
	Definition *corev1.PersistentVolume
	// Created persistentvolume object
	Object *corev1.PersistentVolume
	// contains filtered or unexported fields
}

PVBuilder provides struct for persistentvolume object containing connection to the cluster and the persistentvolume definitions.

func ListPV 

func ListPV(apiClient *clients.Settings, options ...metav1.ListOptions) ([]*PVBuilder, error)

ListPV returns a list of builders for persistentVolume.

func PullPersistentVolume 

func PullPersistentVolume(apiClient *clients.Settings, name string) (*PVBuilder, error)

PullPersistentVolume gets an existing PersistentVolume from the cluster.

func (*PVBuilder) Delete 

func (builder *PVBuilder) Delete() error

Delete removes a PersistentVolume from the apiClient if it exists.

func (*PVBuilder) DeleteAndWait 

func (builder *PVBuilder) DeleteAndWait(timeout time.Duration) error

DeleteAndWait deletes the PersistentVolume and waits up to timeout until it has been removed.

func (*PVBuilder) Exists 

func (builder *PVBuilder) Exists() bool

Exists checks whether the given PersistentVolume exists.

func (*PVBuilder) WaitUntilDeleted 

func (builder *PVBuilder) WaitUntilDeleted(timeout time.Duration) error

WaitUntilDeleted waits for the duration of timeout or until the PersistentVolume has been deleted.

type PVCBuilder 

type PVCBuilder struct {
	// PersistentVolumeClaim definition. Used to create a persistentvolumeclaim object
	Definition *corev1.PersistentVolumeClaim
	// Created persistentvolumeclaim object
	Object *corev1.PersistentVolumeClaim
	// contains filtered or unexported fields
}

PVCBuilder provides struct for persistentvolumeclaim object containing connection to the cluster and the persistentvolumeclaim definitions.

func ListPVC 

func ListPVC(apiClient *clients.Settings, nsname string, options ...metav1.ListOptions) ([]*PVCBuilder, error)

ListPVC returns a list of builders for persistentVolumeClaim.

func NewPVCBuilder 

func NewPVCBuilder(apiClient *clients.Settings, name, nsname string) *PVCBuilder

NewPVCBuilder creates a new structure for persistentvolumeclaim.

func PullPersistentVolumeClaim 

func PullPersistentVolumeClaim(
	apiClient *clients.Settings, name string, nsname string) (
	*PVCBuilder, error)

PullPersistentVolumeClaim gets an existing PersistentVolumeClaim from the cluster.

func (*PVCBuilder) Create 

func (builder *PVCBuilder) Create() (*PVCBuilder, error)

Create generates a PVC in cluster and stores the created object in struct.

func (*PVCBuilder) Delete 

func (builder *PVCBuilder) Delete() error

Delete removes PVC from cluster.

func (*PVCBuilder) DeleteAndWait 

func (builder *PVCBuilder) DeleteAndWait(timeout time.Duration) error

DeleteAndWait deletes PersistentVolumeClaim and waits until it is removed from the cluster.

func (*PVCBuilder) Exists 

func (builder *PVCBuilder) Exists() bool

Exists checks whether the given PersistentVolumeClaim exists.

func (*PVCBuilder) WithPVCAccessMode 

func (builder *PVCBuilder) WithPVCAccessMode(accessMode string) (*PVCBuilder, error)

WithPVCAccessMode configure access mode for the PV.

func (*PVCBuilder) WithPVCCapacity 

func (builder *PVCBuilder) WithPVCCapacity(capacity string) (*PVCBuilder, error)

WithPVCCapacity configures the minimum resources the volume should have.

func (*PVCBuilder) WithStorageClass 

func (builder *PVCBuilder) WithStorageClass(storageClass string) (*PVCBuilder, error)

WithStorageClass configures storageClass required by the claim.

func (*PVCBuilder) WithVolumeMode 

func (builder *PVCBuilder) WithVolumeMode(volumeMode string) (*PVCBuilder, error)

WithVolumeMode configures what type of volume is required by the claim.

type StorageClusterBuilder 

type StorageClusterBuilder struct {
	// StorageCluster definition. Used to create a storageCluster object
	Definition *ocsoperatorv1.StorageCluster
	// Created storageCluster object
	Object *ocsoperatorv1.StorageCluster
	// contains filtered or unexported fields
}

StorageClusterBuilder provides struct for StorageCluster object containing connection to the cluster and the storageCluster definitions.

func NewStorageClusterBuilder 

func NewStorageClusterBuilder(apiClient *clients.Settings, name, nsname string) *StorageClusterBuilder

NewStorageClusterBuilder creates a new instance of StorageClusterBuilder.

func PullStorageCluster 

func PullStorageCluster(apiClient *clients.Settings, name, namespace string) (*StorageClusterBuilder, error)

PullStorageCluster gets an existing storageCluster object from the cluster.

func (*StorageClusterBuilder) Create 

func (builder *StorageClusterBuilder) Create() (*StorageClusterBuilder, error)

Create makes a storageCluster in the cluster and stores the created object in struct.

func (*StorageClusterBuilder) Delete 

func (builder *StorageClusterBuilder) Delete() error

Delete removes storageCluster object from a cluster.

func (*StorageClusterBuilder) Exists 

func (builder *StorageClusterBuilder) Exists() bool

Exists checks whether the given storageCluster exists.

func (*StorageClusterBuilder) Get 

func (builder *StorageClusterBuilder) Get() (*ocsoperatorv1.StorageCluster, error)

Get fetches existing storageCluster from cluster.

func (*StorageClusterBuilder) GetManageNodes 

func (builder *StorageClusterBuilder) GetManageNodes() (bool, error)

GetManageNodes fetches storageCluster manageNodes value.

func (*StorageClusterBuilder) GetManagedResources 

func (builder *StorageClusterBuilder) GetManagedResources() (*ocsoperatorv1.ManagedResourcesSpec, error)

GetManagedResources fetches storageCluster managedResources value.

func (*StorageClusterBuilder) GetMonDataDirHostPath 

func (builder *StorageClusterBuilder) GetMonDataDirHostPath() (string, error)

GetMonDataDirHostPath fetches storageCluster monDataDirHostPath value.

func (*StorageClusterBuilder) GetMultiCloudGateway 

func (builder *StorageClusterBuilder) GetMultiCloudGateway() (*ocsoperatorv1.MultiCloudGatewaySpec, error)

GetMultiCloudGateway fetches storageCluster multiCloudGateway value.

func (*StorageClusterBuilder) GetStorageDeviceSets 

func (builder *StorageClusterBuilder) GetStorageDeviceSets() ([]ocsoperatorv1.StorageDeviceSet, error)

GetStorageDeviceSets fetches storageCluster storageDeviceSets value.

func (*StorageClusterBuilder) Update 

func (builder *StorageClusterBuilder) Update() (*StorageClusterBuilder, error)

Update renovates the storageCluster in the cluster and stores the created object in struct.

func (*StorageClusterBuilder) WithAnnotations 

func (builder *StorageClusterBuilder) WithAnnotations(
	annotations map[string]string) *StorageClusterBuilder

WithAnnotations sets the storageCluster's annotations value.

func (*StorageClusterBuilder) WithFlexibleScaling 

func (builder *StorageClusterBuilder) WithFlexibleScaling(flexibleScaling bool) *StorageClusterBuilder

WithFlexibleScaling sets the storageCluster's flexibleScaling value.

func (*StorageClusterBuilder) WithManageNodes 

func (builder *StorageClusterBuilder) WithManageNodes(expectedManagedNodesValue bool) *StorageClusterBuilder

WithManageNodes sets the storageCluster's managedNodes value.

func (*StorageClusterBuilder) WithManagedResources 

func (builder *StorageClusterBuilder) WithManagedResources(
	expectedManagedResources ocsoperatorv1.ManagedResourcesSpec) *StorageClusterBuilder

WithManagedResources sets the storageCluster's managedResources value.

func (*StorageClusterBuilder) WithMonDataDirHostPath 

func (builder *StorageClusterBuilder) WithMonDataDirHostPath(
	expectedMonDataDirHostPath string) *StorageClusterBuilder

WithMonDataDirHostPath sets the storageCluster's monDataDirHostPath value.

func (*StorageClusterBuilder) WithMultiCloudGateway 

func (builder *StorageClusterBuilder) WithMultiCloudGateway(
	expectedMultiCloudGateway ocsoperatorv1.MultiCloudGatewaySpec) *StorageClusterBuilder

WithMultiCloudGateway sets the storageCluster's multiCloudGateway value.

func (*StorageClusterBuilder) WithStorageDeviceSet 

func (builder *StorageClusterBuilder) WithStorageDeviceSet(
	expectedStorageDeviceSet ocsoperatorv1.StorageDeviceSet) *StorageClusterBuilder

WithStorageDeviceSet sets the storageCluster's storageDeviceSets value.

type SystemODFBuilder 

type SystemODFBuilder struct {
	// SystemODF definition. Used to create a SystemODF object
	Definition *odfoperatorv1alpha1.StorageSystem
	// Created SystemODF object
	Object *odfoperatorv1alpha1.StorageSystem
	// contains filtered or unexported fields
}

SystemODFBuilder provides struct for SystemODF object containing connection to the cluster and the SystemODF definitions.

func NewSystemODFBuilder 

func NewSystemODFBuilder(apiClient *clients.Settings, name, nsname string) *SystemODFBuilder

NewSystemODFBuilder creates a new instance of Builder.

func PullSystemODF 

func PullSystemODF(apiClient *clients.Settings, name, namespace string) (*SystemODFBuilder, error)

PullSystemODF gets an existing SystemODF object from the cluster.

func (*SystemODFBuilder) Create 

func (builder *SystemODFBuilder) Create() (*SystemODFBuilder, error)

Create makes a SystemODF in the cluster and stores the created object in struct.

func (*SystemODFBuilder) Delete 

func (builder *SystemODFBuilder) Delete() error

Delete removes SystemODF object from a cluster.

func (*SystemODFBuilder) Exists 

func (builder *SystemODFBuilder) Exists() bool

Exists checks whether the given SystemODF exists.

func (*SystemODFBuilder) Get 

func (builder *SystemODFBuilder) Get() (*odfoperatorv1alpha1.StorageSystem, error)

Get fetches existing SystemODF from cluster.

func (*SystemODFBuilder) WithSpec 

func (builder *SystemODFBuilder) WithSpec(
	kind odfoperatorv1alpha1.StorageKind, name, nsname string) *SystemODFBuilder

WithSpec sets the SystemODF with storageCluster spec values.

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.