scope

Documentation

Index

• Constants
• func NewProviderClient(cloud clientconfig.Cloud, caCert []byte, logger logr.Logger) (*gophercloud.ProviderClient, *clientconfig.ClientOpts, error)
• type CredentialsProvider
• type Factory
  • func NewFactory(maxCacheSize int, defaultCACert []byte) Factory
• type MockScopeFactory
  • func NewMockScopeFactory(mockCtrl *gomock.Controller) *MockScopeFactory
  • func (f *MockScopeFactory) ExtractToken() (*tokens.Token, error)
  • func (f *MockScopeFactory) NewClientScopeFromObject(_ context.Context, _ client.Client, _ logr.Logger, ...) (Scope, error)
  • func (f *MockScopeFactory) NewComputeClient() (osclients.ComputeClient, error)
  • func (f *MockScopeFactory) NewImageClient() (osclients.ImageClient, error)
  • func (f *MockScopeFactory) NewLbClient() (osclients.LbClient, error)
  • func (f *MockScopeFactory) NewNetworkClient() (osclients.NetworkClient, error)
  • func (f *MockScopeFactory) NewVolumeClient() (osclients.VolumeClient, error)
  • func (f *MockScopeFactory) SetClientScopeCreateError(err error)
• type Scope
  • func NewCachedProviderScope(cache *cache.LRUExpireCache, cloud clientconfig.Cloud, caCert []byte, ...) (Scope, error)
  • func NewProviderScope(cloud clientconfig.Cloud, caCert []byte, logger logr.Logger) (Scope, error)
• type WithLogger
  • func NewWithLogger(scope Scope, logger logr.Logger) *WithLogger
  • func (s *WithLogger) Logger() logr.Logger

Constants

const (
	CloudsSecretKey = "clouds.yaml"
	CASecretKey     = "cacert"
)

Functions

func NewProviderClient

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

Types

type CredentialsProvider

type CredentialsProvider interface {
	// Return the name of a secret holding cloud credentials
	GetSecretName() *string

	// Return the name of the cloud to use, which is defined in the associated credentials
	GetCloudName() *string
}

type Factory

type Factory interface {
	// NewClientScopeFromObject creates a new scope from the first object which returns an OpenStackIdentityRef
	NewClientScopeFromObject(ctx context.Context, ctrlClient client.Client, logger logr.Logger, objects ...orcv1alpha1.CloudCredentialsRefProvider) (Scope, error)
}

Factory instantiates a new Scope using credentials from an IdentityRefProvider.

func NewFactory

func NewFactory(maxCacheSize int, defaultCACert []byte) Factory

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

type MockScopeFactory

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

func NewMockScopeFactory(mockCtrl *gomock.Controller) *MockScopeFactory

func (*MockScopeFactory) ExtractToken

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

func (*MockScopeFactory) NewClientScopeFromObject

func (f *MockScopeFactory) NewClientScopeFromObject(_ context.Context, _ client.Client, _ logr.Logger, _ ...orcv1alpha1.CloudCredentialsRefProvider) (Scope, error)

func (*MockScopeFactory) NewComputeClient

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

func (*MockScopeFactory) NewImageClient

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

func (*MockScopeFactory) NewLbClient

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

func (*MockScopeFactory) NewNetworkClient

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

func (*MockScopeFactory) NewVolumeClient

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

func (*MockScopeFactory) SetClientScopeCreateError

func (f *MockScopeFactory) SetClientScopeCreateError(err error)

type Scope

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

Scope contains arguments common to most operations.

func NewCachedProviderScope

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

func NewProviderScope

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

type WithLogger

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

WithLogger extends Scope with a logger.

func NewWithLogger

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

func (*WithLogger) Logger

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