config

type ActiveJob struct {
	Type               string                   `yaml:"type" validate:"required"`
	Name               string                   `yaml:"name" validate:"required"`
	Connect            Connect                  `yaml:"connect"`
	Pruning            PruningSenderReceiver    `yaml:"pruning"`
	Replication        Replication              `yaml:"replication"`
	ConflictResolution ConflictResolution       `yaml:"conflict_resolution"`
	MonitorSnapshots   MonitorSnapshots         `yaml:"monitor"`
	Interval           PositiveDurationOrManual `yaml:"interval"`
	Cron               string                   `yaml:"cron"`
	Hooks              JobHooks                 `yaml:"hooks"`
}

type AuthKey struct {
	Name string `yaml:"name" validate:"required"`
	Key  string `yaml:"key" validate:"required"`
}

type Config struct {
	Global Global   `yaml:"global"`
	Listen []Listen `yaml:"listen" validate:"dive"`

	Keys        []AuthKey `yaml:"keys" validate:"dive"`
	IncludeKeys string    `yaml:"include_keys" validate:"omitempty,filepath"`

	Jobs        []JobEnum `yaml:"jobs" validate:"min=1,dive"`
	IncludeJobs string    `yaml:"include_jobs" validate:"omitempty,filepath"`
	// contains filtered or unexported fields
}

type ConflictResolution struct {
	InitialReplication string `yaml:"initial_replication" default:"all" validate:"required"`
}

type Connect struct {
	Type           string `yaml:"type" validate:"required,oneof=http local"`
	Server         string `yaml:"server" validate:"required_if=Type http,omitempty,url"`
	ListenerName   string `yaml:"listener_name" validate:"required"`
	ClientIdentity string `yaml:"client_identity" validate:"required"`
}

type DatasetFilter struct {
	Pattern   string `yaml:"pattern"`
	Exclude   bool   `yaml:"exclude"`
	Recursive bool   `yaml:"recursive" validate:"excluded_with=Shell"`
	Shell     bool   `yaml:"shell" validate:"excluded_with=Recursive"`
}

type Duration struct {
	// contains filtered or unexported fields
}

type FileLoggingOutlet struct {
	LoggingOutletCommon `yaml:",inline"`

	FileName string `yaml:"filename"`
}

type FilesystemsFilter map[string]bool

type Global struct {
	RpcTimeout time.Duration `yaml:"rpc_timeout" default:"1m" validate:"gt=0s"`
	ZfsBin     string        `yaml:"zfs_bin" default:"zfs" validate:"required"`

	Logging    LoggingOutletEnumList  `yaml:"logging" validate:"min=1"`
	Monitoring []PrometheusMonitoring `yaml:"monitoring" validate:"dive"`
	Control    GlobalControl          `yaml:"control"`
}

type GlobalControl struct {
	SockPath string `yaml:"sockpath" default:"/var/run/zrepl/control" validate:"filepath"`
	SockMode uint32 `yaml:"sockmode" validate:"lte=0o777"`
}

type HookCommand struct {
	Path        string            `yaml:"path" validate:"required"`
	Args        []string          `yaml:"args" validate:"dive,required"`
	Env         map[string]string `yaml:"env" validate:"dive,keys,required,endkeys,required"`
	Timeout     time.Duration     `yaml:"timeout" default:"1m" validate:"min=0s"`
	Filesystems FilesystemsFilter `yaml:"filesystems"`
	Datasets    []DatasetFilter   `yaml:"datasets" validate:"dive"`
	ErrIsFatal  bool              `yaml:"err_is_fatal"`
}

type JobEnum struct {
	Ret any `validate:"required"`
}

type JobHooks struct {
	Pre  *HookCommand `yaml:"pre"`
	Post *HookCommand `yaml:"post"`
}

type Listen struct {
	Addr string `yaml:"addr" validate:"required_without=Unix,omitempty,hostname_port"`

	Unix     string `yaml:"unix" validate:"required_without=Addr,omitempty,filepath"`
	UnixMode uint32 `yaml:"unix_mode" validate:"lte=0o777"`

	TLSCert string `yaml:"tls_cert" validate:"required_with=TLSKey,omitempty,filepath"`
	TLSKey  string `yaml:"tls_key" validate:"omitempty,filepath"`

	Control bool `yaml:"control" validate:"required_without_all=Metrics Zfs"`
	Metrics bool `yaml:"metrics" validate:"required_without_all=Control Zfs"`
	Zfs     bool `yaml:"zfs" validate:"required_without_all=Control Metrics"`
}

