indexer

Documentation

Index

• Variables
• func IsInvalidArgument(err error) bool
• func IsNotFound(err error) bool
• type Indexer
  • func NewOciIndexer(opts ...OciIndexerOpt) (Indexer, error)
• type OciIndexerOpt
  • func WithBasicAuth(user, pass string) OciIndexerOpt
  • func WithHost(h string) OciIndexerOpt
  • func WithIndexRef(r string) OciIndexerOpt
  • func WithInsecure() OciIndexerOpt

Variables

var (
	ErrInvalidArgument = errors.New("invalid argument")
	ErrNotFound        = errors.New("not found")
)

Definitions of common error types used by this library.

Functions

func IsInvalidArgument

func IsInvalidArgument(err error) bool

IsInvalidArgument returns true if the error is due to an invalid argument

func IsNotFound

func IsNotFound(err error) bool

IsNotFound returns true if the error is due to a missing object

Types

type Indexer

type Indexer interface {
	// Get retrieves the index
	Get(ctx context.Context) (*api.Index, error)
}

Indexer is the interface that an indexer should implement

func NewOciIndexer

func NewOciIndexer(opts ...OciIndexerOpt) (Indexer, error)

NewOciIndexer returns a new OCI-based indexer

type OciIndexerOpt

type OciIndexerOpt func(opts *ociIndexerOpts)

OciIndexerOpt allows setting configuration options

func WithBasicAuth

func WithBasicAuth(user, pass string) OciIndexerOpt

WithBasicAuth configures basic authentication for the OCI host

opt := WithBasicAuth("user", "pass")

func WithHost

func WithHost(h string) OciIndexerOpt

WithHost configures the OCI host

opt := WithHost("my.oci.domain")

func WithIndexRef

func WithIndexRef(r string) OciIndexerOpt

WithIndexRef configures the charts index OCI reference instead of letting the library using the default host/index:latest one.

opt := WithIndexRef("my.oci.domain/index:prod")

func WithInsecure

func WithInsecure() OciIndexerOpt

WithInsecure configures insecure connection

opt := WithInsecure()