config

Documentation

Index

• Constants
• type Config
  • func NewDefaultConfig() *Config
  • func (c *Config) SetConfigFromEnv() error
• type ControllerOptions
• type Controllers
• type KubeAPIOptions
• type ManagerOptions
• type PrometheusConfig
• type Step

Constants

const (

	// environment variable to hold vulnerability count limit
	VulnerabilityCountLimitEnvVar = "VULNERABILITY_COUNT_LIMIT"
)

Types

type Config

type Config struct {
	CtxTimeOut                       time.Duration
	GitContainerTemplate             Step
	ImageProcessingContainerTemplate Step
	BundleContainerTemplate          Step
	WaiterContainerTemplate          Step
	RemoteArtifactsContainerImage    string
	TerminationLogPath               string
	Prometheus                       PrometheusConfig
	ManagerOptions                   ManagerOptions
	Controllers                      Controllers
	KubeAPIOptions                   KubeAPIOptions
	GitRewriteRule                   bool
	VulnerabilityCountLimit          int
}

Config hosts different parameters that can be set to use on the Build controllers

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig returns a new Config, with context timeout and default Kaniko image.

func (*Config) SetConfigFromEnv

func (c *Config) SetConfigFromEnv() error

SetConfigFromEnv updates the configuration managed by environment variables.

type ControllerOptions

type ControllerOptions struct {
	MaxConcurrentReconciles int
}

ControllerOptions contains configurable options for a controller

type Controllers

type Controllers struct {
	Build                ControllerOptions
	BuildRun             ControllerOptions
	BuildStrategy        ControllerOptions
	ClusterBuildStrategy ControllerOptions
}

Controllers contains the options for the different controllers

type KubeAPIOptions

type KubeAPIOptions struct {
	QPS   int
	Burst int
}

KubeAPIOptions contains configurable options for the kube API client

type ManagerOptions

type ManagerOptions struct {
	LeaderElectionNamespace string
	LeaseDuration           *time.Duration
	RenewDeadline           *time.Duration
	RetryPeriod             *time.Duration
}

ManagerOptions contains configurable options for the Shipwright build controller manager

type PrometheusConfig

type PrometheusConfig struct {
	BuildRunCompletionDurationBuckets []float64
	BuildRunEstablishDurationBuckets  []float64
	BuildRunRampUpDurationBuckets     []float64
	EnabledLabels                     []string
}

PrometheusConfig contains the specific configuration for the

type Step

type Step struct {
	Args            []string                    `json:"args,omitempty"`
	Command         []string                    `json:"command,omitempty"`
	Env             []corev1.EnvVar             `json:"env,omitempty"`
	Image           string                      `json:"image,omitempty"`
	ImagePullPolicy corev1.PullPolicy           `json:"imagePullPolicy,omitempty"`
	Resources       corev1.ResourceRequirements `json:"resources,omitempty"`
	SecurityContext *corev1.SecurityContext     `json:"securityContext,omitempty"`
	WorkingDir      string                      `json:"workingDir,omitempty"`
}