package daemon

import "github.com/containerd/nydus-snapshotter/pkg/daemon"

Index

Constants 

const (
	APISocketFileName   = "api.sock"
	SharedNydusDaemonID = "shared_daemon"
)

Functions

func GetDaemonGitCommit 

func GetDaemonGitCommit(nydusdPath string) (string, error)

func WaitUntilSocketExisted 

func WaitUntilSocketExisted(sock string, pid int) error

Types

type ConfigState 

type ConfigState struct {
	// A unique ID generated by daemon manager to identify the nydusd instance.
	ID              string
	ProcessID       int
	APISocket       string
	DaemonMode      config.DaemonMode
	FsDriver        string
	LogDir          string
	LogLevel        string
	LogRotationSize int
	LogToStdout     bool
	Mountpoint      string
	SupervisorPath  string
	ThreadNum       int
	FailoverPolicy  string
	// Where the configuration file resides, all rafs instances share the same configuration template
	ConfigDir string
}

Fields in this structure should be write-once, and caller should hold `Daemon.mu` when updating fields.

type Daemon 

type Daemon struct {
	States ConfigState

	// Host all RAFS filesystems managed by this daemon:
	// fusedev dedicated mode: one and only one RAFS instance
	// fusedev shared mode: zero, one or more RAFS instances
	// fscache shared mode: zero, one or more RAFS instances
	RafsCache rafs.Cache

	// Nil means this daemon object has no supervisor
	Supervisor *supervisor.Supervisor
	Config     daemonconfig.DaemonConfig

	// How much CPU nydusd is utilizing when starts since full prefetch might
	// consume many CPU cycles
	StartupCPUUtilization float64
	Version               types.BuildTimeInfo
	// contains filtered or unexported fields
}

TODO: Record queried nydusd state

func NewDaemon 

func NewDaemon(opt ...NewDaemonOpt) (*Daemon, error)

Instantiate a daemon object

func (*Daemon) AddRafsInstance 

func (d *Daemon) AddRafsInstance(r *rafs.Rafs)

func (*Daemon) ClearVestige 

func (d *Daemon) ClearVestige()

When daemon dies, clean up its vestige before start a new one.

func (*Daemon) CloneRafsInstances 

func (d *Daemon) CloneRafsInstances(src *Daemon)

func (*Daemon) ConfigFile 

func (d *Daemon) ConfigFile(instanceID string) string

Each nydusd daemon has a copy of configuration json file.

func (*Daemon) DecRef 

func (d *Daemon) DecRef() int32

func (*Daemon) Exit 

func (d *Daemon) Exit() error

func (*Daemon) GetAPISock 

func (d *Daemon) GetAPISock() string

func (*Daemon) GetCacheMetrics 

func (d *Daemon) GetCacheMetrics(sid string) (*types.CacheMetrics, error)

func (*Daemon) GetClient 

func (d *Daemon) GetClient() (NydusdClient, error)

func (*Daemon) GetDaemonInfo 

func (d *Daemon) GetDaemonInfo() (*types.DaemonInfo, error)

func (*Daemon) GetFsMetrics 

func (d *Daemon) GetFsMetrics(sid string) (*types.FsMetrics, error)

func (*Daemon) GetInflightMetrics 

func (d *Daemon) GetInflightMetrics() (*types.InflightMetrics, error)

func (*Daemon) GetRef 

func (d *Daemon) GetRef() int32

func (*Daemon) GetState 

func (d *Daemon) GetState() (types.DaemonState, error)

Get and cache daemon current working state by querying nydusd: 1. INIT 2. READY: All needed resources are ready. 3. RUNNING

func (*Daemon) HostMountpoint 

func (d *Daemon) HostMountpoint() (mnt string)

func (*Daemon) ID 

func (d *Daemon) ID() string

func (*Daemon) IncRef 

func (d *Daemon) IncRef()

func (*Daemon) IsSharedDaemon 

func (d *Daemon) IsSharedDaemon() bool

func (*Daemon) Lock 

func (d *Daemon) Lock()

func (*Daemon) LogFile 

func (d *Daemon) LogFile() string

func (*Daemon) NydusdThreadNum 

func (d *Daemon) NydusdThreadNum() int

NydusdThreadNum returns how many working threads are needed of a single nydusd

func (*Daemon) Pid 

func (d *Daemon) Pid() int

func (*Daemon) RecoverRafsInstances 

func (d *Daemon) RecoverRafsInstances() error

Daemon must be started and reach RUNNING state before call this method

