config

type BackgroundVerification struct {
	// VerificationInterval determines the duration after a replica due for reverification.
	// The feature is disabled if verification interval is 0 or below.
	VerificationInterval duration.Duration `toml:"verification_interval,omitempty" json:"verification_interval"`
	// DeleteInvalidRecords controls whether the background verifier will actually delete the metadata
	// records that point to non-existent replicas.
	DeleteInvalidRecords bool `toml:"delete_invalid_records" json:"delete_invalid_records"`
}

type Config struct {
	// ConfigCommand specifies the path to an executable that Praefect will run after loading the initial
	// configuration. The executable is expected to write JSON-formatted configuration to its standard
	// output that we will then deserialize and merge back into the initially-loaded configuration again.
	// This is an easy mechanism to generate parts of the configuration at runtime, like for example secrets.
	ConfigCommand          string                 `toml:"config_command,omitempty" json:"config_command"`
	AllowLegacyElectors    bool                   `` /* 193-byte string literal not displayed */
	BackgroundVerification BackgroundVerification `toml:"background_verification,omitempty" json:"background_verification"`
	Reconciliation         Reconciliation         `toml:"reconciliation,omitempty" json:"reconciliation"`
	Replication            Replication            `toml:"replication,omitempty" json:"replication"`
	ListenAddr             string                 `toml:"listen_addr,omitempty" json:"listen_addr"`
	TLSListenAddr          string                 `toml:"tls_listen_addr,omitempty" json:"tls_listen_addr"`
	SocketPath             string                 `toml:"socket_path,omitempty" json:"socket_path"`
	VirtualStorages        []*VirtualStorage      `toml:"virtual_storage,omitempty" json:"virtual_storage"`
	Logging                log.Config             `toml:"logging,omitempty" json:"logging"`
	Sentry                 sentry.Config          `toml:"sentry,omitempty" json:"sentry"`
	PrometheusListenAddr   string                 `toml:"prometheus_listen_addr,omitempty" json:"prometheus_listen_addr"`
	Prometheus             prometheus.Config      `toml:"prometheus,omitempty" json:"prometheus"`
	Auth                   auth.Config            `toml:"auth,omitempty" json:"auth"`
	TLS                    config.TLS             `toml:"tls,omitempty" json:"tls"`
	DB                     `toml:"database,omitempty" json:"database"`
	Failover               Failover            `toml:"failover,omitempty" json:"failover"`
	MemoryQueueEnabled     bool                `toml:"memory_queue_enabled,omitempty" json:"memory_queue_enabled"`
	GracefulStopTimeout    duration.Duration   `toml:"graceful_stop_timeout,omitempty" json:"graceful_stop_timeout"`
	RepositoriesCleanup    RepositoriesCleanup `toml:"repositories_cleanup,omitempty" json:"repositories_cleanup"`
	Yamux                  Yamux               `toml:"yamux,omitempty" json:"yamux"`
}

type DB struct {
	Host        string `toml:"host,omitempty" json:"host"`
	Port        int    `toml:"port,omitempty" json:"port"`
	User        string `toml:"user,omitempty" json:"user"`
	Password    string `toml:"password,omitempty" json:"password"`
	DBName      string `toml:"dbname,omitempty" json:"dbname"`
	SSLMode     string `toml:"sslmode,omitempty" json:"sslmode"`
	SSLCert     string `toml:"sslcert,omitempty" json:"sslcert"`
	SSLKey      string `toml:"sslkey,omitempty" json:"sslkey"`
	SSLRootCert string `toml:"sslrootcert,omitempty" json:"sslrootcert"`

	SessionPooled DBConnection `toml:"session_pooled,omitempty" json:"session_pooled"`

	// The following configuration keys are deprecated and
	// will be removed. Use Host and Port attributes of
	// SessionPooled instead.
	HostNoProxy string `toml:"host_no_proxy,omitempty" json:"host_no_proxy"`
	PortNoProxy int    `toml:"port_no_proxy,omitempty" json:"port_no_proxy"`
}

type DBConnection struct {
	Host        string `toml:"host,omitempty" json:"host"`
	Port        int    `toml:"port,omitempty" json:"port"`
	User        string `toml:"user,omitempty" json:"user"`
	Password    string `toml:"password,omitempty" json:"password"`
	DBName      string `toml:"dbname,omitempty" json:"dbname"`
	SSLMode     string `toml:"sslmode,omitempty" json:"sslmode"`
	SSLCert     string `toml:"sslcert,omitempty" json:"sslcert"`
	SSLKey      string `toml:"sslkey,omitempty" json:"sslkey"`
	SSLRootCert string `toml:"sslrootcert,omitempty" json:"sslrootcert"`
}

