Documentation
¶
Index ¶
- Constants
- type ConfigurationChainBuilder
- type ConfigurationChecksumConfigurator
- type Configurator
- func NewBackfillConfigurator(value bool) Configurator
- func NewEnvironmentConfigurator(baseObject any, environmentKey string) Configurator
- func NewMetadataConfigurator(streamId string, streamKind string) Configurator
- func NewNameConfigurator(name string) Configurator
- func NewNamespaceConfigurator(namespace string) Configurator
- func NewOwnerConfigurator(ownerRef metav1.OwnerReference) Configurator
- func NewSecretReferenceConfigurator(referenceFieldName string, sd SecretReferenceProvider) Configurator
- type ConfiguratorProvider
- type SecretReferenceProvider
Constants ¶
const BackfillLabel = "arcane/backfilling"
BackfillLabel is the label key used to indicate if a Job is a backfill.
const ConfigurationHashAnnotation = "configuration-hash"
ConfigurationHashAnnotation is the annotation key used to store the configuration hash of a Job.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConfigurationChainBuilder ¶
type ConfigurationChainBuilder struct {
// contains filtered or unexported fields
}
func NewConfiguratorChainBuilder ¶
func NewConfiguratorChainBuilder() *ConfigurationChainBuilder
func (*ConfigurationChainBuilder) Build ¶
func (b *ConfigurationChainBuilder) Build() Configurator
func (*ConfigurationChainBuilder) ConfigureJob ¶
func (b *ConfigurationChainBuilder) ConfigureJob(job *batchv1.Job) error
func (*ConfigurationChainBuilder) WithConfigurator ¶
func (b *ConfigurationChainBuilder) WithConfigurator(configurator Configurator) *ConfigurationChainBuilder
type ConfigurationChecksumConfigurator ¶
type ConfigurationChecksumConfigurator struct {
// contains filtered or unexported fields
}
ConfigurationChecksumConfigurator sets the configuration checksum annotation on a job.
func NewConfigurationChecksumConfigurator ¶
func NewConfigurationChecksumConfigurator(configurationChecksum string) *ConfigurationChecksumConfigurator
NewConfigurationChecksumConfigurator creates a new ConfigurationChecksumConfigurator.
func (*ConfigurationChecksumConfigurator) ConfigureJob ¶
func (c *ConfigurationChecksumConfigurator) ConfigureJob(job *batchv1.Job) error
ConfigureJob sets the configuration checksum annotation on the job.
type Configurator ¶
type Configurator interface {
// ConfigureJob modifies the provided Job object according to the configurator's logic.
ConfigureJob(job *batchv1.Job) error
}
Configurator defines an interface for configuring Kubernetes Jobs. Each implementer can modify the Job object and chain to the next configurator in the sequence.
func NewBackfillConfigurator ¶
func NewBackfillConfigurator(value bool) Configurator
func NewEnvironmentConfigurator ¶
func NewEnvironmentConfigurator(baseObject any, environmentKey string) Configurator
func NewMetadataConfigurator ¶
func NewMetadataConfigurator(streamId string, streamKind string) Configurator
func NewNameConfigurator ¶
func NewNameConfigurator(name string) Configurator
func NewNamespaceConfigurator ¶
func NewNamespaceConfigurator(namespace string) Configurator
func NewOwnerConfigurator ¶
func NewOwnerConfigurator(ownerRef metav1.OwnerReference) Configurator
func NewSecretReferenceConfigurator ¶
func NewSecretReferenceConfigurator(referenceFieldName string, sd SecretReferenceProvider) Configurator
type ConfiguratorProvider ¶
type ConfiguratorProvider interface {
// JobConfigurator returns a JobConfigurator for the current instance.
JobConfigurator() (Configurator, error)
}
ConfiguratorProvider defines an interface for types that can provide a JobConfigurator.
type SecretReferenceProvider ¶
type SecretReferenceProvider interface {
// GetReferenceForSecret retrieves a LocalObjectReference for the specified secret name.
GetReferenceForSecret(name string) (*corev1.LocalObjectReference, error)
}
SecretReferenceProvider defines an interface for types that can provide a reference to a Kubernetes Secret.
Source Files
¶
- backfill_configurator.go
- configuration_checksum_configurator.go
- configurator.go
- configurator_chain_builder.go
- configurator_provider.go
- metadata_configurator.go
- name_configurator.go
- namespace_configurator.go
- owner_configurator.go
- secret_reference_configurator.go
- secret_reference_provider.go
- stream_context_configurator.go