README
¶
Third Party Code from OpenShift CLI (oc)
This directory contains third party code copied from the OpenShift CLI (oc) repository.
Files and Their Sources
manifest.go
Contains copied function calls from:
- Source: https://github.com/openshift/oc/blob/ea5c72052233361761ba371b7c39518d443422be/pkg/cli/image/manifest/manifest.go
- Functions copied:
FirstManifest,ManifestToImageConfig,ProcessManifestList, and related types (FilterFunc,ManifestLocation) - Purpose: Provides image manifest processing functionality for container image operations
dockercredentials/credentials.go
Contains copied credential handling code from the oc repository:
- Purpose: Provides Docker credential store functionality for registry authentication
- Functions:
NewFromFile,NewFromBytes,BasicFromKeyring, and related types
Rationale
At the time of copying, it was easier to copy and paste the function call contents rather than calling the exported functions from oc directly. Calling the functions directly would have invoked many go.mod changes including several conflicting dependencies between HyperShift, oc, and the library-go repositories.
Maintenance
This code is a point-in-time copy and may become outdated as the upstream oc repository evolves. When updating or maintaining this code:
- Consider whether direct imports from oc are feasible with current dependency management
- If copying updates, ensure compatibility with HyperShift's usage patterns
Documentation
¶
Index ¶
- Variables
- func ManifestToImageConfig(ctx context.Context, srcManifest distribution.Manifest, ...) (*dockerv1client.DockerImageConfig, []distribution.Descriptor, error)
- func PlatformSpecString(platform manifestlist.PlatformSpec) string
- func ProcessManifestList(ctx context.Context, srcDigest digest.Digest, ...) ([]distribution.Manifest, distribution.Manifest, digest.Digest, error)
- type FilterFunc
- type FilterOptions
- type ManifestLocation
Constants ¶
This section is empty.
Variables ¶
var ErrAllImagesFiltered = fmt.Errorf("filtered all images from manifest list")
var PreferManifestList = distribution.WithManifestMediaTypes([]string{ manifestlist.MediaTypeManifestList, schema2.MediaTypeManifest, imagespecv1.MediaTypeImageManifest, })
PreferManifestList specifically requests a manifest list first
Functions ¶
func ManifestToImageConfig ¶
func ManifestToImageConfig(ctx context.Context, srcManifest distribution.Manifest, blobs distribution.BlobService, location ManifestLocation) (*dockerv1client.DockerImageConfig, []distribution.Descriptor, error)
ManifestToImageConfig takes an image manifest and converts it into a structured object.
func PlatformSpecString ¶ added in v0.1.64
func PlatformSpecString(platform manifestlist.PlatformSpec) string
func ProcessManifestList ¶
func ProcessManifestList(ctx context.Context, srcDigest digest.Digest, srcManifest distribution.Manifest, manifests distribution.ManifestService, ref imagereference.DockerImageReference, filterFn FilterFunc, keepManifestList bool) ([]distribution.Manifest, distribution.Manifest, digest.Digest, error)
Types ¶
type FilterFunc ¶ added in v0.1.64
type FilterFunc func(*manifestlist.ManifestDescriptor, bool) bool
type FilterOptions ¶ added in v0.1.64
FilterOptions assist in filtering out unneeded manifests from ManifestList objects.
func (*FilterOptions) Include ¶ added in v0.1.64
func (o *FilterOptions) Include(d *manifestlist.ManifestDescriptor, hasMultiple bool) bool
Include returns true if the provided manifest should be included, or the first image if the user didn't alter the default selection and there is only one image.
func (*FilterOptions) IncludeAll ¶ added in v0.1.64
func (o *FilterOptions) IncludeAll(d *manifestlist.ManifestDescriptor, hasMultiple bool) bool
IncludeAll returns true if the provided manifest matches the filter, or all if there was no filter.
func (*FilterOptions) IsWildcardFilter ¶ added in v0.1.64
func (o *FilterOptions) IsWildcardFilter() bool
IsWildcardFilter returns true if the filter regex is set to a wildcard
type ManifestLocation ¶
func FirstManifest ¶
func FirstManifest(ctx context.Context, from imagereference.DockerImageReference, repo distribution.Repository, filterFn FilterFunc) (distribution.Manifest, ManifestLocation, error)
FirstManifest returns the first manifest at the request location that matches the filter function.
func (ManifestLocation) IsList ¶
func (m ManifestLocation) IsList() bool
func (ManifestLocation) String ¶
func (m ManifestLocation) String() string
Source Files
Directories