type LoggingOutletCommon struct {
	Type       string   `yaml:"type" validate:"required"`
	Level      string   `yaml:"level" validate:"required"`
	Format     string   `yaml:"format" validate:"required"`
	HideFields []string `yaml:"hide_fields"`
	Time       bool     `yaml:"time" default:"true"`
}

type LoggingOutletEnum struct {
	Ret any `validate:"required"`
}

type LoggingOutletEnumList []LoggingOutletEnum

type MonitorCount struct {
	Prefix       string          `yaml:"prefix"`
	SkipDatasets []DatasetFilter `yaml:"skip_datasets" validate:"dive"`
	Warning      uint            `yaml:"warning"`
	Critical     uint            `yaml:"critical" validate:"required"`
}

type MonitorCreation struct {
	Prefix       string          `yaml:"prefix"`
	SkipDatasets []DatasetFilter `yaml:"skip_datasets" validate:"dive"`
	Warning      time.Duration   `yaml:"warning"`
	Critical     time.Duration   `yaml:"critical" validate:"required"`
}

type MonitorSnapshots struct {
	Count  []MonitorCount    `yaml:"count" validate:"dive"`
	Latest []MonitorCreation `yaml:"latest" validate:"dive"`
	Oldest []MonitorCreation `yaml:"oldest" validate:"dive"`
}

type Option func(self *Config)

type PassiveJob struct {
	Type             string           `yaml:"type" validate:"required"`
	Name             string           `yaml:"name" validate:"required"`
	ClientKeys       []string         `yaml:"client_keys" validate:"dive,required"`
	Pruning          PruningLocal     `yaml:"pruning"`
	MonitorSnapshots MonitorSnapshots `yaml:"monitor"`
}

type PlaceholderRecvOptions struct {
	Encryption string `yaml:"encryption" default:"inherit" validate:"required"`
}

type PositiveDuration struct {
	// contains filtered or unexported fields
}

type PositiveDurationOrManual struct {
	Interval time.Duration
	Manual   bool
}

type PrometheusMonitoring struct {
	Type           string `yaml:"type" validate:"required"`
	Listen         string `yaml:"listen" validate:"required,hostname_port"`
	ListenFreeBind bool   `yaml:"listen_freebind"`
}

type PropertyRecvOptions struct {
	Inherit  []zfsprop.Property          `yaml:"inherit" validate:"dive,required"`
	Override map[zfsprop.Property]string `yaml:"override" validate:"dive,required"`
}

type PruneGrid struct {
	Type  string                `yaml:"type"`
	Grid  RetentionIntervalList `yaml:"grid"`
	Regex string                `yaml:"regex"`
}

type PruneKeepLastN struct {
	Type  string `yaml:"type" validate:"required"`
	Count int    `yaml:"count" validate:"required"`
	Regex string `yaml:"regex"`
}

type PruneKeepNotReplicated struct {
	Type                 string `yaml:"type" validate:"required"`
	KeepSnapshotAtCursor bool   `yaml:"keep_snapshot_at_cursor" default:"true"`
}

type PruneKeepRegex struct {
	Type   string `yaml:"type" validate:"required"`
	Regex  string `yaml:"regex" validate:"required"`
	Negate bool   `yaml:"negate"`
}

type PruningEnum struct {
	Ret any `validate:"required"`
}

type PruningLocal struct {
	Concurrency uint          `yaml:"concurrency"`
	Keep        []PruningEnum `yaml:"keep"`
}

type PruningSenderReceiver struct {
	Concurrency  uint          `yaml:"concurrency"`
	KeepSender   []PruningEnum `yaml:"keep_sender"`
	KeepReceiver []PruningEnum `yaml:"keep_receiver"`
}

type PullJob struct {
	ActiveJob `yaml:",inline"`

	RootFS string      `yaml:"root_fs" validate:"required"`
	Recv   RecvOptions `yaml:"recv"`
}

type PushJob struct {
	ActiveJob `yaml:",inline"`

	Snapshotting SnapshottingEnum  `yaml:"snapshotting"`
	Filesystems  FilesystemsFilter `yaml:"filesystems" validate:"required_without=Datasets"`
	Datasets     []DatasetFilter   `yaml:"datasets" validate:"required_without=Filesystems,dive"`
	Send         SendOptions       `yaml:"send"`
}

type RecvOptions struct {
	Properties  PropertyRecvOptions    `yaml:"properties"`
	Placeholder PlaceholderRecvOptions `yaml:"placeholder"`

	ExecPipe [][]string `yaml:"execpipe" validate:"dive,required"`
}

