config

Documentation

Index

• Variables
• func ReplaceEnvironment(val string) string
• type Config
  • func DefaultFromEnv() Config
• type DatabaseConfig
• type KafkaConfig
• type KafkaTopics
• type LogConfig
  • func (lc *LogConfig) GetLevel() zerolog.Level
• type SchedulerConfig
• type ServerConfig
• type SnapshotConfig
• type TransportConfig
• type WorkerConfig

Variables

var EnvPrefix = "KEEL_"

Functions

func ReplaceEnvironment

func ReplaceEnvironment(val string) string

Types

type Config

type Config struct {
	Log       LogConfig
	Database  DatabaseConfig
	Scheduler SchedulerConfig
	Snapshot  SnapshotConfig
	Worker    WorkerConfig
	Transport TransportConfig
}

func DefaultFromEnv

func DefaultFromEnv() Config

type DatabaseConfig

type DatabaseConfig struct {
	Type string
	DSN  string
}

type KafkaConfig

type KafkaConfig struct {
	Brokers      []string    // Broker addresses
	Topics       KafkaTopics // Topics
	GroupId      string      // Consumer group id
	MessageTTL   int         // Message TTL in seconds
	EnableSASL   bool        // Enable SASL
	SASLUsername string      // SASL username
	SASLPassword string      // SASL password
}

type KafkaTopics

type KafkaTopics struct {
	Tasks    []string // Tasks topics
	Messages []string // Messages topics
}

type LogConfig

type LogConfig struct {
	Level string
}

func (*LogConfig) GetLevel

func (lc *LogConfig) GetLevel() zerolog.Level

type SchedulerConfig

type SchedulerConfig struct {
	Id                      string // Scheduler id, also used to identify partition
	Zone                    string // The zone to which schedule belongs to
	Port                    int
	Numbers                 int // Number of schedulers within the same zone
	Address                 string
	AdvertisedAddress       string
	ScheduleInterval        int // Schedule interval in seconds
	StaleCheckDelay         int // Stale tasks check delay after start up in seconds
	TaskEventUpdateDeadline int // Deadline in seconds for the scheduler to receive task update events
}

type ServerConfig

type ServerConfig struct {
	HttpAddress string // HTTP server address
	GrpcAddress string // GRPC server address
}

type SnapshotConfig

type SnapshotConfig struct {
	Enabled      bool          // When enabled, schedulers save snapshot files to specified S3 bucket
	MaxVersions  int           // The maximum number of snapshot versions being kept
	Interval     time.Duration // Interval to take snapshots
	Endpoint     string        // S3 endpoint
	Region       string        // S3 region
	Bucket       string        // S3 bucket
	AccessKey    string        // S3 access key
	AccessSecret string        // S3 access secret
	Secure       bool          // Whether LTS is enabled
}

type TransportConfig

type TransportConfig struct {
	Type  string      // Transport type, e.g. kafka
	Role  string      // Transport role, available values are enum.TransportRole
	Kafka KafkaConfig // Kafka config
}

type WorkerConfig

type WorkerConfig struct {
	Name             string   // Worker name used to identify the worker
	PoolSize         int      // Worker executor pool size
	Generation       int      // Worker generation
	ReportInterval   int      // Interval in seconds that the worker reports events to scheduler
	HandlerWhiteList []string // Handler white list, when specified only listed handlers are allowed to be registered. Default to '*' which means all handlers can be registered
}