core

type ByDoguVersion []*Dogu

type ByVersion []Version

type ConfigurationField struct {
	// Name contains the name of the key. It must not be empty. It must not contain leading or trailing slashes "/", but
	// it may contain directory keys delimited with slashes within the name.
	Name string
	// Description should mention the context and purpose of the config field in human readable format.
	Description string
	// Optional allows to have this config field unset.
	Optional bool
	// Encrypted marks this config field to contain a sensitive value that will be encrypted with the dogu's private key.
	Encrypted bool
	// Global marks this config field to contain a value that is available for all dogus.
	Global bool
	// Default defines a default value that may be evaluated if no value was configured, or the vallue is empty or even invalid.
	Default string
	// Validation configures a Validator that will be used to validate this config field.
	Validation ValidationDescriptor
}

type Credentials struct {
	Username string
	Password string
}

type Dependency struct {
	Type    string `json:"type"`
	Name    string `json:"name"`
	Version string `json:"version"`
}

type Dogu struct {
	Name                 string
	Version              string
	DisplayName          string
	Description          string
	Category             string
	Tags                 []string
	Logo                 string
	URL                  string
	Image                string
	ExposedPorts         []ExposedPort
	ExposedCommands      []ExposedCommand
	Volumes              []Volume
	HealthCheck          HealthCheck // deprecated use HealthChecks
	HealthChecks         []HealthCheck
	ServiceAccounts      []ServiceAccount
	Privileged           bool
	Configuration        []ConfigurationField
	Properties           Properties
	EnvironmentVariables []EnvironmentVariable
	Dependencies         []Dependency
	OptionalDependencies []Dependency
}

type DoguApiVersion int

type DoguFormatHandler struct {
	Providers []DoguFormatProvider
}

type DoguFormatProvider interface {
	// ReadDoguFromString reads a dogu from the given filePath and returns an instance of a dogu.
	ReadDoguFromString(content string) (*Dogu, error)
	// ReadDogusFromString reads multiple dogus from the given filePath and returns a slice of dogu instances.
	ReadDogusFromString(content string) ([]*Dogu, error)
	// WriteDoguToString converts the given dogu to string representation and returns it.
	WriteDoguToString(dogu *Dogu) (string, error)
	// WriteDogusToString converts the given dogus to string representation and returns it.
	WriteDogusToString(dogu []*Dogu) (string, error)
	// GetVersion returns the api version which is used for this format provider.
	GetVersion() DoguApiVersion
}

type DoguJsonV1FormatProvider struct{}

type DoguJsonV2FormatProvider struct{}

type EnvironmentVariable struct {
	Key   string
	Value string
}

type ExposedCommand struct {
	Name        string
	Description string
	Command     string
}

type ExposedPort struct {
	// Type contains the protocol type over which the container communicates (f. i. 'tcp').
	Type string
	// Container contains the mapped port on side of the container.
	Container int
	// Host contains the mapped port on side of the host.
	Host int
}

type HealthCheck struct {
	Type       string            // health check type tcp or state
	State      string            // expected state for state health check, default is ready
	Port       int               // port for tcp state check
	Path       string            // path for http check
	Parameters map[string]string // key value pairs for check specific parameters
}

type Logger interface {
	// Debug logs messages that generally should not be visible within a production environment but useful when trying
	// to pinpoint error situations during the development.
	Debug(args ...interface{})
	// Info logs messages that may be of general interest but do not state any danger.
	Info(args ...interface{})
	// Warning logs error messages that may require the attention of the user.
	Warning(args ...interface{})
	// Error logs error messages that may jeopardize the success during the run-time.
	Error(args ...interface{})

	// Debugf logs messages that generally should not be visible within a production environment but useful when trying
	// to pinpoint error situations during the development.
	Debugf(format string, args ...interface{})
	// Infof logs messages that may be of general interest but do not state any danger.
	Infof(format string, args ...interface{})
	// Warningf logs error messages that may require the attention of the user.
	Warningf(format string, args ...interface{})
	// Errorf logs error messages that may jeopardize the success during the run-time.
	Errorf(format string, args ...interface{})
}

type Properties map[string]string

type ProxySettings struct {
	Enabled  bool
	Server   string `json:",omitempty"`
	Port     int    `json:",omitempty"`
	Username string `json:",omitempty"`
	Password string `json:",omitempty"`
}

type Registry struct {
	Type        string      `validate:"eq=etcd"`
	Endpoints   []string    `validate:"required,min=1"`
	RetryPolicy RetryPolicy `json:"retryPolicy,omitempty"`
}

type Remote struct {
	Endpoint               string `validate:"url"`
	AuthenticationEndpoint string `validate:"omitempty,url"`
	URLSchema              string `json:"urlSchema,omitempty" validate:"omitempty,oneof=default index"`
	CacheDir               string `validate:"required"`
	ProxySettings          ProxySettings
	AnonymousAccess        bool        `json:",omitempty"`
	Insecure               bool        `json:",omitempty"`
	RetryPolicy            RetryPolicy `json:"retryPolicy,omitempty"`
}

type RetryPolicy struct {
	Type          string `json:"type,omitempty"`
	Interval      int64  `json:"interval" validate:"gte=0"`
	MaxRetryCount int    `json:"maxRetryCount" validate:"gte=0"`
}

type ServiceAccount struct {
	Type   string
	Params []string
}

type ValidationDescriptor struct {
	// Type contains the name of the config value validator.
	Type string
	// Values may contain values that aid the selected validator. It is up to the selected validator whether this field is mandatory, optional, or unused.
	Values []string
}

type Version struct {
	Raw   string
	Major int
	Minor int
	Patch int
	Nano  int
	Extra int
}

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

type Volume struct {
	Name        string
	Path        string
	Owner       string
	Group       string
	NeedsBackup bool
}