type ElectionStrategy string

type Failover struct {
	// Enabled is a trigger used to check if failover is enabled or not.
	Enabled bool `toml:"enabled,omitempty" json:"enabled"`
	// ElectionStrategy is the strategy to use for electing primaries nodes.
	ElectionStrategy         ElectionStrategy  `toml:"election_strategy,omitempty" json:"election_strategy"`
	ErrorThresholdWindow     duration.Duration `toml:"error_threshold_window,omitempty" json:"error_threshold_window"`
	WriteErrorThresholdCount uint32            `toml:"write_error_threshold_count,omitempty" json:"write_error_threshold_count"`
	ReadErrorThresholdCount  uint32            `toml:"read_error_threshold_count,omitempty" json:"read_error_threshold_count"`
	// BootstrapInterval allows set a time duration that would be used on startup to make initial health check.
	// The default value is 1s.
	BootstrapInterval duration.Duration `toml:"bootstrap_interval,omitempty" json:"bootstrap_interval"`
	// MonitorInterval allows set a time duration that would be used after bootstrap is completed to execute health checks.
	// The default value is 3s.
	MonitorInterval duration.Duration `toml:"monitor_interval,omitempty" json:"monitor_interval"`
}

type Node struct {
	Storage string `toml:"storage,omitempty" json:"storage"`
	Address string `toml:"address,omitempty" json:"address"`
	Token   string `toml:"token,omitempty" json:"token"`
}

type Reconciliation struct {
	// SchedulingInterval the interval between each automatic reconciliation run. If set to 0,
	// automatic reconciliation is disabled.
	SchedulingInterval duration.Duration `toml:"scheduling_interval,omitempty" json:"scheduling_interval"`
	// HistogramBuckets configures the reconciliation scheduling duration histogram's buckets.
	HistogramBuckets []float64 `toml:"histogram_buckets,omitempty" json:"histogram_buckets"`
}

type Replication struct {
	// BatchSize controls how many replication jobs to dequeue and lock
	// in a single call to the database.
	BatchSize uint `toml:"batch_size,omitempty" json:"batch_size"`
	// ParallelStorageProcessingWorkers is a number of workers used to process replication
	// events per virtual storage (how many storages would be processed in parallel).
	ParallelStorageProcessingWorkers uint `toml:"parallel_storage_processing_workers,omitempty" json:"parallel_storage_processing_workers"`
}

type RepositoriesCleanup struct {
	// CheckInterval is a time period used to check if operation should be executed.
	// It is recommended to keep it less than run_interval configuration as some
	// nodes may be out of service, so they can be stale for too long.
	CheckInterval duration.Duration `toml:"check_interval,omitempty" json:"check_interval"`
	// RunInterval: the check runs if the previous operation was done at least RunInterval before.
	RunInterval duration.Duration `toml:"run_interval,omitempty" json:"run_interval"`
	// RepositoriesInBatch is the number of repositories to pass as a batch for processing.
	RepositoriesInBatch uint `toml:"repositories_in_batch,omitempty" json:"repositories_in_batch"`
}

type VirtualStorage struct {
	Name  string  `toml:"name,omitempty" json:"name"`
	Nodes []*Node `toml:"node,omitempty" json:"node"`
	// DefaultReplicationFactor is the replication factor set for new repositories.
	// A valid value is inclusive between 1 and the number of configured storages in the
	// virtual storage. Setting the value to 0 or below causes Praefect to not store any
	// host assignments, falling back to the behavior of replicating to every configured
	// storage
	DefaultReplicationFactor int `toml:"default_replication_factor,omitempty" json:"default_replication_factor"`
}

type Yamux struct {
	// MaximumStreamWindowSizeBytes sets the maximum window size in bytes used for yamux streams.
	// Higher value can increase throughput at the cost of more memory usage.
	MaximumStreamWindowSizeBytes uint32 `toml:"maximum_stream_window_size_bytes,omitempty" json:"maximum_stream_window_size_bytes"`
	// AcceptBacklog sets the maximum number of stream openings in-flight before further openings
	// block.
	AcceptBacklog uint `toml:"accept_backlog,omitempty" json:"accept_backlog"`
}