config

Documentation

Index

• func FetchConfigMap(configMap, namespace string, clientSet kubernetes.Interface) (string, string, error)
• type GlobalConfig
• type Indexer
  • func (i *Indexer) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Job
  • func (j *Job) UnmarshalYAML(unmarshal func(interface{}) error) error
• type JobType
• type KubeClientProvider
  • func NewKubeClientProvider(config, context string) *KubeClientProvider
  • func (p *KubeClientProvider) ClientSet(QPS float32, burst int) (kubernetes.Interface, *rest.Config)
  • func (p *KubeClientProvider) DefaultClientSet() (kubernetes.Interface, *rest.Config)
• type Object
  • func (o *Object) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Spec
  • func Parse(uuid string, f io.Reader) (Spec, error)
• type WaitOptions

Functions

func FetchConfigMap

func FetchConfigMap(configMap, namespace string, clientSet kubernetes.Interface) (string, string, error)

FetchConfigMap Fetchs the specified configmap and looks for config.yml, metrics.yml and alerts.yml files

Types

type GlobalConfig

type GlobalConfig struct {
	// Benchmark UUID
	UUID string
	// Benchmark RUNID
	RUNID string
	// Measurements describes a list of measurements kube-burner
	// will take along with job
	Measurements []mtypes.Measurement `yaml:"measurements"`
	// RequestTimeout of restclient
	RequestTimeout time.Duration `yaml:"requestTimeout"`
	// GC garbage collect created namespaces
	GC bool `yaml:"gc" json:"gc"`
	// WaitWhenFinished Wait for pods to be running when all the jobs are completed
	WaitWhenFinished bool `yaml:"waitWhenFinished" json:"waitWhenFinished,omitempty"`
	// GCTimeout garbage collection timeout
	GCTimeout time.Duration `yaml:"gcTimeout"`
	// Boolean flag to collect metrics during garbage collection
	GCMetrics bool `yaml:"gcMetrics"`
	// Boolean flag to check for cluster-health
	ClusterHealth bool `yaml:"clusterHealth"`
}

GlobalConfig holds the global configuration

type Indexer

type Indexer struct {
	indexers.IndexerConfig `yaml:",inline"`
}

func (*Indexer) UnmarshalYAML

func (i *Indexer) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals YAML data into the Indexer struct.

type Job

type Job struct {
	// IterationCount how many times to execute the job
	JobIterations int `yaml:"jobIterations" json:"jobIterations,omitempty"`
	// IterationDelay how much time to wait between each job iteration
	JobIterationDelay time.Duration `yaml:"jobIterationDelay" json:"jobIterationDelay,omitempty"`
	// JobPause how much time to pause after finishing the job
	JobPause time.Duration `yaml:"jobPause" json:"jobPause,omitempty"`
	// BeforeCleanup allows to run a bash script before the workload is deleted.
	BeforeCleanup string `yaml:"beforeCleanup" json:"beforeCleanup,omitempty"`
	// Name job name
	Name string `yaml:"name" json:"name,omitempty"`
	// Objects list of objects
	Objects []Object `yaml:"objects" json:"-"`
	// JobType type of job
	JobType JobType `yaml:"jobType" json:"jobType,omitempty"`
	// Max number of queries per second
	QPS float32 `yaml:"qps" json:"qps,omitempty"`
	// Maximum burst for throttle
	Burst int `yaml:"burst" json:"burst,omitempty"`
	// Namespace namespace base name to use
	Namespace string `yaml:"namespace" json:"namespace,omitempty"`
	// MaxWaitTimeout maximum wait period
	MaxWaitTimeout time.Duration `yaml:"maxWaitTimeout" json:"maxWaitTimeout,omitempty"`
	// WaitForDeletion wait for objects to be definitively deleted
	WaitForDeletion bool `yaml:"waitForDeletion" json:"waitForDeletion,omitempty"`
	// PodWait wait for all pods to be running before moving forward to the next iteration
	PodWait bool `yaml:"podWait" json:"podWait,omitempty"`
	// WaitWhenFinished Wait for pods to be running when all job iterations are completed
	WaitWhenFinished bool `yaml:"waitWhenFinished" json:"waitWhenFinished,omitempty"`
	// Cleanup clean up old namespaces
	Cleanup bool `yaml:"cleanup" json:"cleanup,omitempty"`
	// NamespacedIterations create a namespace per job iteration
	NamespacedIterations bool `yaml:"namespacedIterations" json:"namespacedIterations,omitempty"`
	// IterationsPerNamespace is the modulus to apply to job iterations to calculate . Default 1
	IterationsPerNamespace int `yaml:"iterationsPerNamespace" json:"iterationsPerNamespace,omitempty"`
	// VerifyObjects verify object count after running the job
	VerifyObjects bool `yaml:"verifyObjects" json:"verifyObjects,omitempty"`
	// ErrorOnVerify exit when verification fails
	ErrorOnVerify bool `yaml:"errorOnVerify" json:"errorOnVerify,omitempty"`
	// PreLoadImages enables pulling all images before running the job
	PreLoadImages bool `yaml:"preLoadImages" json:"preLoadImages,omitempty"`
	// PreLoadPeriod determines the duration of the preload stage
	PreLoadPeriod time.Duration `yaml:"preLoadPeriod" json:"preLoadPeriod,omitempty"`
	// PreLoadNodeLabels add node selector labels to resources in preload stage
	PreLoadNodeLabels map[string]string `yaml:"preLoadNodeLabels" json:"-"`
	// NamespaceLabels add custom labels to namespaces created by kube-burner
	NamespaceLabels map[string]string `yaml:"namespaceLabels" json:"-"`
	// NamespaceAnnotations add custom annotations to namespaces created by kube-burner
	NamespaceAnnotations map[string]string `yaml:"namespaceAnnotations" json:"-"`
	// Churn workload
	Churn bool `yaml:"churn" json:"churn,omitempty"`
	// Churn cycles
	ChurnCycles int `yaml:"churnCycles" json:"churnCycles,omitempty"`
	// Churn percentage
	ChurnPercent int `yaml:"churnPercent" json:"churnPercent,omitempty"`
	// Churn duration
	ChurnDuration time.Duration `yaml:"churnDuration" json:"churnDuration,omitempty"`
	// Churn delay between sets
	ChurnDelay time.Duration `yaml:"churnDelay" json:"churnDelay,omitempty"`
	// Churn deletion strategy
	ChurnDeletionStrategy string `yaml:"churnDeletionStrategy" json:"churnDeletionStrategy,omitempty"`
	// Skip this job from indexing
	SkipIndexing bool `yaml:"skipIndexing" json:"skipIndexing,omitempty"`
}

