git

Documentation

Index

• Constants
• func WithAuth(auth transport.AuthMethod) containers.Option[SnapshotStore]
• func WithCABundle(caCertBytes []byte) containers.Option[SnapshotStore]
• func WithDirectory(directory string) containers.Option[SnapshotStore]
• func WithInsecureTLS(insecureSkipTLS bool) containers.Option[SnapshotStore]
• func WithPollOptions(opts ...containers.Option[storagefs.Poller]) containers.Option[SnapshotStore]
• func WithRef(ref string) containers.Option[SnapshotStore]
• func WithRefResolver(resolver ReferenceResolver) containers.Option[SnapshotStore]
• type ReferenceResolver
  • func SemverResolver() ReferenceResolver
  • func StaticResolver() ReferenceResolver
• type SnapshotStore
  • func NewSnapshotStore(ctx context.Context, logger *zap.Logger, url string, ...) (_ *SnapshotStore, err error)
  • func (*SnapshotStore) String() string
  • func (s *SnapshotStore) View(ctx context.Context, storeRef storage.Reference, ...) error

Constants

const REFERENCE_CACHE_EXTRA_CAPACITY = 3

REFERENCE_CACHE_EXTRA_CAPACITY is the additionally capacity reserved in the cache for non-default references

Functions

func WithAuth

func WithAuth(auth transport.AuthMethod) containers.Option[SnapshotStore]

WithAuth returns an option which configures the auth method used by the provided source.

func WithCABundle

func WithCABundle(caCertBytes []byte) containers.Option[SnapshotStore]

WithCABundle returns an option which configures the CA Bundle used for validating the TLS connection to the provided source.

func WithDirectory

func WithDirectory(directory string) containers.Option[SnapshotStore]

WithDirectory sets a root directory which the store will walk from to discover feature flag state files.

func WithInsecureTLS

func WithInsecureTLS(insecureSkipTLS bool) containers.Option[SnapshotStore]

WithInsecureTLS returns an option which configures the insecure TLS setting for the provided source.

func WithPollOptions

func WithPollOptions(opts ...containers.Option[storagefs.Poller]) containers.Option[SnapshotStore]

WithPollOptions configures the poller used to trigger update procedures

func WithRef

func WithRef(ref string) containers.Option[SnapshotStore]

WithRef configures the target reference to be used when fetching and building fs.FS implementations. If it is a valid hash, then the fixed SHA value is used. Otherwise, it is treated as a reference in the origin upstream.

func WithRefResolver

func WithRefResolver(resolver ReferenceResolver) containers.Option[SnapshotStore]

WithRefResolver configures how the reference will be resolved for the repository.

Types

type ReferenceResolver

type ReferenceResolver func(repo *git.Repository, ref string) (plumbing.Hash, error)

ReferenceResolver is a function type used to describe reference resolver functions.

func SemverResolver

func SemverResolver() ReferenceResolver

SemverResolver is a resolver which resolver semantic versioning references for tags.

func StaticResolver

func StaticResolver() ReferenceResolver

StaticResolver is a resolver which just resolve static references.

type SnapshotStore

type SnapshotStore struct {
	*storagefs.Poller
	// contains filtered or unexported fields
}

SnapshotStore is an implementation of storage.SnapshotStore This implementation is backed by a Git repository and it tracks an upstream reference. When subscribing to this source, the upstream reference is tracked by polling the upstream on a configurable interval.

func NewSnapshotStore

func NewSnapshotStore(ctx context.Context, logger *zap.Logger, url string, opts ...containers.Option[SnapshotStore]) (_ *SnapshotStore, err error)

NewSnapshotStore constructs and configures a Store. The store uses the connection and credential details provided to build fs.FS implementations around a target git repository.

func (*SnapshotStore) String

func (*SnapshotStore) String() string

String returns an identifier string for the store type.

func (*SnapshotStore) View

func (s *SnapshotStore) View(ctx context.Context, storeRef storage.Reference, fn func(storage.ReadOnlyStore) error) error

View accepts a function which takes a *StoreSnapshot. It supplies the provided function with a *Snapshot if one can be resolved for the requested revision reference. Providing an empty reference defaults View to using the stores base reference. The base reference will always be quickly accessible via minimal locking (single read-lock). Alternative references which have not yet been observed will be resolved and newly built into snapshots on demand.