publish

Documentation

Overview

Package publish defines methods for publishing a v1.Image reference and returning the published digest for embedding back into a Kubernetes yaml.

Index

• Constants
• type Interface
  • func NewCaching(inner Interface) (Interface, error)
  • func NewDaemon(namer Namer, tags []string) Interface
  • func NewDefault(base string, options ...Option) (Interface, error)
• type Namer
• type Option
  • func WithAuth(auth authn.Authenticator) Option
  • func WithAuthFromKeychain(keys authn.Keychain) Option
  • func WithNamer(n Namer) Option
  • func WithTags(tags []string) Option
  • func WithTransport(t http.RoundTripper) Option

Constants

const (
	// LocalDomain is a sentinel "registry" that represents side-loading images into the daemon.
	LocalDomain = "ko.local"
)

Types

type Interface

type Interface interface {
	// Publish uploads the given v1.Image to a registry incorporating the
	// provided string into the image's repository name.  Returns the digest
	// of the published image.
	Publish(v1.Image, string) (name.Reference, error)
}

Interface abstracts different methods for publishing images.

func NewCaching

func NewCaching(inner Interface) (Interface, error)

NewCaching wraps the provided publish.Interface in an implementation that shares publish results for a given path until the passed image object changes.

func NewDaemon

func NewDaemon(namer Namer, tags []string) Interface

NewDaemon returns a new publish.Interface that publishes images to a container daemon.

func NewDefault

func NewDefault(base string, options ...Option) (Interface, error)

NewDefault returns a new publish.Interface that publishes references under the provided base repository using the default keychain to authenticate and the default naming scheme.

type Namer

type Namer func(string) string

Namer is a function from a supported import path to the portion of the resulting image name that follows the "base" repository name.

type Option

type Option func(*defaultOpener) error

Option is a functional option for NewDefault.

func WithAuth

func WithAuth(auth authn.Authenticator) Option

WithAuth is a functional option for overriding the default authenticator on a default publisher.

func WithAuthFromKeychain

func WithAuthFromKeychain(keys authn.Keychain) Option

WithAuthFromKeychain is a functional option for overriding the default authenticator on a default publisher using an authn.Keychain

func WithNamer

func WithNamer(n Namer) Option

WithNamer is a functional option for overriding the image naming behavior in our default publisher.

func WithTags

func WithTags(tags []string) Option

WithTags is a functional option for overriding the image tags

func WithTransport

func WithTransport(t http.RoundTripper) Option

WithTransport is a functional option for overriding the default transport on a default publisher.