syncer

Documentation

Index

• Constants
• func DefaultWorkdir() string
• type Chart
• type ChartIndex
  • func (i ChartIndex) Add(id string, chart *Chart) error
  • func (i ChartIndex) Get(id string) *Chart
• type Clients
• type FakeSyncerOption
  • func WithFakeSkipCharts(charts []string) FakeSyncerOption
  • func WithFakeSyncerDestination(dir string) FakeSyncerOption
• type FakeSyncerOpts
• type Option
  • func WithAutoDiscovery(enable bool) Option
  • func WithContainerImageRelocation(enable bool) Option
  • func WithDryRun(enable bool) Option
  • func WithFromDate(date string) Option
  • func WithInsecure(enable bool) Option
  • func WithLatestVersionOnly(latestVersionOnly bool) Option
  • func WithSkipCharts(charts []string) Option
  • func WithSkipDependencies(skipDependencies bool) Option
  • func WithWorkdir(dir string) Option
• type Syncer
  • func New(source *api.Source, target *api.Target, opts ...Option) (*Syncer, error)
  • func NewFake(t *testing.T, opts ...FakeSyncerOption) *Syncer
  • func (s *Syncer) SyncPendingCharts(names ...string) error
  • func (s *Syncer) SyncWithChartsSyncer(ch *Chart, id, workdir, outdir string, hasDeps bool) (string, error)
  • func (s *Syncer) SyncWithRelok8s(chart *Chart, outdir string) (string, error)

Constants

const WorkdirName = ".charts-syncer"

WorkdirName is the default name for a workdir

Functions

func DefaultWorkdir

func DefaultWorkdir() string

DefaultWorkdir returns the default workdir path

Types

type Chart

type Chart struct {
	Name         string
	Version      string
	Dependencies []string

	TgzPath string
}

Chart describes a chart, including dependencies

type ChartIndex

type ChartIndex map[string]*Chart

ChartIndex is a map linking a chart reference with its Chart

func (ChartIndex) Add

func (i ChartIndex) Add(id string, chart *Chart) error

Add adds a chart in the index

func (ChartIndex) Get

func (i ChartIndex) Get(id string) *Chart

Get returns an index chart

type Clients

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

Clients holds the source and target chart repo clients

type FakeSyncerOption

type FakeSyncerOption func(*FakeSyncerOpts)

FakeSyncerOption is an option value used to create a new fake syncer instance.

func WithFakeSkipCharts

func WithFakeSkipCharts(charts []string) FakeSyncerOption

func WithFakeSyncerDestination

func WithFakeSyncerDestination(dir string) FakeSyncerOption

WithFakeSyncerDestination configures a destination directory

type FakeSyncerOpts

type FakeSyncerOpts struct {
	Destination string
	// contains filtered or unexported fields
}

FakeSyncerOpts allows to configure a Fake syncer.

type Option

type Option func(*Syncer)

Option is an option value used to create a new syncer instance.

func WithAutoDiscovery

func WithAutoDiscovery(enable bool) Option

WithAutoDiscovery configures the syncer to discover all the charts to sync from the source chart repos.

func WithContainerImageRelocation

func WithContainerImageRelocation(enable bool) Option

WithContainerImageRelocation configures the syncer to use relok8s to make the chart transformations and push the container images to the target registry

func WithDryRun

func WithDryRun(enable bool) Option

WithDryRun configures the syncer to run in dry-run mode.

func WithFromDate

func WithFromDate(date string) Option

WithFromDate configures the syncer to synchronize the charts from a specific time using YYYY-MM-DD format.

func WithInsecure

func WithInsecure(enable bool) Option

WithInsecure configures the syncer to allow insecure SSL connections

func WithLatestVersionOnly

func WithLatestVersionOnly(latestVersionOnly bool) Option

WithLatestVersionOnly configures the syncer to sync only the latest version

func WithSkipCharts

func WithSkipCharts(charts []string) Option

WithSkipCharts configures the syncer to skip an explicit list of chart names from the source chart repos.

func WithSkipDependencies

func WithSkipDependencies(skipDependencies bool) Option

WithSkipDependencies configures the syncer to skip dependencies sync

func WithWorkdir

func WithWorkdir(dir string) Option

WithWorkdir configures the syncer to store artifacts in a specific directory.

type Syncer

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

A Syncer can be used to sync a source and target chart repos.

func New

func New(source *api.Source, target *api.Target, opts ...Option) (*Syncer, error)

New creates a new syncer using Client

func NewFake

func NewFake(t *testing.T, opts ...FakeSyncerOption) *Syncer

NewFake returns a fake Syncer

func (*Syncer) SyncPendingCharts

func (s *Syncer) SyncPendingCharts(names ...string) error

SyncPendingCharts syncs the charts not found in the target

It uses topological sort to sync dependencies first.

func (*Syncer) SyncWithChartsSyncer

func (s *Syncer) SyncWithChartsSyncer(ch *Chart, id, workdir, outdir string, hasDeps bool) (string, error)

func (*Syncer) SyncWithRelok8s

func (s *Syncer) SyncWithRelok8s(chart *Chart, outdir string) (string, error)

SyncWithRelok8s will take a local packaged chart, a container registry and a container repository and will rewrite the chart updating the images in values.yaml. The local chart must include an image hints file so relok8s library knows how to update the images