config

Documentation

Index

• type CertPool
  • func (cp *CertPool) MarshalJSON() ([]byte, error)
  • func (cp *CertPool) MarshalYAML() (interface{}, error)
  • func (cp *CertPool) UnmarshalJSON(b []byte) error
  • func (cp *CertPool) UnmarshalYAML(unmarshal func(interface{}) error) error
• type DFGetConfig
• type HijackConfig
• type HijackHost
• type Properties
  • func (p *Properties) DFGetConfig() DFGetConfig
  • func (p *Properties) Validate() error
• type Proxy
  • func NewProxy(regx string, useHTTPS bool, direct bool) (*Proxy, error)
  • func (r *Proxy) Match(url string) bool
• type Regexp
  • func NewRegexp(exp string) (*Regexp, error)
  • func (r *Regexp) MarshalJSON() ([]byte, error)
  • func (r *Regexp) MarshalYAML() (interface{}, error)
  • func (r *Regexp) UnmarshalJSON(b []byte) error
  • func (r *Regexp) UnmarshalYAML(unmarshal func(interface{}) error) error
• type RegistryMirror
  • func (r *RegistryMirror) TLSConfig() *tls.Config
• type URL
  • func NewURL(s string) (*URL, error)
  • func (u *URL) MarshalJSON() ([]byte, error)
  • func (u *URL) MarshalYAML() (interface{}, error)
  • func (u *URL) UnmarshalJSON(b []byte) error
  • func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error

Types

type CertPool

type CertPool struct {
	*x509.CertPool
	// contains filtered or unexported fields
}

CertPool is a wrapper around x509.CertPool, which can be unmarshalled and constructed from a list of filenames

func (*CertPool) MarshalJSON

func (cp *CertPool) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaller to print the cert pool

func (*CertPool) MarshalYAML

func (cp *CertPool) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaller to print the cert pool

func (*CertPool) UnmarshalJSON

func (cp *CertPool) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaller

func (*CertPool) UnmarshalYAML

func (cp *CertPool) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaller

type DFGetConfig

type DFGetConfig struct {
	SuperNodes []string `yaml:"supernodes"`
	DFRepo     string   `yaml:"localrepo"`
	DFPath     string   `yaml:"dfpath"`
	RateLimit  string   `yaml:"ratelimit"`
	URLFilter  string   `yaml:"urlfilter"`
	CallSystem string   `yaml:"callsystem"`
	Notbs      bool     `yaml:"notbs"`
}

DFGetConfig configures how dfdaemon calls dfget

type HijackConfig

type HijackConfig struct {
	Cert  string        `yaml:"cert" json:"cert"`
	Key   string        `yaml:"key" json:"key"`
	Hosts []*HijackHost `yaml:"hosts" json:"hosts"`
}

HijackConfig represents how dfdaemon hijacks http requests

type HijackHost

type HijackHost struct {
	Regx     *Regexp   `yaml:"regx" json:"regx"`
	Insecure bool      `yaml:"insecure" json:"insecure"`
	Certs    *CertPool `yaml:"certs" json:"certs"`
}

HijackHost is a hijack rule for the hosts that matches Regx

type Properties

type Properties struct {
	// Registry mirror settings
	RegistryMirror *RegistryMirror `yaml:"registry_mirror" json:"registry_mirror"`

	// Proxies is the list of rules for the transparent proxy. If no rules
	// are provided, all requests will be proxied directly. Request will be
	// proxied with the first matching rule.
	Proxies []*Proxy `yaml:"proxies" json:"proxies"`

	// HijackHTTPS is the list of hosts whose https requests should be hijacked
	// by dfdaemon. Dfdaemon will be able to proxy requests from them with dfget
	// if the url matches the proxy rules. The first matched rule will be used.
	HijackHTTPS *HijackConfig `yaml:"hijack_https" json:"hijack_https"`

	// https options
	Port    uint   `yaml:"port" json:"port"`
	HostIP  string `yaml:"hostIp" json:"hostIp"`
	CertPem string `yaml:"certpem" json:"certpem"`
	KeyPem  string `yaml:"keypem" json:"keypem"`

	// dfget config
	SuperNodes []string `yaml:"supernodes" json:"supernodes"`
	DFRepo     string   `yaml:"localrepo" json:"localrepo"`
	DFPath     string   `yaml:"dfpath" json:"dfpath"`
	RateLimit  string   `yaml:"ratelimit" json:"ratelimit"`
	URLFilter  string   `yaml:"urlfilter" json:"urlfilter"`
	CallSystem string   `yaml:"callsystem" json:"callsystem"`
	Notbs      bool     `yaml:"notbs" json:"notbs"`

	Verbose bool `yaml:"verbose" json:"verbose"`

	MaxProcs int `yaml:"maxprocs" json:"maxprocs"`
}

