Documentation
¶
Index ¶
- Constants
- func GetCacheGCPeriod() time.Duration
- func GetConfigRoot() string
- func GetDaemonFailoverPolicy() string
- func GetDaemonLogRotationSize() int
- func GetDaemonProfileCPUDuration() int64
- func GetDaemonThreadsNumber() int
- func GetFsDriver() string
- func GetLogDir() string
- func GetLogLevel() string
- func GetLogToStdout() bool
- func GetMirrorsConfigDir() string
- func GetRootMountpoint() string
- func GetSkipSSLVerify() bool
- func GetSnapshotsRootDir() string
- func GetSocketRoot() string
- func GetTarfsExportEnabled() bool
- func GetTarfsExportFlags() (bool, bool, bool)
- func GetTarfsMountOnHost() bool
- func IsBackendSourceEnabled() bool
- func IsFusedevSharedModeEnabled() bool
- func IsSystemControllerEnabled() bool
- func MergeConfig(to, from *SnapshotterConfig) error
- func ParseCgroupConfig(config CgroupConfig) (cgroup.Config, error)
- func ParseParameters(args *flags.Args, cfg *SnapshotterConfig) error
- func ProcessConfigurations(c *SnapshotterConfig) error
- func SetUpEnvironment(c *SnapshotterConfig) error
- func SystemControllerAddress() string
- func SystemControllerPprofAddress() string
- func ValidateConfig(c *SnapshotterConfig) error
- type AuthConfig
- type CacheManagerConfig
- type CgroupConfig
- type DaemonConfig
- type DaemonMode
- type DaemonRecoverPolicy
- type DebugConfig
- type Experimental
- type GlobalConfig
- type ImageConfig
- type LoggingConfig
- type MetricsConfig
- type MirrorsConfig
- type RemoteConfig
- type SnapshotConfig
- type SnapshotterConfig
- type SystemControllerConfig
- type TarfsConfig
Constants ¶
const ( FsDriverBlockdev string = constant.FsDriverBlockdev FsDriverFusedev string = constant.FsDriverFusedev FsDriverFscache string = constant.FsDriverFscache FsDriverNodev string = constant.FsDriverNodev FsDriverProxy string = constant.FsDriverProxy )
const ( FailoverPolicyNone string = constant.FailoverPolicyNone FailoverPolicyResend string = constant.FailoverPolicyResend FailoverPolicyFlush string = constant.FailoverPolicyFlush )
const ( TarfsLayerVerityOnly string = "layer_verity_only" TarfsImageVerityOnly string = "image_verity_only" TarfsLayerBlockDevice string = "layer_block" TarfsImageBlockDevice string = "image_block" TarfsLayerBlockWithVerity string = "layer_block_with_verity" TarfsImageBlockWithVerity string = "image_block_with_verity" )
Variables ¶
This section is empty.
Functions ¶
func GetCacheGCPeriod ¶ added in v0.6.0
func GetConfigRoot ¶ added in v0.6.0
func GetConfigRoot() string
func GetDaemonFailoverPolicy ¶ added in v0.15.5
func GetDaemonFailoverPolicy() string
func GetDaemonLogRotationSize ¶ added in v0.10.0
func GetDaemonLogRotationSize() int
func GetDaemonProfileCPUDuration ¶ added in v0.6.0
func GetDaemonProfileCPUDuration() int64
func GetDaemonThreadsNumber ¶ added in v0.6.0
func GetDaemonThreadsNumber() int
func GetFsDriver ¶ added in v0.5.0
func GetFsDriver() string
func GetLogLevel ¶ added in v0.6.0
func GetLogLevel() string
func GetLogToStdout ¶ added in v0.6.0
func GetLogToStdout() bool
func GetMirrorsConfigDir ¶ added in v0.6.0
func GetMirrorsConfigDir() string
func GetRootMountpoint ¶ added in v0.9.0
func GetRootMountpoint() string
func GetSkipSSLVerify ¶ added in v0.12.0
func GetSkipSSLVerify() bool
func GetSnapshotsRootDir ¶ added in v0.6.0
func GetSnapshotsRootDir() string
func GetSocketRoot ¶ added in v0.6.0
func GetSocketRoot() string
func GetTarfsExportEnabled ¶ added in v0.12.0
func GetTarfsExportEnabled() bool
func GetTarfsExportFlags ¶ added in v0.12.0
Returns (wholeImage, generateBlockImage, withVerityInfo) wholeImage: generate tarfs for the whole image instead of of a specific layer. generateBlockImage: generate a block image file. withVerityInfo: generate disk verity information.
func GetTarfsMountOnHost ¶ added in v0.12.0
func GetTarfsMountOnHost() bool
func IsBackendSourceEnabled ¶ added in v0.13.5
func IsBackendSourceEnabled() bool
func IsFusedevSharedModeEnabled ¶ added in v0.10.0
func IsFusedevSharedModeEnabled() bool
func IsSystemControllerEnabled ¶ added in v0.6.0
func IsSystemControllerEnabled() bool
func MergeConfig ¶ added in v0.6.0
func MergeConfig(to, from *SnapshotterConfig) error
func ParseCgroupConfig ¶ added in v0.9.0
func ParseCgroupConfig(config CgroupConfig) (cgroup.Config, error)
func ParseParameters ¶ added in v0.6.0
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 ¶ added in v0.6.0
func ProcessConfigurations(c *SnapshotterConfig) error
func SetUpEnvironment ¶ added in v0.8.0
func SetUpEnvironment(c *SnapshotterConfig) error
func SystemControllerAddress ¶ added in v0.6.0
func SystemControllerAddress() string
func SystemControllerPprofAddress ¶ added in v0.7.0
func SystemControllerPprofAddress() string
func ValidateConfig ¶ added in v0.6.0
func ValidateConfig(c *SnapshotterConfig) error
Types ¶
type AuthConfig ¶ added in v0.6.0
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 ¶ added in v0.6.0
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 CgroupConfig ¶ added in v0.9.0
type DaemonConfig ¶
type DaemonConfig struct {
NydusdPath string `toml:"nydusd_path"`
NydusdConfigPath string `toml:"nydusd_config"`
NydusImagePath string `toml:"nydusimage_path"`
RecoverPolicy string `toml:"recover_policy"`
FsDriver string `toml:"fs_driver"`
ThreadsNumber int `toml:"threads_number"`
LogRotationSize int `toml:"log_rotation_size"`
FailoverPolicy string `toml:"failover_policy"`
}
Configure how to start and recover nydusd daemons
type DaemonMode ¶ added in v0.4.0
type DaemonMode string
Define a policy how to fork nydusd daemon and attach file system instances to serve.
const ( // Spawn a dedicated nydusd for each RAFS instance. DaemonModeMultiple DaemonMode = DaemonMode(constant.DaemonModeMultiple) // Spawn a dedicated nydusd for each RAFS instance. DaemonModeDedicated DaemonMode = DaemonMode(constant.DaemonModeDedicated) DaemonModeShared DaemonMode = DaemonMode(constant.DaemonModeShared) // Do not spawn nydusd for RAFS instances. // // For tarfs and rund, there's no need to create nydusd to serve RAFS instances, // the snapshotter just returns mount slices with additional information for runC/runD // to manage those snapshots. DaemonModeNone DaemonMode = DaemonMode(constant.DaemonModeNone) DaemonModeInvalid DaemonMode = DaemonMode(constant.DaemonModeInvalid) // MaxRootPathLen defines the maximum allowed length of the root portion of a Unix domain socket path. // // This value is calculated based on the hard length limit of `sun_path` on Linux systems (108 bytes). // Nydusd's socket path format is "${rootPath}/socket/${xid}/api?.sock". // - The length of the fixed part "/socket/${xid}/api?.sock" is 38 bytes. // // Since the maximum upper limit of the total path length is 108 bytes, in order to avoid exceeding the limit, the maximum allowed length of rootPath is: // 108 - len("/socket/${xid}/api?.sock") = 108 - 38 = 70. // Therefore, we must set the effective maximum length of the root path to 70 bytes. MaxRootPathLen = 70 )
func GetDaemonMode ¶ added in v0.5.0
func GetDaemonMode() DaemonMode
type DaemonRecoverPolicy ¶ added in v0.6.0
type DaemonRecoverPolicy int
const ( RecoverPolicyInvalid DaemonRecoverPolicy = iota RecoverPolicyNone RecoverPolicyRestart RecoverPolicyFailover )
func ParseRecoverPolicy ¶ added in v0.6.0
func ParseRecoverPolicy(p string) (DaemonRecoverPolicy, error)
func (DaemonRecoverPolicy) String ¶ added in v0.6.0
func (p DaemonRecoverPolicy) String() string
type DebugConfig ¶ added in v0.6.0
type Experimental ¶ added in v0.6.0
type Experimental struct {
EnableStargz bool `toml:"enable_stargz"`
EnableReferrerDetect bool `toml:"enable_referrer_detect"`
TarfsConfig TarfsConfig `toml:"tarfs"`
EnableBackendSource bool `toml:"enable_backend_source"`
}
type GlobalConfig ¶ added in v0.6.0
type GlobalConfig struct {
SnapshotsDir string
DaemonMode DaemonMode
SocketRoot string
ConfigRoot string
RootMountpoint string
DaemonThreadsNum int
CacheGCPeriod time.Duration
MirrorsConfig MirrorsConfig
// contains filtered or unexported fields
}
Global cached configuration information to help: - access configuration information without passing a configuration object - avoid frequent generation of information from configuration information
type ImageConfig ¶ added in v0.6.0
type ImageConfig struct {
PublicKeyFile string `toml:"public_key_file"`
ValidateSignature bool `toml:"validate_signature"`
}
Nydus image layers additional process
type LoggingConfig ¶ added in v0.6.0
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 ¶ added in v0.6.0
type MetricsConfig struct {
Address string `toml:"address"`
}
type MirrorsConfig ¶ added in v0.6.0
type MirrorsConfig struct {
Dir string `toml:"dir"`
}
type RemoteConfig ¶ added in v0.6.0
type RemoteConfig struct {
AuthConfig AuthConfig `toml:"auth"`
ConvertVpcRegistry bool `toml:"convert_vpc_registry"`
SkipSSLVerify bool `toml:"skip_ssl_verify"`
MirrorsConfig MirrorsConfig `toml:"mirrors_config"`
}
Configure remote storage like container registry
type SnapshotConfig ¶ added in v0.6.0
type SnapshotConfig struct {
EnableNydusOverlayFS bool `toml:"enable_nydus_overlayfs"`
NydusOverlayFSPath string `toml:"nydus_overlayfs_path"`
EnableKataVolume bool `toml:"enable_kata_volume"`
SyncRemove bool `toml:"sync_remove"`
}
Configure containerd snapshots interfaces and how to process the snapshots requests from containerd
type SnapshotterConfig ¶ added in v0.4.0
type SnapshotterConfig struct {
// Configuration format version
Version int `toml:"version"`
// Snapshotter's root work directory
Root string `toml:"root"`
Address string `toml:"address"`
// UID to set on the snapshotter socket
UID int `toml:"uid"`
// GID to set on the snapshotter socket
GID int `toml:"gid"`
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"`
CgroupConfig CgroupConfig `toml:"cgroup"`
Experimental Experimental `toml:"experimental"`
}
func LoadSnapshotterConfig ¶ added in v0.4.0
func LoadSnapshotterConfig(path string) (*SnapshotterConfig, error)
func (*SnapshotterConfig) FillUpWithDefaults ¶ added in v0.6.0
func (c *SnapshotterConfig) FillUpWithDefaults() error
func (*SnapshotterConfig) SetupNydusBinaryPaths ¶ added in v0.6.0
func (c *SnapshotterConfig) SetupNydusBinaryPaths() error
type SystemControllerConfig ¶ added in v0.6.0
type SystemControllerConfig struct {
Enable bool `toml:"enable"`
Address string `toml:"address"`
// UID to set on the system controller socket
UID int `toml:"uid"`
// GID to set on the system controller socket
GID int `toml:"gid"`
DebugConfig DebugConfig `toml:"debug"`
}