config

Documentation

Index

• Constants
• func GetCacheGCPeriod() time.Duration
• func GetConfigRoot() string
• func GetDaemonProfileCPUDuration() int64
• func GetDaemonThreadsNumber() int
• func GetFsDriver() string
• func GetLogDir() string
• func GetLogLevel() string
• func GetLogToStdout() bool
• func GetMirrorsConfigDir() string
• func GetSnapshotsRootDir() string
• func GetSocketRoot() string
• func IsSystemControllerEnabled() bool
• func MergeConfig(to, from *SnapshotterConfig) error
• func ParseParameters(args *flags.Args, cfg *SnapshotterConfig) error
• func ProcessConfigurations(c *SnapshotterConfig) error
• func SystemControllerAddress() string
• func SystemControllerPprofAddress() string
• func ValidateConfig(c *SnapshotterConfig) error
• type AuthConfig
• type CacheManagerConfig
• type DaemonConfig
• type DaemonMode
  • func GetDaemonMode() DaemonMode
• type DaemonRecoverPolicy
  • func ParseRecoverPolicy(p string) (DaemonRecoverPolicy, error)
  • func (p DaemonRecoverPolicy) String() string
• type DebugConfig
• type Experimental
• type GlobalConfig
• type ImageConfig
• type LoggingConfig
• type MetricsConfig
• type MirrorsConfig
• type RemoteConfig
• type SnapshotConfig
• type SnapshotterConfig
  • func LoadSnapshotterConfig(path string) (*SnapshotterConfig, error)
  • func (c *SnapshotterConfig) FillUpWithDefaults() error
  • func (c *SnapshotterConfig) SetupNydusBinaryPaths() error
• type SystemControllerConfig

Constants

const (
	FsDriverFusedev string = "fusedev"
	FsDriverFscache string = "fscache"
)

const (
	DefaultLogLevel string = "info"
)

Functions

func GetCacheGCPeriod

func GetCacheGCPeriod() time.Duration

func GetConfigRoot

func GetConfigRoot() string

func GetDaemonProfileCPUDuration

func GetDaemonProfileCPUDuration() int64

func GetDaemonThreadsNumber

func GetDaemonThreadsNumber() int

func GetFsDriver

func GetFsDriver() string

func GetLogDir

func GetLogDir() string

func GetLogLevel

func GetLogLevel() string

func GetLogToStdout

func GetLogToStdout() bool

func GetMirrorsConfigDir

func GetMirrorsConfigDir() string

func GetSnapshotsRootDir

func GetSnapshotsRootDir() string

func GetSocketRoot

func GetSocketRoot() string

func IsSystemControllerEnabled

func IsSystemControllerEnabled() bool

func MergeConfig

func MergeConfig(to, from *SnapshotterConfig) error

func ParseParameters

func ParseParameters(args *flags.Args, cfg *SnapshotterConfig) error

Parse command line arguments and fill the nydus-snapshotter configuration Always let options from CLI override those from configuration file.

func ProcessConfigurations

func ProcessConfigurations(c *SnapshotterConfig) error

func SystemControllerAddress

func SystemControllerAddress() string

func SystemControllerPprofAddress

func SystemControllerPprofAddress() string

func ValidateConfig

func ValidateConfig(c *SnapshotterConfig) error

Types

type AuthConfig

type AuthConfig struct {
	// based on kubeconfig or ServiceAccount
	EnableKubeconfigKeychain bool   `toml:"enable_kubeconfig_keychain"`
	KubeconfigPath           string `toml:"kubeconfig_path"`
	// CRI proxy mode
	EnableCRIKeychain   bool   `toml:"enable_cri_keychain"`
	ImageServiceAddress string `toml:"image_service_address"`
}

Configure how nydus-snapshotter receive auth information

type CacheManagerConfig

type CacheManagerConfig struct {
	Disable bool `toml:"disable"`
	// Trigger GC gc_period after the specified period.
	// Example format: 24h, 120min
	GCPeriod string `toml:"gc_period"`
	CacheDir string `toml:"cache_dir"`
}

Configure cache manager that manages the cache files lifecycle

type DaemonConfig

type DaemonConfig struct {
	NydusdPath       string `toml:"nydusd_path"`
	NydusImagePath   string `toml:"nydusimage_path"`
	NydusdConfigPath string `toml:"nydusd_config"`
	RecoverPolicy    string `toml:"recover_policy"`
	FsDriver         string `toml:"fs_driver"`
	ThreadsNumber    int    `toml:"threads_number"`
}

Configure how to start and recover nydusd daemons

type DaemonMode

type DaemonMode string

Define a policy how to fork nydusd daemon and attach file system instances to serve.

