client

Documentation

Index

• type OCSProviderClient
  • func NewProviderClient(ctx context.Context, serverAddr string, timeout time.Duration) (*OCSProviderClient, error)
  • func (cc *OCSProviderClient) AcknowledgeOnboarding(ctx context.Context, consumerUUID string) (*pb.AcknowledgeOnboardingResponse, error)
  • func (cc *OCSProviderClient) Close()
  • func (cc *OCSProviderClient) FulfillStorageClassClaim(ctx context.Context, consumerUUID string, storageClassClaimName string, ...) (*pb.FulfillStorageClassClaimResponse, error)
  • func (cc *OCSProviderClient) GetStorageClassClaimConfig(ctx context.Context, consumerUUID, storageClassClaimName string) (*pb.StorageClassClaimConfigResponse, error)
  • func (cc *OCSProviderClient) GetStorageConfig(ctx context.Context, consumerUUID string) (*pb.StorageConfigResponse, error)
  • func (cc *OCSProviderClient) OffboardConsumer(ctx context.Context, consumerUUID string) (*pb.OffboardConsumerResponse, error)
  • func (cc *OCSProviderClient) OnboardConsumer(ctx context.Context, ticket, name, capacity string) (*pb.OnboardConsumerResponse, error)
  • func (cc *OCSProviderClient) ReportStatus(ctx context.Context, consumerUUID string) (*pb.ReportStatusResponse, error)
  • func (cc *OCSProviderClient) RevokeStorageClassClaim(ctx context.Context, consumerUUID, storageClassClaimName string) (*pb.RevokeStorageClassClaimResponse, error)
  • func (cc *OCSProviderClient) UpdateCapacity(ctx context.Context, consumerUUID, capacity string) (*pb.UpdateCapacityResponse, error)
• type StorageType

Types

type OCSProviderClient

type OCSProviderClient struct {
	Client pb.OCSProviderClient
	// contains filtered or unexported fields
}

func NewProviderClient

func NewProviderClient(ctx context.Context, serverAddr string, timeout time.Duration) (*OCSProviderClient, error)

NewProviderClient creates a client to talk to the external OCS storage provider server

func (*OCSProviderClient) AcknowledgeOnboarding

func (cc *OCSProviderClient) AcknowledgeOnboarding(ctx context.Context, consumerUUID string) (*pb.AcknowledgeOnboardingResponse, error)

func (*OCSProviderClient) Close

func (cc *OCSProviderClient) Close()

Close closes the gRPC connection of the external OCS storage provider client

func (*OCSProviderClient) FulfillStorageClassClaim

func (cc *OCSProviderClient) FulfillStorageClassClaim(
	ctx context.Context,
	consumerUUID string,
	storageClassClaimName string,
	storageType StorageType,
	storageProfile string,
	encryptionMethod string,
) (*pb.FulfillStorageClassClaimResponse, error)

func (*OCSProviderClient) GetStorageClassClaimConfig

func (cc *OCSProviderClient) GetStorageClassClaimConfig(ctx context.Context, consumerUUID, storageClassClaimName string) (*pb.StorageClassClaimConfigResponse, error)

func (*OCSProviderClient) GetStorageConfig

func (cc *OCSProviderClient) GetStorageConfig(ctx context.Context, consumerUUID string) (*pb.StorageConfigResponse, error)

GetStorageConfig generates the json config for connecting to storage provider cluster

func (*OCSProviderClient) OffboardConsumer

func (cc *OCSProviderClient) OffboardConsumer(ctx context.Context, consumerUUID string) (*pb.OffboardConsumerResponse, error)

OffboardConsumer deletes the StorageConsumer CR on the storage provider cluster

func (*OCSProviderClient) OnboardConsumer

func (cc *OCSProviderClient) OnboardConsumer(ctx context.Context, ticket, name, capacity string) (*pb.OnboardConsumerResponse, error)

OnboardConsumer to validate the consumer and create StorageConsumer resource on the StorageProvider cluster

func (*OCSProviderClient) ReportStatus

func (cc *OCSProviderClient) ReportStatus(ctx context.Context, consumerUUID string) (*pb.ReportStatusResponse, error)

func (*OCSProviderClient) RevokeStorageClassClaim

func (cc *OCSProviderClient) RevokeStorageClassClaim(ctx context.Context, consumerUUID, storageClassClaimName string) (*pb.RevokeStorageClassClaimResponse, error)

func (*OCSProviderClient) UpdateCapacity

func (cc *OCSProviderClient) UpdateCapacity(ctx context.Context, consumerUUID, capacity string) (*pb.UpdateCapacityResponse, error)

UpdateCapacity increases or decreases the storage block pool size

type StorageType

type StorageType uint

const (
	StorageTypeBlockpool StorageType = iota
	StorageTypeSharedfilesystem
)