Job defines a kube-burner job

func (*Job) UnmarshalYAML

func (j *Job) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements Unmarshaller to customize job defaults

type JobType

type JobType string

JobType type of job

const (
	// CreationJob used to create objects
	CreationJob JobType = "create"
	// DeletionJob used to delete objects
	DeletionJob JobType = "delete"
	// PatchJob used to patch objects
	PatchJob JobType = "patch"
	// ReadJob used to read objects
	ReadJob JobType = "read"
)

type KubeClientProvider

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

func NewKubeClientProvider

func NewKubeClientProvider(config, context string) *KubeClientProvider

func (*KubeClientProvider) ClientSet

func (p *KubeClientProvider) ClientSet(QPS float32, burst int) (kubernetes.Interface, *rest.Config)

func (*KubeClientProvider) DefaultClientSet

func (p *KubeClientProvider) DefaultClientSet() (kubernetes.Interface, *rest.Config)

type Object

type Object struct {
	// ObjectTemplate path to a valid YAML definition of a k8s resource
	ObjectTemplate string `yaml:"objectTemplate" json:"objectTemplate,omitempty"`
	// Replicas number of replicas to create of the given object
	Replicas int `yaml:"replicas" json:"replicas,omitempty"`
	// InputVars contains a map of arbitrary input variables
	// that can be introduced by users
	InputVars map[string]interface{} `yaml:"inputVars" json:"inputVars,omitempty"`
	// Kind object kind to delete
	Kind string `yaml:"kind" json:"kind,omitempty"`
	// The type of patch mode
	PatchType string `yaml:"patchType" json:"patchType,omitempty"`
	// APIVersion apiVersion of the object to remove
	APIVersion string `yaml:"apiVersion" json:"apiVersion,omitempty"`
	// LabelSelector objects with this labels will be removed
	LabelSelector map[string]string `yaml:"labelSelector" json:"labelSelector,omitempty"`
	// Namespaced this object is namespaced
	Namespaced bool `yaml:"-" json:"-"`
	// Wait for resource to be ready, it doesn't apply to all resources
	Wait bool `yaml:"wait" json:"wait"`
	// WaitOptions define custom behaviors when waiting for objects creation
	WaitOptions WaitOptions `yaml:"waitOptions" json:"waitOptions,omitempty"`
	// Run Once to create the object only once incase of multiple iterative jobs
	RunOnce bool `yaml:"runOnce" json:"runOnce,omitempty"`
}

Object defines an object that kube-burner will create

func (*Object) UnmarshalYAML

func (o *Object) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements Unmarshaller to customize object defaults

type Spec

type Spec struct {
	// List of kube-burner indexers
	Indexers []Indexer `yaml:"indexers"`
	// GlobalConfig defines global configuration parameters
	GlobalConfig GlobalConfig `yaml:"global"`
	// Jobs list of kube-burner jobs
	Jobs []Job `yaml:"jobs"`
	// EmbedFS embed filesystem instance
	EmbedFS embed.FS
	// EmbedFSDir Directory in which the configuration files are in the embed filesystem
	EmbedFSDir string
}

Spec configuration root

func Parse

func Parse(uuid string, f io.Reader) (Spec, error)

Parse parses a configuration file

type WaitOptions

type WaitOptions struct {
	// ForCondition wait for this condition to become true
	ForCondition string `yaml:"forCondition" json:"forCondition,omitempty"`
}