const (
	// One nydusd, one rafs instance
	DaemonModeMultiple DaemonMode = "multiple"
	// One nydusd serves multiple rafs instances
	DaemonModeShared DaemonMode = "shared"
	// No nydusd daemon is needed to be started. Snapshotter does not start any nydusd
	// and only interacts with containerd with mount slice to pass necessary configuration
	// to container runtime
	DaemonModeNone    DaemonMode = "none"
	DaemonModeInvalid DaemonMode = ""
)

func GetDaemonMode

func GetDaemonMode() DaemonMode

type DaemonRecoverPolicy

type DaemonRecoverPolicy int

const (
	RecoverPolicyInvalid DaemonRecoverPolicy = iota
	RecoverPolicyNone
	RecoverPolicyRestart
	RecoverPolicyFailover
)

func ParseRecoverPolicy

func ParseRecoverPolicy(p string) (DaemonRecoverPolicy, error)

func (DaemonRecoverPolicy) String

func (p DaemonRecoverPolicy) String() string

type DebugConfig

type DebugConfig struct {
	ProfileDuration int64  `toml:"daemon_cpu_profile_duration_secs"`
	PprofAddress    string `toml:"pprof_address"`
}

type Experimental

type Experimental struct {
	EnableStargz bool `toml:"enable_stargz"`
}

type GlobalConfig

type GlobalConfig struct {
	SnapshotsDir     string
	DaemonMode       DaemonMode
	SocketRoot       string
	ConfigRoot       string
	DaemonThreadsNum int
	CacheGCPeriod    time.Duration
	MirrorsConfig    MirrorsConfig
	// contains filtered or unexported fields
}

Retain the configurations that must be parsed and converted and the configurations that are not easy to access from some modules. Or avoid calculating repeatedly

type ImageConfig

type ImageConfig struct {
	PublicKeyFile     string `toml:"public_key_file"`
	ValidateSignature bool   `toml:"validate_signature"`
}

Nydus image layers additional process

type LoggingConfig

type LoggingConfig struct {
	LogToStdout         bool   `toml:"log_to_stdout"`
	LogLevel            string `toml:"level"`
	LogDir              string `toml:"dir"`
	RotateLogMaxSize    int    `toml:"log_rotation_max_size"`
	RotateLogMaxBackups int    `toml:"log_rotation_max_backups"`
	RotateLogMaxAge     int    `toml:"log_rotation_max_age"`
	RotateLogLocalTime  bool   `toml:"log_rotation_local_time"`
	RotateLogCompress   bool   `toml:"log_rotation_compress"`
}

type MetricsConfig

type MetricsConfig struct {
	Address string `toml:"address"`
}

type MirrorsConfig

type MirrorsConfig struct {
	Dir string `toml:"dir"`
}

type RemoteConfig

type RemoteConfig struct {
	AuthConfig         AuthConfig    `toml:"auth"`
	ConvertVpcRegistry bool          `toml:"convert_vpc_registry"`
	MirrorsConfig      MirrorsConfig `toml:"mirrors_config"`
}

Configure remote storage like container registry

type SnapshotConfig

type SnapshotConfig struct {
	EnableNydusOverlayFS bool `toml:"enable_nydus_overlayfs"`
	SyncRemove           bool `toml:"sync_remove"`
}

Configure containerd snapshots interfaces and how to process the snapshots requests from containerd

type SnapshotterConfig

type SnapshotterConfig struct {
	// Configuration format version
	Version int `toml:"version"`
	// Snapshotter's root work directory
	Root       string `toml:"root"`
	Address    string `toml:"address"`
	DaemonMode string `toml:"daemon_mode"`
	// Clean up all the resources when snapshotter is closed
	CleanupOnClose bool `toml:"cleanup_on_close"`

	SystemControllerConfig SystemControllerConfig `toml:"system"`
	MetricsConfig          MetricsConfig          `toml:"metrics"`
	DaemonConfig           DaemonConfig           `toml:"daemon"`
	SnapshotsConfig        SnapshotConfig         `toml:"snapshot"`
	RemoteConfig           RemoteConfig           `toml:"remote"`
	ImageConfig            ImageConfig            `toml:"image"`
	CacheManagerConfig     CacheManagerConfig     `toml:"cache_manager"`
	LoggingConfig          LoggingConfig          `toml:"log"`
	Experimental           Experimental           `toml:"experimental"`
}

func LoadSnapshotterConfig

func LoadSnapshotterConfig(path string) (*SnapshotterConfig, error)

func (*SnapshotterConfig) FillUpWithDefaults

func (c *SnapshotterConfig) FillUpWithDefaults() error

func (*SnapshotterConfig) SetupNydusBinaryPaths

func (c *SnapshotterConfig) SetupNydusBinaryPaths() error

type SystemControllerConfig

type SystemControllerConfig struct {
	Enable      bool        `toml:"enable"`
	Address     string      `toml:"address"`
	DebugConfig DebugConfig `toml:"debug"`
}