entropy

Documentation

Index

• Constants
• type FirehoseChartValues
• type FirehoseConfig
• type FirehoseInitContainer
• type FirehoseResetParams
• type FirehoseScaleParams
• type FirehoseStartParams
• type FirehoseTelegraf
• type FirehoseTelegrafConf
• type JobConfig
• type JobConfigMap
• type JobContainer
• type JobSecret
• type JobVolume
• type UsageSpec

Constants

const (
	ResourceKindFirehose = "firehose"
	ResourceKindJob      = "job"
)

Types

type FirehoseChartValues

type FirehoseChartValues struct {
	ImageTag        string `json:"image_tag" validate:"required"`
	ChartVersion    string `json:"chart_version" validate:"required"`
	ImagePullPolicy string `json:"image_pull_policy" validate:"required"`
}

type FirehoseConfig

type FirehoseConfig struct {
	// Stopped flag when set forces the firehose to be stopped on next sync.
	Stopped bool `json:"stopped"`

	// StopTime can be set to schedule the firehose to be stopped at given time.
	StopTime *time.Time `json:"stop_time,omitempty"`

	// Replicas is the number of firehose instances to run.
	Replicas int `json:"replicas"`

	// Namespace is the target namespace where firehose should be deployed.
	// Inherits from driver config.
	Namespace string `json:"namespace,omitempty"`

	// DeploymentID will be used as the release-name for the deployment.
	// Must be shorter than 53 chars if set. If not set, one will be generated
	// automatically.
	DeploymentID string `json:"deployment_id,omitempty"`

	// EnvVariables contains all the firehose environment config values.
	EnvVariables map[string]string `json:"env_variables,omitempty"`

	// ResetOffset represents the value to which kafka consumer offset was set to
	ResetOffset string `json:"reset_offset,omitempty"`

	Limits        UsageSpec             `json:"limits,omitempty"`
	Requests      UsageSpec             `json:"requests,omitempty"`
	Telegraf      *FirehoseTelegraf     `json:"telegraf,omitempty"`
	ChartValues   *FirehoseChartValues  `json:"chart_values,omitempty"`
	InitContainer FirehoseInitContainer `json:"init_container,omitempty"`
}

type FirehoseInitContainer

type FirehoseInitContainer struct {
	Enabled bool `json:"enabled"`

	Args    []string `json:"args"`
	Command []string `json:"command"`

	Repository string `json:"repository"`
	ImageTag   string `json:"image_tag"`
	PullPolicy string `json:"pull_policy"`
}

type FirehoseResetParams

type FirehoseResetParams struct {
	To string `json:"to"`
}

type FirehoseScaleParams

type FirehoseScaleParams struct {
	Replicas int `json:"replicas"`
}

type FirehoseStartParams

type FirehoseStartParams struct {
	StopTime *time.Time `json:"stop_time"`
}

type FirehoseTelegraf

type FirehoseTelegraf struct {
	Enabled bool                 `json:"enabled,omitempty"`
	Image   map[string]any       `json:"image,omitempty"`
	Config  FirehoseTelegrafConf `json:"config,omitempty"`
}

type FirehoseTelegrafConf

type FirehoseTelegrafConf struct {
	Output               map[string]any    `json:"output"`
	AdditionalGlobalTags map[string]string `json:"additional_global_tags"`
}

type JobConfig

type JobConfig struct {
	Replicas   int32             `json:"replicas"`
	Namespace  string            `json:"namespace"`
	Name       string            `json:"name,omitempty"`
	Containers []JobContainer    `json:"containers,omitempty"`
	JobLabels  map[string]string `json:"job_labels,omitempty"`
	Volumes    []JobVolume       `json:"volumes,omitempty"`
	TTLSeconds *int32            `json:"ttl_seconds,omitempty"`
}

type JobConfigMap

type JobConfigMap struct {
	Name  string `json:"name"`
	Mount string `json:"mount"`
}

type JobContainer

type JobContainer struct {
	Name              string            `json:"name"`
	Image             string            `json:"image"`
	ImagePullPolicy   string            `json:"image_pull_policy,omitempty"`
	Command           []string          `json:"command,omitempty"`
	Args              []string          `json:"args,omitempty"`
	SecretsVolumes    []JobSecret       `json:"secrets_volumes,omitempty"`
	ConfigMapsVolumes []JobConfigMap    `json:"config_maps_volumes,omitempty"`
	Limits            UsageSpec         `json:"limits,omitempty"`
	Requests          UsageSpec         `json:"requests,omitempty"`
	EnvConfigMaps     []string          `json:"env_config_maps,omitempty"`
	EnvVariables      map[string]string `json:"env_variables,omitempty"`
	PreStopCmd        []string          `json:"pre_stop_cmd,omitempty"`
	PostStartCmd      []string          `json:"post_start_cmd,omitempty"`
}

type JobSecret

type JobSecret struct {
	Name  string `json:"name"`
	Mount string `json:"mount"`
}

type JobVolume

type JobVolume struct {
	Name string
	Kind string // secret or config-map. secret is for gcs/bq credential
}

type UsageSpec

type UsageSpec struct {
	CPU    string `json:"cpu,omitempty" validate:"required"`
	Memory string `json:"memory,omitempty" validate:"required"`
}