hangar

Documentation

Index

• Variables
• func NewError(id int, e error, s *source.Source, d *destination.Destination) error
• type CommonOpts
• type Error
  • func (e *Error) Error() string
• type Hangar
• type Loader
  • func NewLoader(o *LoaderOpts) (*Loader, error)
  • func (l *Loader) Run(ctx context.Context) error
  • func (c Loader) SaveFailedImages() error
  • func (l *Loader) Validate(ctx context.Context) error
• type LoaderOpts
• type Mirrorer
  • func NewMirrorer(o *MirrorerOpts) (*Mirrorer, error)
  • func (m *Mirrorer) Run(ctx context.Context) error
  • func (c Mirrorer) SaveFailedImages() error
  • func (m *Mirrorer) Validate(ctx context.Context) error
• type MirrorerOpts
• type Saver
  • func NewSaver(o *SaverOpts) (*Saver, error)
  • func (s *Saver) Run(ctx context.Context) error
  • func (c Saver) SaveFailedImages() error
  • func (s *Saver) Validate(ctx context.Context) error
• type SaverOpts
• type Scanner
  • func NewScanner(o *ScannerOpts) (*Scanner, error)
  • func (s *Scanner) Run(ctx context.Context) error
  • func (c Scanner) SaveFailedImages() error
  • func (s *Scanner) Validate(_ context.Context) error
• type ScannerOpts
• type Signer
  • func NewSigner(o *SignerOpts) (*Signer, error)
  • func (s *Signer) Run(ctx context.Context) error
  • func (c Signer) SaveFailedImages() error
  • func (s *Signer) Validate(ctx context.Context) error
• type SignerOpts
• type Syncer
  • func NewSyncer(o *SyncerOpts) (*Syncer, error)
  • func (s *Syncer) Run(ctx context.Context) error
  • func (c Syncer) SaveFailedImages() error
  • func (s *Syncer) Validate(ctx context.Context) error
• type SyncerOpts

Variables

var (
	ErrValidateFailed = errors.New("some images failed to validate")
	ErrCopyFailed     = errors.New("some images failed to copy")
	ErrSignFailed     = errors.New("some images failed to sign")
	ErrScanFailed     = errors.New("some images failed to scan")
)

Functions

func NewError

func NewError(id int, e error, s *source.Source, d *destination.Destination) error

Types

type CommonOpts

type CommonOpts struct {
	Images              []string
	Arch                []string
	OS                  []string
	Variant             []string
	Timeout             time.Duration
	Workers             int
	FailedImageListName string
	SystemContext       *typesv5.SystemContext
	Policy              *signaturev5.Policy
	RemoveSignatures    bool
	SigstorePrivateKey  string
	SigstorePassphrase  []byte
	SigstorePublicKey   string
	CopyProvenance      bool
}

type Error

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

func (*Error) Error

func (e *Error) Error() string

type Hangar

type Hangar interface {
	Run(ctx context.Context) error
	Validate(ctx context.Context) error
	SaveFailedImages() error
}

type Loader

type Loader struct {

	// Specify the source image registry.
	SourceRegistry string
	// Specify the source image project.
	SourceProject string
	// Specify the destination image registry.
	DestinationRegistry string
	// Specify the destination image project.
	DestinationProject string
	// Directory is the source archive directory
	Directory string
	// SharedBlobDirPath is the directory to save the shared blobs
	SharedBlobDirPath string
	// ArchiveName is the archive file name to be load
	ArchiveName string
	// contains filtered or unexported fields
}

Loader loads images from hangar archive file to registry server.

func NewLoader

func NewLoader(o *LoaderOpts) (*Loader, error)

func (*Loader) Run

func (l *Loader) Run(ctx context.Context) error

Run loads images from hangar archive to destination image registry

func (Loader) SaveFailedImages

func (c Loader) SaveFailedImages() error

func (*Loader) Validate

func (l *Loader) Validate(ctx context.Context) error

type LoaderOpts

type LoaderOpts struct {
	CommonOpts

	// Specify the source image registry.
	SourceRegistry string
	// Specify the source image project.
	SourceProject string
	// Specify the destination image registry.
	DestinationRegistry string
	// Specify the destination image project.
	DestinationProject string
	// Directory is the source archive directory
	Directory string
	// SharedBlobDirPath is the directory to save the shared blobs
	SharedBlobDirPath string
	// ArchiveName is the archive file name to be load
	ArchiveName string
}

type Mirrorer

