Documentation
¶
Overview ¶
Package oci wraps oras-go for agentfile use: authenticated remote repositories, manifest/index resolution, blob fetching, and a Puller abstraction that extracts a bin layer from an image.
Index ¶
- Constants
- func AgentFetcher(opts ...RemoteRepositoryOption) func(ctx context.Context, ref spec.Reference) (*spec.Agentfile, error)
- func FetchBlobBytes(ctx context.Context, fetcher content.Fetcher, desc v1.Descriptor) ([]byte, error)
- func LoadAgentFromSource(ctx context.Context, src oras.ReadOnlyTarget, ref spec.Reference) (*spec.Agentfile, error)
- func NewRemoteRepository(ref spec.Reference, opts ...RemoteRepositoryOption) (*remote.Repository, error)
- func ParseTag(ref spec.Reference) string
- func ResolveManifest(ctx context.Context, fetcher content.Fetcher, desc v1.Descriptor) (*v1.Manifest, error)
- func WithPlainHTTP(repo *remote.Repository)
- type Puller
- type RemoteRepositoryOption
- type UsageFetcher
Constants ¶
const DefaultRetryMaxElapsedTime = 30 * time.Second
DefaultRetryMaxElapsedTime caps the total wall-clock time the retry transport will spend on a single HTTP request, including all backoff sleeps. 30 s comfortably covers the GHCR "first-push" 500 race (typically 1–5 s) without making bad-credential errors feel sluggish — the auth path 401s fast and 4xx isn't retried.
Variables ¶
This section is empty.
Functions ¶
func AgentFetcher ¶
func AgentFetcher( opts ...RemoteRepositoryOption, ) func(ctx context.Context, ref spec.Reference) (*spec.Agentfile, error)
AgentFetcher returns a resolve.Fetcher that pulls agent artifacts from a remote OCI registry.
func FetchBlobBytes ¶
func FetchBlobBytes(ctx context.Context, fetcher content.Fetcher, desc v1.Descriptor) ([]byte, error)
FetchBlobBytes reads the blob identified by desc from fetcher into memory. Accepts any content.Fetcher so it can be exercised against in-memory stores in tests as well as remote repositories.
func LoadAgentFromSource ¶
func LoadAgentFromSource( ctx context.Context, src oras.ReadOnlyTarget, ref spec.Reference, ) (*spec.Agentfile, error)
LoadAgentFromSource copies the manifest at ref out of src into a fresh in-memory oras store and returns the hydrated Agentfile.
Exposed (vs. inlined into AgentFetcher) so callers can test the fetch logic against an in-memory source — no httptest registry, no daemon — and so non-remote sources (e.g. an embedded local registry) can reuse the same load path.
func NewRemoteRepository ¶
func NewRemoteRepository(ref spec.Reference, opts ...RemoteRepositoryOption) (*remote.Repository, error)
NewRemoteRepository constructs an oras remote.Repository bound to ref, wired up with Docker credential resolution and a retrying transport that tolerates transient 5xx + transport errors. The retry is what lets the first-ever push of a brand-new GHCR package succeed: GHCR provisions backend storage on the first manifest PUT and the request can race the provisioning step.
func ResolveManifest ¶
func ResolveManifest(ctx context.Context, fetcher content.Fetcher, desc v1.Descriptor) (*v1.Manifest, error)
ResolveManifest fetches the blob at desc and parses it as a v1.Manifest. If the blob is a v1.Index, a platform-appropriate child manifest is selected and resolved recursively.
func WithPlainHTTP ¶
func WithPlainHTTP(repo *remote.Repository)
WithPlainHTTP configures the repository to use HTTP instead of HTTPS. Suitable for local/dev registries only.
Types ¶
type Puller ¶
func NoopPuller ¶
func NoopPuller() Puller
func RemotePuller ¶
func RemotePuller(opts ...RemoteRepositoryOption) Puller
type RemoteRepositoryOption ¶
type RemoteRepositoryOption func(*remote.Repository)
RemoteRepositoryOption mutates a remote repository at construction time.
type UsageFetcher ¶
UsageFetcher fetches the USAGE.md body declared by a BIN image at ref. Returns the empty string with a nil error when the image carries no `vnd.openotters.bin.usage` annotation (or the annotation references a layer that isn't present). Errors are reserved for network / authentication / parse failures, so callers can treat an absent doc as a no-op without distinguishing it from a real failure path.
Parallel in shape to Puller: a function value the consumer wires into the executor pipeline, with `NoopUsageFetcher` for tests and `RemoteUsageFetcher` for production.
func NoopUsageFetcher ¶
func NoopUsageFetcher() UsageFetcher
NoopUsageFetcher returns a fetcher that always reports "no usage doc" — useful in tests that exercise the materialisation pipeline without standing up a registry.
func RemoteUsageFetcher ¶
func RemoteUsageFetcher(opts ...RemoteRepositoryOption) UsageFetcher
RemoteUsageFetcher mirrors RemotePuller for the documentation layer: resolves ref against a real registry, parses the manifest, and returns the body of the layer pointed at by the `vnd.openotters.bin.usage` annotation. The annotation defaults to `/USAGE.md` (see spec.DefaultUsagePath) but producers may pick a different path; this fetcher honours whatever the producer wrote.
Source Files