apprclient

Documentation

Overview

Package appregistry is a generated GoMock package.

Package appregistry is a generated GoMock package.

Index

• type Client
• type ClientFactory
  • func NewClientFactory() ClientFactory
• type MockapprApiAdapter
  • func NewMockapprApiAdapter(ctrl *gomock.Controller) *MockapprApiAdapter
  • func (m *MockapprApiAdapter) DownloadOperatorManifest(namespace, repository, digest string) ([]byte, error)
  • func (m *MockapprApiAdapter) EXPECT() *MockapprApiAdapterMockRecorder
  • func (m *MockapprApiAdapter) GetPackageMetadata(namespace, repository, release string) (*models.Package, error)
  • func (m *MockapprApiAdapter) ListPackages(namespace string) (models.Packages, error)
• type MockapprApiAdapterMockRecorder
  • func (mr *MockapprApiAdapterMockRecorder) DownloadOperatorManifest(namespace, repository, digest interface{}) *gomock.Call
  • func (mr *MockapprApiAdapterMockRecorder) GetPackageMetadata(namespace, repository, release interface{}) *gomock.Call
  • func (mr *MockapprApiAdapterMockRecorder) ListPackages(namespace interface{}) *gomock.Call
• type MockblobDecoder
  • func NewMockblobDecoder(ctrl *gomock.Controller) *MockblobDecoder
  • func (m *MockblobDecoder) Decode(encoded []byte) ([]byte, error)
  • func (m *MockblobDecoder) EXPECT() *MockblobDecoderMockRecorder
• type MockblobDecoderMockRecorder
  • func (mr *MockblobDecoderMockRecorder) Decode(encoded interface{}) *gomock.Call
• type OperatorMetadata
• type Options
• type RegistryMetadata
  • func (rm *RegistryMetadata) ID() string
  • func (rm *RegistryMetadata) String() string

Types

type Client

type Client interface {
	// RetrieveAll retrieves all visible packages from the given source
	// When namespace is specified, only package(s) associated with the given namespace are returned.
	// If namespace is empty then visible package(s) across all namespaces are returned.
	RetrieveAll(namespace string) ([]*OperatorMetadata, error)

	// RetrieveOne retrieves a given package from the source
	RetrieveOne(name, release string) (*OperatorMetadata, error)

	// ListPackages returns metadata associated with each package in the
	// specified namespace.
	ListPackages(namespace string) ([]*RegistryMetadata, error)
}

Client exposes the functionality of app registry server

type ClientFactory

type ClientFactory interface {
	// New returns a new instance of appregistry Client from the specified source.
	New(options Options) (Client, error)
}

ClientFactory is an interface that wraps the New method.

func NewClientFactory

func NewClientFactory() ClientFactory

NewClientFactory return a factory which can be used to instantiate a new appregistry client

type MockapprApiAdapter

type MockapprApiAdapter struct {
	// contains filtered or unexported fields
}

MockapprApiAdapter is a mock of apprApiAdapter interface

func NewMockapprApiAdapter

func NewMockapprApiAdapter(ctrl *gomock.Controller) *MockapprApiAdapter

NewMockapprApiAdapter creates a new mock instance

func (*MockapprApiAdapter) DownloadOperatorManifest

func (m *MockapprApiAdapter) DownloadOperatorManifest(namespace, repository, digest string) ([]byte, error)

DownloadOperatorManifest mocks base method

func (*MockapprApiAdapter) EXPECT

func (m *MockapprApiAdapter) EXPECT() *MockapprApiAdapterMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockapprApiAdapter) GetPackageMetadata

func (m *MockapprApiAdapter) GetPackageMetadata(namespace, repository, release string) (*models.Package, error)

GetPackageMetadata mocks base method

func (*MockapprApiAdapter) ListPackages

func (m *MockapprApiAdapter) ListPackages(namespace string) (models.Packages, error)

ListPackages mocks base method

type MockapprApiAdapterMockRecorder

type MockapprApiAdapterMockRecorder struct {
	// contains filtered or unexported fields
}

MockapprApiAdapterMockRecorder is the mock recorder for MockapprApiAdapter

func (*MockapprApiAdapterMockRecorder) DownloadOperatorManifest

func (mr *MockapprApiAdapterMockRecorder) DownloadOperatorManifest(namespace, repository, digest interface{}) *gomock.Call

DownloadOperatorManifest indicates an expected call of DownloadOperatorManifest

func (*MockapprApiAdapterMockRecorder) GetPackageMetadata

func (mr *MockapprApiAdapterMockRecorder) GetPackageMetadata(namespace, repository, release interface{}) *gomock.Call

GetPackageMetadata indicates an expected call of GetPackageMetadata

func (*MockapprApiAdapterMockRecorder) ListPackages

func (mr *MockapprApiAdapterMockRecorder) ListPackages(namespace interface{}) *gomock.Call

ListPackages indicates an expected call of ListPackages

type MockblobDecoder

type MockblobDecoder struct {
	// contains filtered or unexported fields
}

MockblobDecoder is a mock of blobDecoder interface

func NewMockblobDecoder

func NewMockblobDecoder(ctrl *gomock.Controller) *MockblobDecoder

NewMockblobDecoder creates a new mock instance

func (*MockblobDecoder) Decode

func (m *MockblobDecoder) Decode(encoded []byte) ([]byte, error)

Decode mocks base method

func (*MockblobDecoder) EXPECT

func (m *MockblobDecoder) EXPECT() *MockblobDecoderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

type MockblobDecoderMockRecorder

type MockblobDecoderMockRecorder struct {
	// contains filtered or unexported fields
}

MockblobDecoderMockRecorder is the mock recorder for MockblobDecoder

func (*MockblobDecoderMockRecorder) Decode

func (mr *MockblobDecoderMockRecorder) Decode(encoded interface{}) *gomock.Call

Decode indicates an expected call of Decode

type OperatorMetadata

type OperatorMetadata struct {
	// Metadata that uniquely identifies the given operator manifest in registry.
	RegistryMetadata RegistryMetadata

	// Operator manifest(s) in raw YAML format that contains a set of CRD(s),
	// CSV(s) and package(s).
	RawYAML []byte
}

OperatorMetadata encapsulates registry metadata and blob associated with an operator manifest.

When an operator manifest is downloaded from a remote registry, it should be serialized into this type so that it can be further processed by datastore package.

type Options

type Options struct {
	// Source refers to the URL of the remote app registry server.
	Source string

	// AuthToken refers to the authorization token required to access operator
	// manifest in private repositories.
	//
	// If not set, it is assumed that the remote registry is public.
	AuthToken string
}

type RegistryMetadata

type RegistryMetadata struct {
	// Namespace is the namespace in application registry server
	// under which the given operator manifest is hosted.
	Namespace string

	// Repository is the repository that contains the given operator manifest.
	// The repository is located under the given namespace in application
	// registry.
	Name string

	// Release represents the version number of the given operator manifest.
	Release string

	// Digest is the sha256 hash value that uniquely corresponds to the blob
	// associated with this particular release of the operator manifest.
	Digest string
}

RegistryMetadata encapsulates metadata that uniquely describes the source of the given operator manifest in registry.

func (*RegistryMetadata) ID

func (rm *RegistryMetadata) ID() string

ID returns the unique identifier associated with this operator manifest.

func (*RegistryMetadata) String

func (rm *RegistryMetadata) String() string