config

Documentation

Index

• type Artifactory
  • func (s *Artifactory) GetDefaults() *Artifactory
  • func (s *Artifactory) SetDefaults()
• type Cli
• type Config
  • func Load(cli Cli, meta Meta) (*Config, error)
  • func (cfg *Config) String() string
• type Meta
• type Policies
• type Policy
  • func (s *Policy) GetDefaults() *Policy
  • func (s *Policy) SetDefaults()
• type PolicyDocker
  • func (s *PolicyDocker) GetDefaults() *PolicyDocker
  • func (s *PolicyDocker) IsExcluded(tag string) bool
  • func (s *PolicyDocker) SetDefaults()
• type PolicyGeneric
  • func (s *PolicyGeneric) GetDefaults() *PolicyGeneric
  • func (s *PolicyGeneric) SetDefaults()

Types

type Artifactory

type Artifactory struct {
	URL        string         `yaml:"url,omitempty" json:"url,omitempty" validate:"required"`
	ApiKey     string         `yaml:"apiKey,omitempty" json:"apiKey,omitempty" validate:"required"`
	ApiKeyFile string         `yaml:"apiKeyFile,omitempty" json:"apiKeyFile,omitempty" validate:"omitempty,file"`
	Timeout    *time.Duration `yaml:"timeout,omitempty" json:"timeout,omitempty" validate:"required"`
}

Artifactory holds Artifactory details

func (*Artifactory) GetDefaults

func (s *Artifactory) GetDefaults() *Artifactory

GetDefaults gets the default values

func (*Artifactory) SetDefaults

func (s *Artifactory) SetDefaults()

SetDefaults sets the default values

type Cli

type Cli struct {
	Version    kong.VersionFlag
	Cfgfile    string `kong:"name='config',env='CONFIG',help='Configuration file.'"`
	Timezone   string `kong:"name='timezone',default='UTC',help='Timezone.'"`
	LogLevel   string `kong:"name='log-level',default='info',help='Set log level.'"`
	LogJSON    bool   `kong:"name='log-json',default='false',help='Enable JSON logging output.'"`
	LogNoColor bool   `kong:"name='log-no-color',default='false',help='Disable coloring output.'"`
	DryRun     bool   `kong:"name='dry-run',help='If enabled, images will not be removed.'"`
}

Cli holds command line args, flags and cmds

type Config

type Config struct {
	Cli         Cli          `yaml:"-" json:"-" label:"-" file:"-"`
	Meta        Meta         `yaml:"-" json:"-" label:"-" file:"-"`
	Artifactory *Artifactory `yaml:"artifactory,omitempty" json:"artifactory,omitempty" validate:"required"`
	Policies    Policies     `yaml:"policies,omitempty" json:"policies,omitempty" validate:"required,unique=Name,dive"`
}

Config holds configuration details

func Load

func Load(cli Cli, meta Meta) (*Config, error)

Load returns Configuration struct

func (*Config) String

func (cfg *Config) String() string

String returns the string representation of configuration

type Meta

type Meta struct {
	ID        string
	Name      string
	Desc      string
	URL       string
	Logo      string
	Author    string
	Version   string
	UserAgent string
}

Meta holds application details

type Policies

type Policies []Policy

Policies holds slice of policy

type Policy

type Policy struct {
	Name           string         `yaml:"name,omitempty" json:"name,omitempty" validate:"required"`
	Repos          []string       `yaml:"repos,omitempty" json:"repos,omitempty" validate:"required"`
	Schedule       string         `yaml:"schedule,omitempty" json:"schedule,omitempty" validate:"required"`
	Retention      *time.Duration `yaml:"retention,omitempty" json:"retention,omitempty" validate:"required"`
	LastModified   *bool          `yaml:"lastModified,omitempty" json:"lastModified,omitempty" validate:"required"`
	LastDownloaded *bool          `yaml:"lastDownloaded,omitempty" json:"lastDownloaded,omitempty" validate:"required"`
	Generic        *PolicyGeneric `yaml:"generic,omitempty" json:"generic,omitempty"`
	Docker         *PolicyDocker  `yaml:"docker,omitempty" json:"docker,omitempty"`
}

Policy holds policy configuration

func (*Policy) GetDefaults

func (s *Policy) GetDefaults() *Policy

GetDefaults gets the default values

func (*Policy) SetDefaults

func (s *Policy) SetDefaults()

SetDefaults sets the default values

type PolicyDocker

type PolicyDocker struct {
	KeepSemver *bool    `yaml:"keepSemver,omitempty" json:"keepSemver,omitempty"`
	Exclude    []string `yaml:"exclude,omitempty" json:"exclude,omitempty"`
}

PolicyDocker holds docker's policy configuration

func (*PolicyDocker) GetDefaults

func (s *PolicyDocker) GetDefaults() *PolicyDocker

GetDefaults gets the default values

func (*PolicyDocker) IsExcluded

func (s *PolicyDocker) IsExcluded(tag string) bool

IsExcluded checks if a tag is excluded

func (*PolicyDocker) SetDefaults

func (s *PolicyDocker) SetDefaults()

SetDefaults sets the default values

type PolicyGeneric

type PolicyGeneric struct {
	Include []string `yaml:"include,omitempty" json:"include,omitempty"`
	Exclude []string `yaml:"exclude,omitempty" json:"exclude,omitempty"`
}

PolicyGeneric holds generic's policy configuration

func (*PolicyGeneric) GetDefaults

func (s *PolicyGeneric) GetDefaults() *PolicyGeneric

GetDefaults gets the default values

func (*PolicyGeneric) SetDefaults

func (s *PolicyGeneric) SetDefaults()

SetDefaults sets the default values