v1

Documentation

Index

• type Config
  • func (c Config) Validate() error
• type ImageMirror
• type Match
• type Purge
• type Registry
• type RegistryAuth

Types

type Config

type Config struct {
	// Images is a list of repositories to mirror
	Images []ImageMirror `json:"images,omitempty"`
	// Registries defines registries with authentication
	Registries map[string]Registry `json:"registries,omitempty"`
}

Config defines which images should be mirrored

func (Config) Validate

func (c Config) Validate() error

type ImageMirror

type ImageMirror struct {
	// Source defines from which repo the images should pulled from
	Source string `json:"source,omitempty"`
	// Destination defines the new image repo the Source should be rewritten
	// If prefixed with http:// insecure registry is considered
	Destination string `json:"destination,omitempty"`
	// Match defines which images to mirror
	Match Match `json:"match,omitempty"`
	// Purge defines which images should be purged
	Purge *Purge `json:"purge,omitempty"`
}

ImageMirror defines the mirror configuration for a single Repo

type Match

type Match struct {
	// AllTags copies all images if true
	AllTags bool `json:"all_tags,omitempty"`
	// Tags is a exact list of tags to mirror from
	Tags []string `json:"tags,omitempty"`
	// Semver defines a semantic version of tags to mirror
	Semver *string `json:"semver,omitempty"`
	// Last defines how many of the latest tags should be mirrored
	Last *int64 `json:"last,omitempty"`
}

type Purge

type Purge struct {
	// Tags is a exact list of tags to purge
	Tags []string `json:"tags,omitempty"`
	// Semver defines a semantic version of tags to purge
	Semver *string `json:"semver,omitempty"`
	// NoMatch if set to true, all images which are not matched by the Match specification will be purged.
	// latest will never be purged
	NoMatch bool `json:"no_match,omitempty"`
}

type Registry

type Registry struct {
	Auth RegistryAuth `json:"auth,omitempty"`
}

Registry defines a destination registry which requires authentication

type RegistryAuth

type RegistryAuth struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

RegistryAuth is the authentication for a registry