config

Documentation

Index

• func NewDefaultPlugins() map[plugins.PluginType][]*plugins.PluginProperties
• type BaseProperties
  • func NewDefaultBaseProperties() *BaseProperties
• type Config
  • func New() *Config
  • func (c *Config) String() string
  • func (c *Config) Validate() []error
• type DeprecatedConfig
  • func NewDeprecatedConfig() *DeprecatedConfig
  • func (c DeprecatedConfig) Convert() *Config
• type DriverConfig
• type GCConfig
• type HostConfig
• type KeepAliveConfig
  • func (c KeepAliveConfig) Validate() []error
• type ManagerConfig
  • func (c ManagerConfig) Validate() []error
• type RestConfig
• type StorageConfig

Functions

func NewDefaultPlugins

func NewDefaultPlugins() map[plugins.PluginType][]*plugins.PluginProperties

NewDefaultPlugins creates plugin instants with default values.

Types

type BaseProperties

type BaseProperties struct {
	// ListenPort is the port cdn server listens on.
	// default: 8002
	ListenPort int `yaml:"listenPort" mapstructure:"listenPort"`

	// DownloadPort is the port for download files from cdn.
	// default: 8001
	DownloadPort int `yaml:"downloadPort" mapstructure:"downloadPort"`

	// SystemReservedBandwidth is the network bandwidth reserved for system software.
	// default: 20 MB, in format of G(B)/g/M(B)/m/K(B)/k/B, pure number will also be parsed as Byte.
	SystemReservedBandwidth unit.Bytes `yaml:"systemReservedBandwidth" mapstructure:"systemReservedBandwidth"`

	// MaxBandwidth is the network bandwidth that cdn system can use.
	// default: 200 MB, in format of G(B)/g/M(B)/m/K(B)/k/B, pure number will also be parsed as Byte.
	MaxBandwidth unit.Bytes `yaml:"maxBandwidth" mapstructure:"maxBandwidth"`

	// AdvertiseIP is used to set the ip that we advertise to other peer in the p2p-network.
	// By default, the first non-loop address is advertised.
	AdvertiseIP string `yaml:"advertiseIP" mapstructure:"advertiseIP"`

	// FailAccessInterval is the interval time after failed to access the URL.
	// unit: minutes
	// default: 3
	FailAccessInterval time.Duration `yaml:"failAccessInterval" mapstructure:"failAccessInterval"`

	// gc related
	// GCInitialDelay is the delay time from the start to the first GC execution.
	// default: 6s
	GCInitialDelay time.Duration `yaml:"gcInitialDelay" mapstructure:"gcInitialDelay"`

	// GCMetaInterval is the interval time to execute GC meta.
	// default: 2min
	GCMetaInterval time.Duration `yaml:"gcMetaInterval" mapstructure:"gcMetaInterval"`

	// TaskExpireTime when a task is not accessed within the taskExpireTime,
	// and it will be treated to be expired.
	// default: 3min
	TaskExpireTime time.Duration `yaml:"taskExpireTime" mapstructure:"taskExpireTime"`

	// StorageMode disk/hybrid/memory
	StorageMode string `yaml:"storageMode" mapstructure:"storageMode"`

	// Log directory
	LogDir string `yaml:"logDir" mapstructure:"logDir"`

	// WorkHome directory
	WorkHome string `mapstructure:"workHome" yaml:"workHome"`

	// Manager configuration
	Manager ManagerConfig `yaml:"manager" mapstructure:"manager"`

	// Host configuration
	Host HostConfig `yaml:"host" mapstructure:"host"`

	// Metrics configuration
	Metrics *RestConfig `yaml:"metrics" mapstructure:"metrics"`
}

BaseProperties contains all basic properties of cdn system.

func NewDefaultBaseProperties

func NewDefaultBaseProperties() *BaseProperties

NewDefaultBaseProperties creates an base properties instant with default values.

type Config

type Config struct {
	base.Options `yaml:",inline" mapstructure:",squash"`
	Metrics      metrics.Config   `yaml:"metrics" mapstructure:"metrics"`
	Storage      storage.Config   `yaml:"storage" mapstructure:"storage"`
	RPCServer    rpcserver.Config `yaml:"rpcServer" mapstructure:"rpcServer"`
	Task         task.Config      `yaml:"taskConfig" mapstructure:"taskConfig"`
	CDN          cdn.Config       `yaml:"cdnConfig" mapstructure:"cdnConfig"`
	// Manager configuration
	Manager ManagerConfig `yaml:"manager" mapstructure:"manager"`
	// Host configuration
	Host HostConfig `yaml:"host" mapstructure:"host"`
	// Log directory
	LogDir string `yaml:"logDir" mapstructure:"logDir"`
	// WorkHome directory
	WorkHome string `mapstructure:"workHome" yaml:"workHome"`
}

Config contains all configuration of cdn node.

func New

func New() *Config

New creates an instant with default values.

func (*Config) String

func (c *Config) String() string

func (*Config) Validate

func (c *Config) Validate() []error

type DeprecatedConfig

type DeprecatedConfig struct {
	base.Options    `yaml:",inline" mapstructure:",squash"`
	*BaseProperties `yaml:"base" mapstructure:"base"`

	Plugins map[plugins.PluginType][]*plugins.PluginProperties `yaml:"plugins" mapstructure:"plugins"`
}

DeprecatedConfig contains all configuration of cdn node.

func NewDeprecatedConfig

func NewDeprecatedConfig() *DeprecatedConfig

NewDeprecatedConfig creates an instant with default values.

func (DeprecatedConfig) Convert

func (c DeprecatedConfig) Convert() *Config

type DriverConfig

type DriverConfig struct {
	GCConfig *GCConfig `yaml:"gcConfig"`
}

type GCConfig

type GCConfig struct {
	YoungGCThreshold  unit.Bytes    `yaml:"youngGCThreshold"`
	FullGCThreshold   unit.Bytes    `yaml:"fullGCThreshold"`
	CleanRatio        int           `yaml:"cleanRatio"`
	IntervalThreshold time.Duration `yaml:"intervalThreshold"`
}

GCConfig gc config

type HostConfig

type HostConfig struct {
	// CDN idc.
	IDC string `mapstructure:"idc" yaml:"idc"`

	// CDN network topology.
	NetTopology string `mapstructure:"netTopology" yaml:"netTopology"`

	// CDN location.
	Location string `mapstructure:"location" yaml:"location"`
}

type KeepAliveConfig

type KeepAliveConfig struct {
	// Keep alive interval.
	Interval time.Duration `yaml:"interval" mapstructure:"interval"`
}

func (KeepAliveConfig) Validate

func (c KeepAliveConfig) Validate() []error

type ManagerConfig

type ManagerConfig struct {
	// NetAddr is manager address.
	Addr string `yaml:"addr" mapstructure:"addr"`

	// SeedPeerClusterID is seed peer cluster id.
	SeedPeerClusterID uint `yaml:"seedPeerClusterID" mapstructure:"seedPeerClusterID"`

	// KeepAlive configuration.
	KeepAlive KeepAliveConfig `yaml:"keepAlive" mapstructure:"keepAlive"`
}

func (ManagerConfig) Validate

func (c ManagerConfig) Validate() []error

type RestConfig

type RestConfig struct {
	Addr string `yaml:"addr" mapstructure:"addr"`
}

type StorageConfig

type StorageConfig struct {
	GCInitialDelay time.Duration            `yaml:"gcInitialDelay"`
	GCInterval     time.Duration            `yaml:"gcInterval"`
	DriverConfigs  map[string]*DriverConfig `yaml:"driverConfigs"`
}