Documentation ¶
Index ¶
- func IsClusterHealthy(testClient *TestClient, namespace string) error
- type BlockImage
- type BlockOperation
- func (b *BlockOperation) BlockMap(manifest string) (string, error)
- func (b *BlockOperation) Create(manifest string, size int) (string, error)
- func (b *BlockOperation) CreatePvc(claimName, storageClassName, mode, size string) error
- func (b *BlockOperation) CreateStorageClass(poolName, storageClassName, reclaimPolicy, namespace string, ...) error
- func (b *BlockOperation) DeleteBlock(manifest string) (string, error)
- func (b *BlockOperation) DeleteBlockImage(image BlockImage, namespace string) error
- func (b *BlockOperation) DeletePvc(claimName, storageClassName, mode, size string) error
- func (b *BlockOperation) DeleteStorageClass(poolName, storageClassName, reclaimPolicy, namespace string) error
- func (b *BlockOperation) List(namespace string) ([]BlockImage, error)
- type BucketOperation
- func (b *BucketOperation) CheckOBC(obcName, check string) bool
- func (b *BucketOperation) CreateBucketStorageClass(namespace string, storeName string, storageClassName string, ...) error
- func (b *BucketOperation) CreateObc(obcName string, storageClassName string, bucketName string, createBucket bool) error
- func (b *BucketOperation) DeleteBucketStorageClass(namespace string, storeName string, storageClassName string, ...) error
- func (b *BucketOperation) DeleteObc(obcName string, storageClassName string, bucketName string, createBucket bool) error
- func (b *BucketOperation) GetAccessKey(obcName string) (string, error)
- func (b *BucketOperation) GetSecretKey(obcName string) (string, error)
- type FilesystemOperation
- type NFSOperation
- type ObjectOperation
- type ObjectUserOperation
- func (o *ObjectUserOperation) Create(namespace string, userid string, displayName string, store string) error
- func (o *ObjectUserOperation) Delete(namespace string, userid string) error
- func (o *ObjectUserOperation) GetUser(namespace string, store string, userid string) (*rgw.ObjectUser, error)
- func (o *ObjectUserOperation) UserSecretExists(namespace string, store string, userid string) bool
- type PoolOperation
- func (p *PoolOperation) CephPoolExists(namespace, name string) (bool, error)
- func (p *PoolOperation) Create(name, namespace string, replicas int) error
- func (p *PoolOperation) CreateStorageClass(namespace, poolName, storageClassName, reclaimPolicy string) error
- func (p *PoolOperation) CreateStorageClassAndPvc(namespace, poolName, storageClassName, reclaimPolicy, blockName, mode string) error
- func (p *PoolOperation) Delete(name string, namespace string) error
- func (p *PoolOperation) DeletePvc(blockName, storageClassName, mode string) error
- func (p *PoolOperation) DeleteStorageClass(namespace, poolName, storageClassName, reclaimPolicy string) error
- func (p *PoolOperation) DeleteStorageClassAndPvc(namespace, poolName, storageClassName, reclaimPolicy, blockName, mode string) error
- func (p *PoolOperation) GetCephPoolDetails(namespace, name string) (client.CephStoragePoolDetails, error)
- func (p *PoolOperation) ListCephPools(namespace string) ([]client.CephStoragePoolSummary, error)
- func (p *PoolOperation) ListPoolCRDs(namespace string) ([]cephv1.CephBlockPool, error)
- func (p *PoolOperation) PoolCRDExists(namespace, name string) (bool, error)
- func (p *PoolOperation) Update(name, namespace string, replicas int) error
- type ReadWriteOperation
- type TestClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsClusterHealthy ¶ added in v0.6.0
func IsClusterHealthy(testClient *TestClient, namespace string) error
IsClusterHealthy determines if the Rook cluster is currently healthy or not.
Types ¶
type BlockImage ¶ added in v0.8.0
type BlockOperation ¶
type BlockOperation struct {
// contains filtered or unexported fields
}
BlockOperation is wrapper for k8s rook block operations
func CreateBlockOperation ¶ added in v0.9.0
func CreateBlockOperation(k8shelp *utils.K8sHelper, manifests installer.CephManifests) *BlockOperation
CreateBlockOperation - Constructor to create BlockOperation - client to perform rook Block operations on k8s
func (*BlockOperation) BlockMap ¶
func (b *BlockOperation) BlockMap(manifest string) (string, error)
BlockMap Function to map a Block using Rook Input parameters - manifest - Pod definition - pod should be defined to use a pvc that was created earlier Output - k8s create pod operation output and/or error
func (*BlockOperation) Create ¶ added in v0.8.0
func (b *BlockOperation) Create(manifest string, size int) (string, error)
BlockCreate Function to create a Block using Rook Input parameters - manifest - pod definition that creates a pvc in k8s - yaml should describe name and size of pvc being created size - not user for k8s implementation since its descried on the pvc yaml definition Output - k8s create pvc operation output and/or error
func (*BlockOperation) CreatePvc ¶ added in v0.9.0
func (b *BlockOperation) CreatePvc(claimName, storageClassName, mode, size string) error
func (*BlockOperation) CreateStorageClass ¶ added in v0.9.0
func (b *BlockOperation) CreateStorageClass(poolName, storageClassName, reclaimPolicy, namespace string, varClusterName bool) error
func (*BlockOperation) DeleteBlock ¶ added in v0.8.0
func (b *BlockOperation) DeleteBlock(manifest string) (string, error)
BlockDelete Function to delete a Block using Rook Input parameters - manifest - pod definition where pvc is described - delete is run on the the yaml definition Output - k8s delete pvc operation output and/or error
func (*BlockOperation) DeleteBlockImage ¶ added in v0.8.0
func (b *BlockOperation) DeleteBlockImage(image BlockImage, namespace string) error
DeleteBlockImage Function to list all the blocks created/being managed by rook
func (*BlockOperation) DeletePvc ¶ added in v0.9.0
func (b *BlockOperation) DeletePvc(claimName, storageClassName, mode, size string) error
func (*BlockOperation) DeleteStorageClass ¶ added in v0.9.0
func (b *BlockOperation) DeleteStorageClass(poolName, storageClassName, reclaimPolicy, namespace string) error
func (*BlockOperation) List ¶ added in v0.8.0
func (b *BlockOperation) List(namespace string) ([]BlockImage, error)
List Function to list all the blocks created/being managed by rook
type BucketOperation ¶ added in v1.1.0
type BucketOperation struct {
// contains filtered or unexported fields
}
BucketOperation is a wrapper for rook bucket operations
func CreateBucketOperation ¶ added in v1.1.0
func CreateBucketOperation(k8sh *utils.K8sHelper, manifests installer.CephManifests) *BucketOperation
CreateBucketOperation creates a new bucket client
func (*BucketOperation) CheckOBC ¶ added in v1.1.0
func (b *BucketOperation) CheckOBC(obcName, check string) bool
CheckOBC, returns true if the obc, secret and configmap are all in the "check" state, and returns false if any of these resources are not in the "check" state. Check state values:
"created", all must exist, "deleted", all must be missing.
func (*BucketOperation) CreateBucketStorageClass ¶ added in v1.1.0
func (*BucketOperation) DeleteBucketStorageClass ¶ added in v1.1.0
func (*BucketOperation) GetAccessKey ¶ added in v1.1.0
func (b *BucketOperation) GetAccessKey(obcName string) (string, error)
Fetch SecretKey, AccessKey for s3 client.
func (*BucketOperation) GetSecretKey ¶ added in v1.1.0
func (b *BucketOperation) GetSecretKey(obcName string) (string, error)
type FilesystemOperation ¶ added in v0.6.0
type FilesystemOperation struct {
// contains filtered or unexported fields
}
FilesystemOperation is a wrapper for k8s rook file operations
func CreateFilesystemOperation ¶ added in v0.9.0
func CreateFilesystemOperation(k8sh *utils.K8sHelper, manifests installer.CephManifests) *FilesystemOperation
CreateFilesystemOperation Constructor to create FilesystemOperation - client to perform rook file system operations on k8s
func (*FilesystemOperation) Create ¶ added in v0.8.0
func (f *FilesystemOperation) Create(name, namespace string) error
Create creates a filesystem in Rook
func (*FilesystemOperation) Delete ¶ added in v0.8.0
func (f *FilesystemOperation) Delete(name, namespace string) error
Delete deletes a filesystem in Rook
func (*FilesystemOperation) List ¶ added in v0.8.0
func (f *FilesystemOperation) List(namespace string) ([]client.CephFilesystem, error)
List lists filesystems in Rook
func (*FilesystemOperation) ScaleDown ¶ added in v0.9.0
func (f *FilesystemOperation) ScaleDown(name, namespace string) error
ScaleDown scales down the number of active metadata servers of a filesystem in Rook
type NFSOperation ¶ added in v1.0.0
type NFSOperation struct {
// contains filtered or unexported fields
}
NFSOperation is a wrapper for k8s rook file operations
func CreateNFSOperation ¶ added in v1.0.0
func CreateNFSOperation(k8sh *utils.K8sHelper, manifests installer.CephManifests) *NFSOperation
CreateNFSOperation Constructor to create NFSOperation - client to perform ceph nfs operations on k8s
func (*NFSOperation) Create ¶ added in v1.0.0
func (n *NFSOperation) Create(namespace, name, pool string, daemonCount int) error
Create creates a filesystem in Rook
func (*NFSOperation) Delete ¶ added in v1.0.0
func (n *NFSOperation) Delete(namespace, name string) error
Delete deletes a filesystem in Rook
type ObjectOperation ¶
type ObjectOperation struct {
// contains filtered or unexported fields
}
ObjectOperation is wrapper for k8s rook object operations
func CreateObjectOperation ¶
func CreateObjectOperation(k8sh *utils.K8sHelper, manifests installer.CephManifests) *ObjectOperation
CreateObjectOperation creates new rook object client
func (*ObjectOperation) Create ¶ added in v0.8.0
func (o *ObjectOperation) Create(namespace, storeName string, replicaCount int32) error
ObjectCreate Function to create a object store in rook
func (*ObjectOperation) Delete ¶ added in v0.8.0
func (o *ObjectOperation) Delete(namespace, storeName string) error
func (*ObjectOperation) GetEndPointUrl ¶ added in v1.1.0
func (o *ObjectOperation) GetEndPointUrl(namespace string, storeName string) (string, error)
Need to improve the below function for better error handling
type ObjectUserOperation ¶ added in v0.9.0
type ObjectUserOperation struct {
// contains filtered or unexported fields
}
ObjectUserOperation is wrapper for k8s rook object user operations
func CreateObjectUserOperation ¶ added in v0.9.0
func CreateObjectUserOperation(k8sh *utils.K8sHelper, manifests installer.CephManifests) *ObjectUserOperation
CreateObjectUserOperation creates new rook object user client
func (*ObjectUserOperation) Create ¶ added in v0.9.0
func (o *ObjectUserOperation) Create(namespace string, userid string, displayName string, store string) error
ObjectUserCreate Function to create a object store user in rook
func (*ObjectUserOperation) Delete ¶ added in v0.9.0
func (o *ObjectUserOperation) Delete(namespace string, userid string) error
func (*ObjectUserOperation) GetUser ¶ added in v0.9.0
func (o *ObjectUserOperation) GetUser(namespace string, store string, userid string) (*rgw.ObjectUser, error)
ObjectUserGet Function to get the details of an object user from radosgw
func (*ObjectUserOperation) UserSecretExists ¶ added in v0.9.0
func (o *ObjectUserOperation) UserSecretExists(namespace string, store string, userid string) bool
UserSecretExists Function to check that user secret was created
type PoolOperation ¶ added in v0.8.0
type PoolOperation struct {
// contains filtered or unexported fields
}
PoolOperation is a wrapper for rook pool operations
func CreatePoolOperation ¶ added in v0.8.0
func CreatePoolOperation(k8sh *utils.K8sHelper, manifests installer.CephManifests) *PoolOperation
CreatePoolOperation creates a new pool client
func (*PoolOperation) CephPoolExists ¶ added in v0.8.0
func (p *PoolOperation) CephPoolExists(namespace, name string) (bool, error)
func (*PoolOperation) Create ¶ added in v0.8.0
func (p *PoolOperation) Create(name, namespace string, replicas int) error
func (*PoolOperation) CreateStorageClass ¶ added in v0.9.0
func (p *PoolOperation) CreateStorageClass(namespace, poolName, storageClassName, reclaimPolicy string) error
func (*PoolOperation) CreateStorageClassAndPvc ¶ added in v0.9.0
func (p *PoolOperation) CreateStorageClassAndPvc(namespace, poolName, storageClassName, reclaimPolicy, blockName, mode string) error
func (*PoolOperation) Delete ¶ added in v0.9.0
func (p *PoolOperation) Delete(name string, namespace string) error
func (*PoolOperation) DeletePvc ¶ added in v0.9.0
func (p *PoolOperation) DeletePvc(blockName, storageClassName, mode string) error
func (*PoolOperation) DeleteStorageClass ¶ added in v0.9.0
func (p *PoolOperation) DeleteStorageClass(namespace, poolName, storageClassName, reclaimPolicy string) error
func (*PoolOperation) DeleteStorageClassAndPvc ¶ added in v0.9.0
func (p *PoolOperation) DeleteStorageClassAndPvc(namespace, poolName, storageClassName, reclaimPolicy, blockName, mode string) error
func (*PoolOperation) GetCephPoolDetails ¶ added in v0.8.0
func (p *PoolOperation) GetCephPoolDetails(namespace, name string) (client.CephStoragePoolDetails, error)
func (*PoolOperation) ListCephPools ¶ added in v0.8.0
func (p *PoolOperation) ListCephPools(namespace string) ([]client.CephStoragePoolSummary, error)
func (*PoolOperation) ListPoolCRDs ¶ added in v0.8.0
func (p *PoolOperation) ListPoolCRDs(namespace string) ([]cephv1.CephBlockPool, error)
func (*PoolOperation) PoolCRDExists ¶ added in v0.8.0
func (p *PoolOperation) PoolCRDExists(namespace, name string) (bool, error)
type ReadWriteOperation ¶ added in v0.9.0
type ReadWriteOperation struct {
// contains filtered or unexported fields
}
ReadWriteOperation is a wrapper for k8s rook file operations
func CreateReadWriteOperation ¶ added in v0.9.0
func CreateReadWriteOperation(k8sh *utils.K8sHelper) *ReadWriteOperation
CreateReadWriteOperation Constructor to create ReadWriteOperation - client to perform rook file system operations on k8s
func (*ReadWriteOperation) CreateWriteClient ¶ added in v0.9.0
func (f *ReadWriteOperation) CreateWriteClient(volName string) ([]string, error)
CreateWriteClient Function to create a nfs client in rook
func (*ReadWriteOperation) Delete ¶ added in v0.9.0
func (f *ReadWriteOperation) Delete() error
Delete Function to delete a nfs consuming pod in rook
type TestClient ¶
type TestClient struct { BlockClient *BlockOperation FSClient *FilesystemOperation NFSClient *NFSOperation ObjectClient *ObjectOperation ObjectUserClient *ObjectUserOperation PoolClient *PoolOperation BucketClient *BucketOperation // contains filtered or unexported fields }
TestClient is a wrapper for test client, containing interfaces for all rook operations
func CreateTestClient ¶
func CreateTestClient(k8sHelper *utils.K8sHelper, manifests installer.CephManifests) *TestClient
CreateTestClient creates new instance of test client for a platform
func (TestClient) Status ¶
func (c TestClient) Status(namespace string) (client.CephStatus, error)
Status returns rook status details