scope

package
v0.10.1 Latest Latest
Warning

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

Go to latest
Published: Apr 30, 2024 License: Apache-2.0 Imports: 25 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewProviderClient added in v0.8.0

func NewProviderClient(cloud clientconfig.Cloud, caCert []byte, logger logr.Logger) (*gophercloud.ProviderClient, *clientconfig.ClientOpts, string, error)

Types

type Factory added in v0.8.0

type Factory interface {
	NewClientScopeFromMachine(ctx context.Context, ctrlClient client.Client, openStackMachine *infrav1.OpenStackMachine, openStackCluster *infrav1.OpenStackCluster, defaultCACert []byte, logger logr.Logger) (Scope, error)
	NewClientScopeFromCluster(ctx context.Context, ctrlClient client.Client, openStackCluster *infrav1.OpenStackCluster, defaultCACert []byte, logger logr.Logger) (Scope, error)
	NewClientScopeFromFloatingIPPool(ctx context.Context, ctrlClient client.Client, openStackCluster *v1alpha1.OpenStackFloatingIPPool, defaultCACert []byte, logger logr.Logger) (Scope, error)
}

Factory instantiates a new Scope using credentials from either a cluster or a machine.

func NewFactory added in v0.9.0

func NewFactory(maxCacheSize int) Factory

NewFactory creates the default scope factory. It generates service clients which make OpenStack API calls against a running cloud.

type MockScopeFactory added in v0.8.0

type MockScopeFactory struct {
	ComputeClient *mock.MockComputeClient
	NetworkClient *mock.MockNetworkClient
	VolumeClient  *mock.MockVolumeClient
	ImageClient   *mock.MockImageClient
	LbClient      *mock.MockLbClient
	// contains filtered or unexported fields
}

MockScopeFactory implements both the ScopeFactory and ClientScope interfaces. It can be used in place of the default ProviderScopeFactory when we want to use mocked service clients which do not attempt to connect to a running OpenStack cloud.

func NewMockScopeFactory added in v0.8.0

func NewMockScopeFactory(mockCtrl *gomock.Controller, projectID string) *MockScopeFactory

func (*MockScopeFactory) ExtractToken added in v0.9.0

func (f *MockScopeFactory) ExtractToken() (*tokens.Token, error)

func (*MockScopeFactory) NewClientScopeFromCluster added in v0.8.0

func (f *MockScopeFactory) NewClientScopeFromCluster(_ context.Context, _ client.Client, _ *infrav1.OpenStackCluster, _ []byte, _ logr.Logger) (Scope, error)

func (*MockScopeFactory) NewClientScopeFromFloatingIPPool added in v0.10.0

func (f *MockScopeFactory) NewClientScopeFromFloatingIPPool(_ context.Context, _ client.Client, _ *v1alpha1.OpenStackFloatingIPPool, _ []byte, _ logr.Logger) (Scope, error)

func (*MockScopeFactory) NewClientScopeFromMachine added in v0.8.0

func (f *MockScopeFactory) NewClientScopeFromMachine(_ context.Context, _ client.Client, _ *infrav1.OpenStackMachine, _ *infrav1.OpenStackCluster, _ []byte, _ logr.Logger) (Scope, error)

func (*MockScopeFactory) NewComputeClient added in v0.8.0

func (f *MockScopeFactory) NewComputeClient() (clients.ComputeClient, error)

func (*MockScopeFactory) NewImageClient added in v0.8.0

func (f *MockScopeFactory) NewImageClient() (clients.ImageClient, error)

func (*MockScopeFactory) NewLbClient added in v0.8.0

func (f *MockScopeFactory) NewLbClient() (clients.LbClient, error)

func (*MockScopeFactory) NewNetworkClient added in v0.8.0

func (f *MockScopeFactory) NewNetworkClient() (clients.NetworkClient, error)

func (*MockScopeFactory) NewVolumeClient added in v0.8.0

func (f *MockScopeFactory) NewVolumeClient() (clients.VolumeClient, error)

func (*MockScopeFactory) ProjectID added in v0.8.0

func (f *MockScopeFactory) ProjectID() string

func (*MockScopeFactory) SetClientScopeCreateError added in v0.8.0

func (f *MockScopeFactory) SetClientScopeCreateError(err error)

type Scope

type Scope interface {
	NewComputeClient() (clients.ComputeClient, error)
	NewVolumeClient() (clients.VolumeClient, error)
	NewImageClient() (clients.ImageClient, error)
	NewNetworkClient() (clients.NetworkClient, error)
	NewLbClient() (clients.LbClient, error)
	ProjectID() string
	ExtractToken() (*tokens.Token, error)
}

Scope contains arguments common to most operations.

func NewCachedProviderScope added in v0.9.0

func NewCachedProviderScope(cache *cache.LRUExpireCache, cloud clientconfig.Cloud, caCert []byte, logger logr.Logger) (Scope, error)

func NewProviderScope added in v0.8.0

func NewProviderScope(cloud clientconfig.Cloud, caCert []byte, logger logr.Logger) (Scope, error)

type WithLogger added in v0.10.0

type WithLogger struct {
	Scope
	// contains filtered or unexported fields
}

WithLogger extends Scope with a logger.

func NewWithLogger added in v0.10.0

func NewWithLogger(scope Scope, logger logr.Logger) *WithLogger

func (*WithLogger) Logger added in v0.10.0

func (s *WithLogger) Logger() logr.Logger

Jump to

Keyboard shortcuts

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