task

Documentation

Index

• Constants
• type Config
  • func NewConfig() Config
  • func (c Config) Validate() error

Constants

const DefaultTaskRunBucket = "kapacitor_fluxtask_logs"

Types

type Config

type Config struct {
	// Enabled determines if flux tasks are enabled
	Enabled bool `toml:"enabled"`

	// TaskRunInfluxDB is the name of the influxdb instance finished
	// task runs and logs are written to.
	// Leaving it blank will write to Kapacitor's default influxdb instance.
	// Setting it to 'none' will disable task logging.
	TaskRunInfluxDB string `toml:"task-run-influxdb"`

	// TaskRunBucket is the bucket (or influxdb 1.x database) to use for saving
	// task runs and logs
	TaskRunBucket string `toml:"task-run-bucket"`

	// TaskRunOrg is the org to use for saving task runs and logs
	// task runs and logs.
	// This is ignored if TaskRunInfluxDB is a 1.x database
	// Only one of TaskRunOrg and TaskRunOrgID should be set
	TaskRunOrg string `toml:"task-run-org"`

	// TaskRunOrgID is the org to use for saving task runs and logs
	// task runs and logs.
	// This is ignored if TaskRunInfluxDB is a 1.x database
	// Only one of TaskRunOrg and TaskRunOrgID should be set
	TaskRunOrgID string `toml:"task-run-orgid"`

	// TaskRunMeasurement is the measurement used for saving task runs
	// and logs.
	// The defaults is "runs"
	TaskRunMeasurement string `toml:"task-run-measurement"`

	// Secrets is the kapacitor provider for secrets as described at
	// https://docs.influxdata.com/influxdb/v2.0/security/secrets/
	Secrets map[string]string `toml:"secrets"`

	// DefaultInfluxDB is the default influxdb instance that task scripts with interact with.
	// This defaults to the kapacitor's default influxdb if left blank.
	DefaultInfluxDB string `toml:"default-influxdb"`
}

func NewConfig

func NewConfig() Config

func (Config) Validate

func (c Config) Validate() error