func (*Daemon) RemoveRafsInstance 

func (d *Daemon) RemoveRafsInstance(snapshotID string)

func (*Daemon) ResetClient 

func (d *Daemon) ResetClient()

func (*Daemon) ResetState 

func (d *Daemon) ResetState()

Reset the cached nydusd working status

func (*Daemon) SendStates 

func (d *Daemon) SendStates()

func (*Daemon) SharedMount 

func (d *Daemon) SharedMount(rafs *rafs.Rafs) error

func (*Daemon) SharedUmount 

func (d *Daemon) SharedUmount(rafs *rafs.Rafs) error

func (*Daemon) Start 

func (d *Daemon) Start() error

func (*Daemon) State 

func (d *Daemon) State() types.DaemonState

Return the cached nydusd working status, no API is invoked.

func (*Daemon) TakeOver 

func (d *Daemon) TakeOver() error

func (*Daemon) Terminate 

func (d *Daemon) Terminate() error

func (*Daemon) UmountRafsInstance 

func (d *Daemon) UmountRafsInstance(r *rafs.Rafs) error

func (*Daemon) UmountRafsInstances 

func (d *Daemon) UmountRafsInstances() error

func (*Daemon) Unlock 

func (d *Daemon) Unlock()

func (*Daemon) UpdateAuthConfig 

func (d *Daemon) UpdateAuthConfig(snapshotID string, kc *auth.PassKeyChain) error

UpdateAuthConfig updates the registry auth for the given rafs instance. It rewrites the daemon config file on disk and, for basic auth, issues a PUT /api/v1/config to hot-reload the credential in the running nydusd. Bearer tokens are only persisted to disk (nydusd does not support runtime token updates).

func (*Daemon) UpdateRafsInstance 

func (d *Daemon) UpdateRafsInstance(r *rafs.Rafs)

func (*Daemon) Wait 

func (d *Daemon) Wait() error

func (*Daemon) WaitUntilState 

func (d *Daemon) WaitUntilState(expected types.DaemonState) error

Wait for the nydusd daemon to reach specified state with timeout.

type NewDaemonOpt 

type NewDaemonOpt func(d *Daemon) error

func WithConfigDir 

func WithConfigDir(dir string) NewDaemonOpt

func WithDaemonMode 

func WithDaemonMode(daemonMode config.DaemonMode) NewDaemonOpt

func WithFailoverPolicy 

func WithFailoverPolicy(failoverPolicy string) NewDaemonOpt

func WithFsDriver 

func WithFsDriver(fsDriver string) NewDaemonOpt

func WithLogDir 

func WithLogDir(dir string) NewDaemonOpt

func WithLogLevel 

func WithLogLevel(logLevel string) NewDaemonOpt

func WithLogRotationSize 

func WithLogRotationSize(logRotationSize int) NewDaemonOpt

func WithLogToStdout 

func WithLogToStdout(logToStdout bool) NewDaemonOpt

func WithMountpoint 

func WithMountpoint(mountpoint string) NewDaemonOpt

func WithNydusdThreadNum 

func WithNydusdThreadNum(nydusdThreadNum int) NewDaemonOpt

func WithRef 

func WithRef(ref int32) NewDaemonOpt

func WithSocketDir 

func WithSocketDir(dir string) NewDaemonOpt

Build runtime nydusd daemon object, which might be persisted later

type NydusdClient 

type NydusdClient interface {
	GetDaemonInfo() (*types.DaemonInfo, error)

	Mount(mountpoint, bootstrap, daemonConfig string) error
	Umount(mountpoint string) error

	BindBlob(daemonConfig string) error
	UnbindBlob(domainID, blobID string) error

	GetFsMetrics(sid string) (*types.FsMetrics, error)
	GetInflightMetrics() (*types.InflightMetrics, error)
	GetCacheMetrics(sid string) (*types.CacheMetrics, error)

	UpdateConfig(id string, params map[string]string) error

	TakeOver() error
	SendFd() error
	Start() error
	Exit() error
}

Nydusd HTTP client to query nydusd runtime status, operate file system instances. Control nydusd workflow like failover and upgrade.

func NewNydusClient 

func NewNydusClient(sock string) (NydusdClient, error)

Source Files

client.go config.go daemon.go idgen.go

Directories

PathSynopsis
pkg/daemon/command
pkg/daemon/types
Version
v0.15.15 (latest)
Published
Apr 17, 2026
Platform
linux/amd64
Imports
35 packages
Last checked
1 hour ago –

Tools for package owners.