client

Documentation

Index

• func NewOnboardConsumerRequest() ifaces.StorageClientOnboarding
• func NewStorageClientStatus() ifaces.StorageClientStatus
• 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) FulfillStorageClaim(ctx context.Context, consumerUUID string, storageClaimName string, ...) (*pb.FulfillStorageClaimResponse, error)
  • func (cc *OCSProviderClient) GetBlockPoolsInfo(ctx context.Context, storageClusterUID string, blockPoolNames []string) (*pb.BlockPoolsInfoResponse, error)
  • func (cc *OCSProviderClient) GetStorageClaimConfig(ctx context.Context, consumerUUID, storageClaimName string) (*pb.StorageClaimConfigResponse, error)
  • func (cc *OCSProviderClient) GetStorageClientsInfo(ctx context.Context, storageClusterUID string, clientIDs []string) (*pb.StorageClientsInfoResponse, 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, onboard ifaces.StorageClientOnboarding) (*pb.OnboardConsumerResponse, error)
  • func (cc *OCSProviderClient) PeerStorageCluster(ctx context.Context, onboardingToken, storageClusterUID string) (*pb.PeerStorageClusterResponse, error)
  • func (cc *OCSProviderClient) ReportStatus(ctx context.Context, consumerUUID string, status ifaces.StorageClientStatus) (*pb.ReportStatusResponse, error)
  • func (cc *OCSProviderClient) RequestMaintenanceMode(ctx context.Context, consumerUUID string, enable bool) (*pb.RequestMaintenanceModeResponse, error)
  • func (cc *OCSProviderClient) RevokeStorageClaim(ctx context.Context, consumerUUID, storageClaimName string) (*pb.RevokeStorageClaimResponse, error)
• type StorageType

Functions

func NewOnboardConsumerRequest

func NewOnboardConsumerRequest() ifaces.StorageClientOnboarding

func NewStorageClientStatus

func NewStorageClientStatus() ifaces.StorageClientStatus

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) FulfillStorageClaim

func (cc *OCSProviderClient) FulfillStorageClaim(
	ctx context.Context,
	consumerUUID string,
	storageClaimName string,
	storageType StorageType,
	storageProfile string,
	encryptionMethod string,
) (*pb.FulfillStorageClaimResponse, error)

func (*OCSProviderClient) GetBlockPoolsInfo

func (cc *OCSProviderClient) GetBlockPoolsInfo(ctx context.Context, storageClusterUID string, blockPoolNames []string) (*pb.BlockPoolsInfoResponse, error)

func (*OCSProviderClient) GetStorageClaimConfig

func (cc *OCSProviderClient) GetStorageClaimConfig(ctx context.Context, consumerUUID, storageClaimName string) (*pb.StorageClaimConfigResponse, error)

func (*OCSProviderClient) GetStorageClientsInfo

func (cc *OCSProviderClient) GetStorageClientsInfo(ctx context.Context, storageClusterUID string, clientIDs []string) (*pb.StorageClientsInfoResponse, 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, onboard ifaces.StorageClientOnboarding) (*pb.OnboardConsumerResponse, error)

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

func (*OCSProviderClient) PeerStorageCluster

func (cc *OCSProviderClient) PeerStorageCluster(ctx context.Context, onboardingToken, storageClusterUID string) (*pb.PeerStorageClusterResponse, error)

func (*OCSProviderClient) ReportStatus

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

func (*OCSProviderClient) RequestMaintenanceMode

func (cc *OCSProviderClient) RequestMaintenanceMode(ctx context.Context, consumerUUID string, enable bool) (*pb.RequestMaintenanceModeResponse, error)

func (*OCSProviderClient) RevokeStorageClaim

func (cc *OCSProviderClient) RevokeStorageClaim(ctx context.Context, consumerUUID, storageClaimName string) (*pb.RevokeStorageClaimResponse, error)

type StorageType

type StorageType uint

const (
	StorageTypeBlock StorageType = iota
	StorageTypeSharedFile
)