client

Documentation

Index

• func ParseArtifactURL(ociURL string) (string, error)
• func ParseRepositoryURL(ociURL string) (string, error)
• type Client
  • func NewClient(opts []crane.Option) *Client
  • func NewLocalClient() *Client
  • func (c *Client) Build(artifactPath, sourceDir string, ignorePaths []string) (err error)
  • func (c *Client) Delete(ctx context.Context, url string) error
  • func (c *Client) Diff(ctx context.Context, url, dir string, ignorePaths []string) error
  • func (c *Client) List(ctx context.Context, url string, opts ListOptions) ([]Metadata, error)
  • func (c *Client) LoginWithCredentials(credentials string) error
  • func (c *Client) LoginWithProvider(ctx context.Context, url string, provider oci.Provider) error
  • func (c *Client) Pull(ctx context.Context, url, outDir string) (*Metadata, error)
  • func (c *Client) Push(ctx context.Context, url, sourceDir string, meta Metadata, ...) (string, error)
  • func (c *Client) Tag(ctx context.Context, url, tag string) (string, error)
• type ListOptions
• type Metadata
  • func MetadataFromAnnotations(annotations map[string]string) (*Metadata, error)
  • func (m *Metadata) ToAnnotations() map[string]string

Functions

func ParseArtifactURL

func ParseArtifactURL(ociURL string) (string, error)

ParseArtifactURL validates the OCI URL and returns the address of the artifact.

func ParseRepositoryURL

func ParseRepositoryURL(ociURL string) (string, error)

ParseRepositoryURL validates the OCI URL and returns the address of the artifact repository.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client holds the options for accessing remote OCI registries.

func NewClient

func NewClient(opts []crane.Option) *Client

NewClient returns an OCI client configured with the given crane options.

func NewLocalClient

func NewLocalClient() *Client

NewLocalClient returns an OCI client configured with the Docker keychain helpers.

func (*Client) Build

func (c *Client) Build(artifactPath, sourceDir string, ignorePaths []string) (err error)

Build archives the given directory as a tarball to the given local path. While archiving, any environment specific data (for example, the user and group name) is stripped from file headers.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, url string) error

Delete deletes a particular image from an OCI repository If the url has no tag, the latest image is deleted

func (*Client) Diff

func (c *Client) Diff(ctx context.Context, url, dir string, ignorePaths []string) error

Diff compares the files included in an OCI image with the local files in the given path and returns an error if the contents is different

func (*Client) List

func (c *Client) List(ctx context.Context, url string, opts ListOptions) ([]Metadata, error)

List fetches the tags and their manifests for a given OCI repository.

func (*Client) LoginWithCredentials

func (c *Client) LoginWithCredentials(credentials string) error

LoginWithCredentials configures the client with static credentials, accepts a single token or a user:password format.

func (*Client) LoginWithProvider

func (c *Client) LoginWithProvider(ctx context.Context, url string, provider oci.Provider) error

LoginWithProvider configures the client to log in to the specified provider

func (*Client) Pull

func (c *Client) Pull(ctx context.Context, url, outDir string) (*Metadata, error)

Pull downloads an artifact from an OCI repository and extracts the content to the given directory.

func (*Client) Push

func (c *Client) Push(ctx context.Context, url, sourceDir string, meta Metadata, ignorePaths []string) (string, error)

Push creates an artifact from the given directory, uploads the artifact to the given OCI repository and returns the digest.

func (*Client) Tag

func (c *Client) Tag(ctx context.Context, url, tag string) (string, error)

Tag creates a new tag for the given artifact using the same OCI repository as the origin.

type ListOptions

type ListOptions struct {
	// SemverFilter contains semver for filtering tags.
	SemverFilter string
	// RegexFilter contains a regex that tags will be filtered by.
	RegexFilter string
}

ListOptions contains options for listing tags from an OCI repository.

type Metadata

type Metadata struct {
	Created  string `json:"created"`
	Source   string `json:"source_url"`
	Revision string `json:"source_revision"`
	Digest   string `json:"digest"`
	URL      string `json:"url"`
}

Metadata holds the upstream information about on artifact's source. https://github.com/opencontainers/image-spec/blob/main/annotations.md

func MetadataFromAnnotations

func MetadataFromAnnotations(annotations map[string]string) (*Metadata, error)

MetadataFromAnnotations parses the OpenContainers annotations and returns a Metadata object.

func (*Metadata) ToAnnotations

func (m *Metadata) ToAnnotations() map[string]string

ToAnnotations returns the OpenContainers annotations map.