Properties holds all configurable properties of dfdaemon. The default path is '/etc/dragonfly/dfdaemon.yml' For examples:

registry_mirror:
  # url for the registry mirror
  remote: https://index.docker.io
  # whether to ignore https certificate errors
  insecure: false
  # optional certificates if the remote server uses self-signed certificates
  certs: []

proxies:
# proxy all http image layer download requests with dfget
- regx: blobs/sha256:.*
# change http requests to some-registry to https and proxy them with dfget
- regx: some-registry/
  use_https: true
# proxy requests directly, without dfget
- regx: no-proxy-reg
  direct: true

hijack_https:
  # key pair used to hijack https requests
  cert: df.crt
  key: df.key
  hosts:
  - regx: mirror.aliyuncs.com:443  # regexp to match request hosts
    # whether to ignore https certificate errors
    insecure: false
    # optional certificates if the host uses self-signed certificates
    certs: []

func (*Properties) DFGetConfig

func (p *Properties) DFGetConfig() DFGetConfig

DFGetConfig returns config for dfget downloader

func (*Properties) Validate

func (p *Properties) Validate() error

Validate validates the config

type Proxy

type Proxy struct {
	Regx     *Regexp `yaml:"regx" json:"regx"`
	UseHTTPS bool    `yaml:"use_https" json:"use_https"`
	Direct   bool    `yaml:"direct" json:"direct"`
}

Proxy describe a regular expression matching rule for how to proxy a request

func NewProxy

func NewProxy(regx string, useHTTPS bool, direct bool) (*Proxy, error)

NewProxy returns a new proxy rule with given attributes

func (*Proxy) Match

func (r *Proxy) Match(url string) bool

Match checks if the given url matches the rule

type Regexp

type Regexp struct {
	*regexp.Regexp
}

Regexp is simple wrapper around regexp.Regexp to make it unmarshallable from a string

func NewRegexp

func NewRegexp(exp string) (*Regexp, error)

NewRegexp returns new Regexp instance compiled from the given string

func (*Regexp) MarshalJSON

func (r *Regexp) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaller to print the regexp

func (*Regexp) MarshalYAML

func (r *Regexp) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaller to print the regexp

func (*Regexp) UnmarshalJSON

func (r *Regexp) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaller

func (*Regexp) UnmarshalYAML

func (r *Regexp) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaller

type RegistryMirror

type RegistryMirror struct {
	// Remote url for the registry mirror, default is https://index.docker.io
	Remote *URL `yaml:"remote" json:"remote"`

	// Optional certificates if the mirror uses self-signed certificates
	Certs *CertPool `yaml:"certs" json:"certs"`

	// Whether to ignore certificates errors for the registry
	Insecure bool `yaml:"insecure" json:"insecure"`
}

RegistryMirror configures the mirror of the official docker registry

func (*RegistryMirror) TLSConfig

func (r *RegistryMirror) TLSConfig() *tls.Config

TLSConfig returns the tls.Config used to communicate with the mirror

type URL

type URL struct {
	*url.URL
}

URL is simple wrapper around url.URL to make it unmarshallable from a string

func NewURL

func NewURL(s string) (*URL, error)

NewURL parses url from the given string

func (*URL) MarshalJSON

func (u *URL) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaller to print the url

func (*URL) MarshalYAML

func (u *URL) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaller to print the url

func (*URL) UnmarshalJSON

func (u *URL) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaller

func (*URL) UnmarshalYAML

func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaller