client

package

v4.0.0-...-bf9029b Latest Latest Go to latest Published: May 2, 2024 License: Apache-2.0 Imports: 8 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/red-hat-storage/ocs-operator

Links

Open Source Insights

Documentation ¶

Index ¶

func NewOnboardConsumerRequest() ifaces.StorageClientOnboarding
func NewStorageClientStatus() ifaces.StorageClientStatus
type OCSProviderClient
- func NewProviderClient(ctx context.Context, serverAddr string, timeout time.Duration) (*OCSProviderClient, error)
type StorageType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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) GetStorageClaimConfig ¶

func (cc *OCSProviderClient) GetStorageClaimConfig(ctx context.Context, consumerUUID, storageClaimName string) (*pb.StorageClaimConfigResponse, 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) ReportStatus ¶

func (cc *OCSProviderClient) ReportStatus(ctx context.Context, consumerUUID string, status ifaces.StorageClientStatus) (*pb.ReportStatusResponse, 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
)

Source Files ¶

View all Source files

client.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL