indexer

package

v0.20.3 Latest Latest Go to latest Published: Nov 15, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

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

This section is empty.

View Source

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

Definitions of common error types used by this library.

func IsInvalidArgument(err error) bool

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

func IsNotFound(err error) bool

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

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(opts ...OciIndexerOpt) (Indexer, error)

NewOciIndexer returns a new OCI-based indexer

type OciIndexerOpt func(opts *ociIndexerOpts)

OciIndexerOpt allows setting configuration options

func WithBasicAuth(user, pass string) OciIndexerOpt

WithBasicAuth configures basic authentication for the OCI host

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

func WithHost(h string) OciIndexerOpt

WithHost configures the OCI host

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

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() OciIndexerOpt

WithInsecure configures insecure connection

opt := WithInsecure()

Path	Synopsis
api Package api provides APIs to index charts	Package api provides APIs to index charts