type Mirrorer struct {

	// Override the registry of source image to be copied
	SourceRegistry string
	// Override the registry of the copied destination image
	DestinationRegistry string
	// Override the project of source image to be copied
	SourceProject string
	// Override the project of the copied destination image
	DestinationProject string
	// contains filtered or unexported fields
}

Mirrorer mirrors multipule images between image registries.

func NewMirrorer

func NewMirrorer(o *MirrorerOpts) (*Mirrorer, error)

func (*Mirrorer) Run

func (m *Mirrorer) Run(ctx context.Context) error

Run mirror images from source to destination registry.

func (Mirrorer) SaveFailedImages

func (c Mirrorer) SaveFailedImages() error

func (*Mirrorer) Validate

func (m *Mirrorer) Validate(ctx context.Context) error

type MirrorerOpts

type MirrorerOpts struct {
	CommonOpts

	SourceRegistry      string
	DestinationRegistry string
	SourceProject       string
	DestinationProject  string
}

type Saver

type Saver struct {

	// Override the registry of source image to be copied
	SourceRegistry string
	// Override the project of source image to be copied
	SourceProject string
	// SharedBlobDirPath is the directory to save the shared blobs
	SharedBlobDirPath string
	// ArchiveName is the saved archive file name
	ArchiveName string
	// contains filtered or unexported fields
}

func NewSaver

func NewSaver(o *SaverOpts) (*Saver, error)

func (*Saver) Run

func (s *Saver) Run(ctx context.Context) error

Run save images from registry server into local directory / hangar archive.

func (Saver) SaveFailedImages

func (c Saver) SaveFailedImages() error

func (*Saver) Validate

func (s *Saver) Validate(ctx context.Context) error

type SaverOpts

type SaverOpts struct {
	CommonOpts

	// Override the registry of source image to be copied
	SourceRegistry string
	// Override the project of source image to be copied
	SourceProject string
	// SharedBlobDirPath is the directory to save the shared blobs
	SharedBlobDirPath string
	// ArchiveName is the saved archive file name
	ArchiveName string
}

type Scanner

type Scanner struct {

	// Override the registry
	Registry string
	// Override the project
	Project string
	// contains filtered or unexported fields
}

func NewScanner

func NewScanner(o *ScannerOpts) (*Scanner, error)

func (*Scanner) Run

func (s *Scanner) Run(ctx context.Context) error

func (Scanner) SaveFailedImages

func (c Scanner) SaveFailedImages() error

func (*Scanner) Validate

func (s *Scanner) Validate(_ context.Context) error

type ScannerOpts

type ScannerOpts struct {
	CommonOpts

	Report   *scan.Report
	Registry string
	Project  string
}

type Signer

type Signer struct {

	// Override the registry of all images to be signed
	Registry string
	// Override the project of all images to be signed
	Project string
	// contains filtered or unexported fields
}

func NewSigner

func NewSigner(o *SignerOpts) (*Signer, error)

func (*Signer) Run

func (s *Signer) Run(ctx context.Context) error

Run sign all images in the registry server.

func (Signer) SaveFailedImages

func (c Signer) SaveFailedImages() error

func (*Signer) Validate

func (s *Signer) Validate(ctx context.Context) error

type SignerOpts

type SignerOpts struct {
	CommonOpts

	ExactRepository string
	Registry        string
	Project         string
}

type Syncer

type Syncer struct {

	// Override the registry of source image to be copied
	SourceRegistry string
	// Override the project of source image to be copied
	SourceProject string
	// SharedBlobDirPath is the directory to save the shared blobs
	SharedBlobDirPath string
	// ArchiveName is the saved archive file name
	ArchiveName string
	// contains filtered or unexported fields
}

func NewSyncer

func NewSyncer(o *SyncerOpts) (*Syncer, error)

func (*Syncer) Run

func (s *Syncer) Run(ctx context.Context) error

Run append images from registry server into local directory / hangar archive.

func (Syncer) SaveFailedImages

func (c Syncer) SaveFailedImages() error

func (*Syncer) Validate

func (s *Syncer) Validate(ctx context.Context) error

type SyncerOpts

type SyncerOpts struct {
	CommonOpts

	// Override the registry of source image to be copied
	SourceRegistry string
	// Override the project of source image to be copied
	SourceProject string
	// SharedBlobDirPath is the directory to save the shared blobs
	SharedBlobDirPath string
	// ArchiveName is the saved archive file name
	ArchiveName string
}