config

Documentation

Overview

Copyright © 2020 Enrico Stahn <enrico.stahn@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Constants
• func CheckRegistryConfiguration(r Registry) error
• func SetViperDefaults(v *viper.Viper)
• type AWS
  • func (a *AWS) EcrDomain() string
• type Config
• type ECROptions
• type EncryptionConfiguration
• type GCP
  • func (g *GCP) GarDomain() string
• type ImageScanningConfiguration
• type JMESPathFilter
• type Registry
  • func (r Registry) Domain() string
• type Source
• type Tag

Constants

const DefaultImageCopyDeadline = 8 * time.Second

Functions

func CheckRegistryConfiguration

func CheckRegistryConfiguration(r Registry) error

provides detailed information about wrongly provided configuration

func SetViperDefaults

func SetViperDefaults(v *viper.Viper)

SetViperDefaults configures default values for config items that are not set.

Types

type AWS

type AWS struct {
	AccountID  string     `yaml:"accountId"`
	Region     string     `yaml:"region"`
	Role       string     `yaml:"role"`
	ECROptions ECROptions `yaml:"ecrOptions"`
}

func (*AWS) EcrDomain

func (a *AWS) EcrDomain() string

type Config

type Config struct {
	LogLevel  string `yaml:"logLevel" validate:"oneof=trace debug info warn error fatal"`
	LogFormat string `yaml:"logFormat" validate:"oneof=json console"`

	ListenAddress string

	DryRun            bool          `yaml:"dryRun"`
	ImageSwapPolicy   string        `yaml:"imageSwapPolicy" validate:"oneof=always exists"`
	ImageCopyPolicy   string        `yaml:"imageCopyPolicy" validate:"oneof=delayed immediate force none"`
	ImageCopyDeadline time.Duration `yaml:"imageCopyDeadline"`

	Source Source   `yaml:"source"`
	Target Registry `yaml:"target"`

	TLSCertFile string
	TLSKeyFile  string
}

type ECROptions

type ECROptions struct {
	AccessPolicy               string                     `yaml:"accessPolicy"`
	LifecyclePolicy            string                     `yaml:"lifecyclePolicy"`
	Tags                       []Tag                      `yaml:"tags"`
	ImageTagMutability         string                     `yaml:"imageTagMutability"  validate:"oneof=MUTABLE IMMUTABLE"`
	ImageScanningConfiguration ImageScanningConfiguration `yaml:"imageScanningConfiguration"`
	EncryptionConfiguration    EncryptionConfiguration    `yaml:"encryptionConfiguration"`
}

type EncryptionConfiguration

type EncryptionConfiguration struct {
	EncryptionType string `yaml:"encryptionType"`
	KmsKey         string `yaml:"kmsKey"`
}

type GCP

type GCP struct {
	Location     string `yaml:"location"`
	ProjectID    string `yaml:"projectId"`
	RepositoryID string `yaml:"repositoryId"`
}

func (*GCP) GarDomain

func (g *GCP) GarDomain() string

type ImageScanningConfiguration

type ImageScanningConfiguration struct {
	ImageScanOnPush bool `yaml:"imageScanOnPush"`
}

type JMESPathFilter

type JMESPathFilter struct {
	JMESPath string `yaml:"jmespath"`
}

type Registry

type Registry struct {
	Type string `yaml:"type"`
	AWS  AWS    `yaml:"aws"`
	GCP  GCP    `yaml:"gcp"`
}

func (Registry) Domain

func (r Registry) Domain() string

type Source

type Source struct {
	Registries []Registry       `yaml:"registries"`
	Filters    []JMESPathFilter `yaml:"filters"`
}

type Tag

type Tag struct {
	Key   string `yaml:"key"`
	Value string `yaml:"value"`
}