type Replication struct {
	Protection  ReplicationOptionsProtection  `yaml:"protection"`
	Concurrency ReplicationOptionsConcurrency `yaml:"concurrency"`
	Prefix      string                        `yaml:"prefix"`
}

type ReplicationOptionsConcurrency struct {
	Steps         int  `yaml:"steps" default:"1" validate:"min=1"`
	SizeEstimates uint `yaml:"size_estimates"`
}

type ReplicationOptionsProtection struct {
	Initial     string `yaml:"initial" default:"guarantee_resumability" validate:"required"`
	Incremental string `yaml:"incremental" default:"guarantee_resumability" validate:"required"`
}

type RetentionInterval struct {
	// contains filtered or unexported fields
}

type RetentionIntervalList []RetentionInterval

type SendOptions struct {
	ListPlaceholders bool `yaml:"list_placeholders"`
	Encrypted        bool `yaml:"encrypted"`
	Raw              bool `yaml:"raw" default:"true"`
	SendProperties   bool `yaml:"send_properties"`
	BackupProperties bool `yaml:"backup_properties"`
	LargeBlocks      bool `yaml:"large_blocks"`
	Compressed       bool `yaml:"compressed"`
	EmbeddedData     bool `yaml:"embedded_data"`
	Saved            bool `yaml:"saved"`

	ExecPipe [][]string `yaml:"execpipe" validate:"dive,required"`
}

type SinkJob struct {
	PassiveJob `yaml:",inline"`

	RootFS string      `yaml:"root_fs" validate:"required"`
	Recv   RecvOptions `yaml:"recv"`
}

type SnapJob struct {
	Type             string            `yaml:"type" validate:"required"`
	Name             string            `yaml:"name" validate:"required"`
	Pruning          PruningLocal      `yaml:"pruning"`
	Snapshotting     SnapshottingEnum  `yaml:"snapshotting"`
	Filesystems      FilesystemsFilter `yaml:"filesystems" validate:"required_without=Datasets"`
	Datasets         []DatasetFilter   `yaml:"datasets" validate:"required_without=Filesystems,dive"`
	MonitorSnapshots MonitorSnapshots  `yaml:"monitor"`
}

type SnapshottingEnum struct {
	Ret any `validate:"required"`
}

type SnapshottingManual struct {
	Type string `yaml:"type" validate:"required"`
}

type SnapshottingPeriodic struct {
	Type             string                   `yaml:"type" validate:"required,oneof=cron manual periodic"`
	Prefix           string                   `yaml:"prefix" validate:"required"`
	Interval         PositiveDurationOrManual `yaml:"interval"`
	Cron             string                   `yaml:"cron"`
	Hooks            []HookCommand            `yaml:"hooks" validate:"dive"`
	TimestampFormat  string                   `yaml:"timestamp_format" default:"dense" validate:"required"`
	TimestampLocal   bool                     `yaml:"timestamp_local" default:"true"`
	Concurrency      uint                     `yaml:"concurrency"`
	WrittenThreshold uint64                   `yaml:"written_threshold"`
}

type SourceJob struct {
	PassiveJob `yaml:",inline"`

	Replication  Replication       `yaml:"replication"`
	Snapshotting SnapshottingEnum  `yaml:"snapshotting"`
	Filesystems  FilesystemsFilter `yaml:"filesystems" validate:"required_without=Datasets"`
	Datasets     []DatasetFilter   `yaml:"datasets" validate:"required_without=Filesystems,dive"`
	Send         SendOptions       `yaml:"send"`
}

type SyslogFacility syslog.Priority

type SyslogLoggingOutlet struct {
	LoggingOutletCommon `yaml:",inline"`

	Facility      SyslogFacility `yaml:"facility" default:"local0" validate:"required"`
	RetryInterval time.Duration  `yaml:"retry_interval" default:"10s" validate:"gt=0s"`
}

type TCPLoggingOutlet struct {
	LoggingOutletCommon `yaml:",inline"`

	Address       string               `yaml:"address" validate:"required,hostname_port"`
	Net           string               `yaml:"net" default:"tcp" validate:"required"`
	RetryInterval time.Duration        `yaml:"retry_interval" default:"10s" validate:"gt=0s"`
	TLS           *TCPLoggingOutletTLS `yaml:"tls"`
}

type TCPLoggingOutletTLS struct {
	CA   string `yaml:"ca" validate:"required"`
	Cert string `yaml:"cert" validate:"required"`
	Key  string `yaml:"key" validate:"required"`
}