Documentation
¶
Index ¶
- type Config
- func (c Config) GetExecutor() *apiv1.Container
- func (c Config) GetPodGCDeleteDelayDuration() time.Duration
- func (c Config) GetResourceRateLimit() ResourceRateLimit
- func (c *Config) Sanitize(allowedProtocol []string) error
- func (c Config) ValidateProtocol(inputProtocol string, allowedProtocol []string) error
- type ConnectionPool
- type Controller
- type DatabaseConfig
- type Image
- type KubeConfig
- type MetricModifier
- type MetricsConfig
- type MetricsTemporality
- type MySQLConfig
- type NodeEvents
- type PersistConfig
- type PodSpecLogStrategy
- type PostgreSQLConfig
- type RBACConfig
- type ResourceRateLimit
- type RetentionPolicy
- type SSOConfig
- type TTL
- type TemplateReferencing
- type WorkflowEvents
- type WorkflowRestrictions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// NodeEvents configures how node events are emitted
NodeEvents NodeEvents `json:"nodeEvents,omitempty"`
// WorkflowEvents configures how workflow events are emitted
WorkflowEvents WorkflowEvents `json:"workflowEvents,omitempty"`
// Executor holds container customizations for the executor to use when running pods
Executor *apiv1.Container `json:"executor,omitempty"`
// MainContainer holds container customization for the main container
MainContainer *apiv1.Container `json:"mainContainer,omitempty"`
// KubeConfig specifies a kube config file for the wait & init containers
KubeConfig *KubeConfig `json:"kubeConfig,omitempty"`
// ArtifactRepository contains the default location of an artifact repository for container artifacts
ArtifactRepository wfv1.ArtifactRepository `json:"artifactRepository,omitempty"`
// Namespace is a label selector filter to limit the controller's watch to a specific namespace
Namespace string `json:"namespace,omitempty"`
// InstanceID is a label selector to limit the controller's watch to a specific instance. It
// contains an arbitrary value that is carried forward into its pod labels, under the key
// workflows.argoproj.io/controller-instanceid, for the purposes of workflow segregation. This
// enables a controller to only receive workflow and pod events that it is interested about,
// in order to support multiple controllers in a single cluster, and ultimately allows the
// controller itself to be bundled as part of a higher level application. If omitted, the
// controller watches workflows and pods that *are not* labeled with an instance id.
InstanceID string `json:"instanceID,omitempty"`
// MetricsConfig specifies configuration for metrics emission. Metrics are enabled and emitted on localhost:9090/metrics
// by default.
MetricsConfig MetricsConfig `json:"metricsConfig,omitempty"`
// TelemetryConfig specifies configuration for telemetry emission. Telemetry is enabled and emitted in the same endpoint
// as metrics by default, but can be overridden using this config.
TelemetryConfig MetricsConfig `json:"telemetryConfig,omitempty"`
// Parallelism limits the max total parallel workflows that can execute at the same time
Parallelism int `json:"parallelism,omitempty"`
// NamespaceParallelism limits the max workflows that can execute at the same time in a namespace
NamespaceParallelism int `json:"namespaceParallelism,omitempty"`
// ResourceRateLimit limits the rate at which pods are created
ResourceRateLimit *ResourceRateLimit `json:"resourceRateLimit,omitempty"`
// Persistence contains the workflow persistence DB configuration
Persistence *PersistConfig `json:"persistence,omitempty"`
// Links to related apps.
Links []*wfv1.Link `json:"links,omitempty"`
// Columns are custom columns that will be exposed in the Workflow List View.
Columns []*wfv1.Column `json:"columns,omitempty"`
// WorkflowDefaults are values that will apply to all Workflows from this controller, unless overridden on the Workflow-level
WorkflowDefaults *wfv1.Workflow `json:"workflowDefaults,omitempty"`
// PodSpecLogStrategy enables the logging of podspec on controller log.
PodSpecLogStrategy PodSpecLogStrategy `json:"podSpecLogStrategy,omitempty"`
// PodGCGracePeriodSeconds specifies the duration in seconds before a terminating pod is forcefully killed.
// Value must be non-negative integer. A zero value indicates that the pod will be forcefully terminated immediately.
// Defaults to the Kubernetes default of 30 seconds.
PodGCGracePeriodSeconds *int64 `json:"podGCGracePeriodSeconds,omitempty"`
// PodGCDeleteDelayDuration specifies the duration before pods in the GC queue get deleted.
// Value must be non-negative. A zero value indicates that the pods will be deleted immediately.
// Defaults to 5 seconds.
PodGCDeleteDelayDuration *metav1.Duration `json:"podGCDeleteDelayDuration,omitempty"`
// WorkflowRestrictions restricts the controller to executing Workflows that meet certain restrictions
WorkflowRestrictions *WorkflowRestrictions `json:"workflowRestrictions,omitempty"`
// Adds configurable initial delay (for K8S clusters with mutating webhooks) to prevent workflow getting modified by MWC.
InitialDelay metav1.Duration `json:"initialDelay,omitempty"`
// The command/args for each image, needed when the command is not specified and the emissary executor is used.
// https://argo-workflows.readthedocs.io/en/latest/workflow-executors/#emissary-emissary
Images map[string]Image `json:"images,omitempty"`
// Workflow retention by number of workflows
RetentionPolicy *RetentionPolicy `json:"retentionPolicy,omitempty"`
NavColor string `json:"navColor,omitempty"`
// SSO in settings for single-sign on
SSO SSOConfig `json:"sso,omitempty"`
}
Config contains the configuration settings for the workflow controller
func (Config) GetExecutor ¶ added in v3.3.0
func (Config) GetPodGCDeleteDelayDuration ¶ added in v3.2.0
func (Config) GetResourceRateLimit ¶ added in v3.1.0
func (c Config) GetResourceRateLimit() ResourceRateLimit
type ConnectionPool ¶
type Controller ¶
func NewController ¶
func NewController(namespace, name string, kubeclientset kubernetes.Interface) Controller
type DatabaseConfig ¶
type DatabaseConfig struct {
Host string `json:"host"`
Port int `json:"port,omitempty"`
Database string `json:"database"`
TableName string `json:"tableName,omitempty"`
UsernameSecret apiv1.SecretKeySelector `json:"userNameSecret,omitempty"`
PasswordSecret apiv1.SecretKeySelector `json:"passwordSecret,omitempty"`
}
func (DatabaseConfig) GetHostname ¶
func (c DatabaseConfig) GetHostname() string
type KubeConfig ¶
type KubeConfig struct {
// SecretName of the kubeconfig secret
// may not be empty if kuebConfig specified
SecretName string `json:"secretName"`
// SecretKey of the kubeconfig in the secret
// may not be empty if kubeConfig specified
SecretKey string `json:"secretKey"`
// VolumeName of kubeconfig, default to 'kubeconfig'
VolumeName string `json:"volumeName,omitempty"`
// MountPath of the kubeconfig secret, default to '/kube/config'
MountPath string `json:"mountPath,omitempty"`
}
KubeConfig is used for wait & init sidecar containers to communicate with a k8s apiserver by a outofcluster method, it is used when the workflow controller is in a different cluster with the workflow workloads
type MetricModifier ¶ added in v3.6.0
type MetricModifier struct {
// Disabled disables the emission of this metric completely
Disabled bool `json:"disabled,omitempty"`
// DisabledAttributes lists labels for this metric to remove that attributes to save on cardinality
DisabledAttributes []string `json:"disabledAttributes"`
// HistogramBuckets allow configuring of the buckets used in a histogram
// Has no effect on non-histogram buckets
HistogramBuckets []float64 `json:"histogramBuckets,omitempty"`
}
MetricModifier are modifiers for an individual named metric to change their behaviour
type MetricsConfig ¶
type MetricsConfig struct {
// Enabled controls metric emission. Default is true, set "enabled: false" to turn off
Enabled *bool `json:"enabled,omitempty"`
// DisableLegacy turns off legacy metrics
// DEPRECATED: Legacy metrics are now removed, this field is ignored
DisableLegacy bool `json:"disableLegacy,omitempty"`
// MetricsTTL sets how often custom metrics are cleared from memory
MetricsTTL TTL `json:"metricsTTL,omitempty"`
// Path is the path where metrics are emitted. Must start with a "/". Default is "/metrics"
Path string `json:"path,omitempty"`
// Port is the port where metrics are emitted. Default is "9090"
Port int `json:"port,omitempty"`
// IgnoreErrors is a flag that instructs prometheus to ignore metric emission errors
IgnoreErrors bool `json:"ignoreErrors,omitempty"`
// Secure is a flag that starts the metrics servers using TLS, defaults to true
Secure *bool `json:"secure,omitempty"`
// Modifiers configure metrics by name
Modifiers map[string]MetricModifier `json:"modifiers,omitempty"`
// Temporality of the OpenTelemetry metrics.
// Enum of Cumulative or Delta, defaulting to Cumulative.
// No effect on Prometheus metrics, which are always Cumulative.
Temporality MetricsTemporality `json:"temporality,omitempty"`
}
MetricsConfig defines a config for a metrics server
func (*MetricsConfig) GetSecure ¶ added in v3.3.0
func (mc *MetricsConfig) GetSecure(defaultValue bool) bool
func (*MetricsConfig) GetTemporality ¶ added in v3.6.0
func (mc *MetricsConfig) GetTemporality() metricsdk.TemporalitySelector
type MetricsTemporality ¶ added in v3.6.0
type MetricsTemporality string
const ( MetricsTemporalityCumulative MetricsTemporality = "Cumulative" MetricsTemporalityDelta MetricsTemporality = "Delta" )
type MySQLConfig ¶
type MySQLConfig struct {
DatabaseConfig
Options map[string]string `json:"options,omitempty"`
}
type NodeEvents ¶
type NodeEvents struct {
Enabled *bool `json:"enabled,omitempty"`
SendAsPod bool `json:"sendAsPod,omitempty"`
}
func (NodeEvents) IsEnabled ¶
func (e NodeEvents) IsEnabled() bool
type PersistConfig ¶
type PersistConfig struct {
NodeStatusOffload bool `json:"nodeStatusOffLoad,omitempty"`
// Archive workflows to persistence.
Archive bool `json:"archive,omitempty"`
// ArchivelabelSelector holds LabelSelector to determine workflow persistence.
ArchiveLabelSelector *metav1.LabelSelector `json:"archiveLabelSelector,omitempty"`
// in days
ArchiveTTL TTL `json:"archiveTTL,omitempty"`
ClusterName string `json:"clusterName,omitempty"`
ConnectionPool *ConnectionPool `json:"connectionPool,omitempty"`
PostgreSQL *PostgreSQLConfig `json:"postgresql,omitempty"`
MySQL *MySQLConfig `json:"mysql,omitempty"`
SkipMigration bool `json:"skipMigration,omitempty"`
}
func (PersistConfig) GetArchiveLabelSelector ¶
func (c PersistConfig) GetArchiveLabelSelector() (labels.Selector, error)
func (PersistConfig) GetClusterName ¶
func (c PersistConfig) GetClusterName() string
type PodSpecLogStrategy ¶
type PodSpecLogStrategy struct {
FailedPod bool `json:"failedPod,omitempty"`
AllPods bool `json:"allPods,omitempty"`
}
PodSpecLogStrategy contains the configuration for logging the pod spec in controller log for debugging purpose
type PostgreSQLConfig ¶
type PostgreSQLConfig struct {
DatabaseConfig
SSL bool `json:"ssl,omitempty"`
SSLMode string `json:"sslMode,omitempty"`
}
type RBACConfig ¶ added in v3.4.0
type RBACConfig struct {
Enabled bool `json:"enabled,omitempty"`
}
func (*RBACConfig) IsEnabled ¶ added in v3.4.0
func (c *RBACConfig) IsEnabled() bool
type ResourceRateLimit ¶ added in v3.1.0
type RetentionPolicy ¶ added in v3.3.0
type RetentionPolicy struct {
Completed int `json:"completed,omitempty"`
Failed int `json:"failed,omitempty"`
Errored int `json:"errored,omitempty"`
}
Workflow retention by number of workflows
type SSOConfig ¶ added in v3.4.0
type SSOConfig struct {
Issuer string `json:"issuer"`
IssuerAlias string `json:"issuerAlias,omitempty"`
ClientID apiv1.SecretKeySelector `json:"clientId"`
ClientSecret apiv1.SecretKeySelector `json:"clientSecret"`
RedirectURL string `json:"redirectUrl"`
RBAC *RBACConfig `json:"rbac,omitempty"`
// additional scopes (on top of "openid")
Scopes []string `json:"scopes,omitempty"`
SessionExpiry metav1.Duration `json:"sessionExpiry,omitempty"`
// customGroupClaimName will override the groups claim name
CustomGroupClaimName string `json:"customGroupClaimName,omitempty"`
UserInfoPath string `json:"userInfoPath,omitempty"`
InsecureSkipVerify bool `json:"insecureSkipVerify,omitempty"`
FilterGroupsRegex []string `json:"filterGroupsRegex,omitempty"`
}
func (SSOConfig) GetSessionExpiry ¶ added in v3.4.0
type TTL ¶
time.Duration forces you to specify in millis, and does not support days see https://stackoverflow.com/questions/48050945/how-to-unmarshal-json-into-durations
func (TTL) MarshalJSON ¶
func (*TTL) UnmarshalJSON ¶
type TemplateReferencing ¶
type TemplateReferencing string
const ( TemplateReferencingStrict TemplateReferencing = "Strict" TemplateReferencingSecure TemplateReferencing = "Secure" )
type WorkflowEvents ¶ added in v3.6.0
type WorkflowEvents struct {
Enabled *bool `json:"enabled,omitempty"`
}
func (WorkflowEvents) IsEnabled ¶ added in v3.6.0
func (e WorkflowEvents) IsEnabled() bool
type WorkflowRestrictions ¶
type WorkflowRestrictions struct {
TemplateReferencing TemplateReferencing `json:"templateReferencing,omitempty"`
}
func (*WorkflowRestrictions) MustNotChangeSpec ¶
func (req *WorkflowRestrictions) MustNotChangeSpec() bool
func (*WorkflowRestrictions) MustUseReference ¶
func (req *WorkflowRestrictions) MustUseReference() bool