trait

package
v2.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 29, 2024 License: Apache-2.0 Imports: 94 Imported by: 0

Documentation

Overview

Package trait contains implementations of all available traits (features)

Index

Constants

View Source 
const (
	// TraitOrderBeforeControllerCreation can be used to inject configuration such as properties and environment variables
	// into the running integration, before the actual controller is created.
	TraitOrderBeforeControllerCreation = 850
	// TraitOrderControllerSelection can be used if you intend to provide an alternative controller for the integration
	// (e.g. Deployment, CronJob, ...).
	TraitOrderControllerSelection = 950
	// TraitOrderPostProcessResources is executed after all other traits are executed (except for important core traits such as
	// the "owner" trait), so it can be used to post-process generated resources before their actual creation.
	TraitOrderPostProcessResources = 2450
)

A list of named orders, useful for correctly binding addons.

View Source 
const (
	CamelPropertiesType = "camel-properties"
)
View Source 
const KameletBundleType = "kamelets-bundle"
View Source 
const (
	KameletLocationProperty = "camel.component.kamelet.location"
)
View Source 
const (
	QuarkusNativeDefaultBaseImageName = "quay.io/quarkus/quarkus-micro-image:2.0"
)
View Source 
const (
	TraitConfigurationReason = "TraitConfiguration"
)

Variables

View Source 
var FactoryList []Factory

FactoryList contains the default list of trait Factory.

Functions

func AddToTraits 

func AddToTraits(factory Factory)

AddToTraits registers a trait Factory.

func AssertTraitsType 

func AssertTraitsType(traits interface{}) error

AssertTraitsType asserts that traits is either v1.Traits or v1.IntegrationKitTraits. This function is provided because Go doesn't have Either nor union types.

func CapabilityPropertyKey added in v2.3.0 

func CapabilityPropertyKey(camelPropertyKey string, vars map[string]string) string

CapabilityPropertyKey returns the key or expand any variable provided in it. vars variable contain the possible dynamic values to use.

func ConfigureTraits added in v2.4.0 

func ConfigureTraits(options []string, traits interface{}, catalog Finder) error

func Equals 

func Equals(i1 Options, i2 Options) bool

Equals return if traits are the same.

func ExtractAndMaybeDeleteTraits added in v2.4.0 

func ExtractAndMaybeDeleteTraits(c client.Client, annotations map[string]string, del bool) (*v1.Traits, error)

ExtractAndDeleteTraits will extract the annotation traits into v1.Traits struct, removing from the value from the input map.

func ExtractSourceLoaderDependencies added in v2.5.0 

func ExtractSourceLoaderDependencies(source v1.SourceSpec, catalog *camel.RuntimeCatalog) *sets.Set

ExtractSourceLoaderDependencies extracts dependencies from source.

func HasMatchingTraits added in v2.3.0 

func HasMatchingTraits(traitMap Options, kitTraitMap Options) (bool, error)

HasMatchingTraits verifies if two traits options match.

func IntegrationAndKameletBindingSameTraits 

func IntegrationAndKameletBindingSameTraits(c client.Client, i1 *v1.Integration, i2 *v1alpha1.KameletBinding) (bool, error)

IntegrationAndKameletBindingSameTraits return if traits are the same. The comparison is done for the subset of traits defines on the binding as during the trait processing, some traits may be added to the Integration i.e. knative configuration in case of sink binding. Deprecated.

func IntegrationAndPipeSameTraits 

func IntegrationAndPipeSameTraits(c client.Client, i1 *v1.Integration, i2 *v1.Pipe) (bool, error)

IntegrationAndPipeSameTraits return if traits are the same. The comparison is done for the subset of traits defines on the binding as during the trait processing, some traits may be added to the Integration i.e. knative configuration in case of sink binding.

func IntegrationsHaveSameTraits 

func IntegrationsHaveSameTraits(c client.Client, i1 *v1.Integration, i2 *v1.Integration) (bool, error)

IntegrationsHaveSameTraits return if traits are the same.

func KameletBindingsHaveSameTraits 

func KameletBindingsHaveSameTraits(c client.Client, i1 *v1alpha1.KameletBinding, i2 *v1alpha1.KameletBinding) (bool, error)

KameletBindingsHaveSameTraits return if traits are the same. Deprecated.

func MigrateLegacyConfiguration 

func MigrateLegacyConfiguration(trait map[string]interface{}) error

MigrateLegacyConfiguration moves up the legacy configuration in a trait to the new top-level properties. Values of the new properties always take precedence over the ones from the legacy configuration with the same property names.

func ParseAndCreateVolume added in v2.5.0 

func ParseAndCreateVolume(e *Environment, item string) (*corev1.Volume, *corev1.VolumeMount, error)

ParseAndCreateVolume will parse a volume configuration. If the volume does not exist it tries to create one based on the storage class configuration provided or default. item is expected to be as: name:path/to/mount<:size:accessMode<:storageClassName>>.

func ParseEmptyDirVolume added in v2.5.0 

func ParseEmptyDirVolume(item string) (*corev1.Volume, *corev1.VolumeMount, error)

ParseEmptyDirVolume will parse and return an empty-dir volume.

func PipesHaveSameTraits 

func PipesHaveSameTraits(c client.Client, i1 *v1.Pipe, i2 *v1.Pipe) (bool, error)

PipesHaveSameTraits return if traits are the same.

func ToAddonTrait 

func ToAddonTrait(t *testing.T, config map[string]interface{}) v1.AddonTrait

func ToPropertyMap 

func ToPropertyMap(trait interface{}) (map[string]interface{}, error)

ToPropertyMap accepts a trait and converts it to a map of trait properties.

func ToTrait 

func ToTrait(trait map[string]interface{}, target interface{}) error

ToTrait unmarshals a map configuration to a target trait.

func ValidateTrait added in v2.4.0 

func ValidateTrait(catalog *Catalog, trait string) error

func ValidateTraits added in v2.4.0 

func ValidateTraits(catalog *Catalog, traits []string) error

Types

type BasePlatformTrait added in v2.1.0 

type BasePlatformTrait struct {
	BaseTrait
}

BasePlatformTrait is the root for platform traits with noop implementations for hooks.

func NewBasePlatformTrait added in v2.1.0 

func NewBasePlatformTrait(id string, order int) BasePlatformTrait

func (*BasePlatformTrait) IsPlatformTrait added in v2.1.0 

func (trait *BasePlatformTrait) IsPlatformTrait() bool

IsPlatformTrait marks all fundamental traits that allow the platform to work.

type BaseTrait 

type BaseTrait struct {
	TraitID        ID            `json:"-"`
	Client         client.Client `json:"-"`
	ExecutionOrder int           `json:"-"`
	L              log.Logger    `json:"-"`
}

BaseTrait is the root trait with noop implementations for hooks.

func NewBaseTrait 

func NewBaseTrait(id string, order int) BaseTrait

func (*BaseTrait) ID 

func (trait *BaseTrait) ID() ID

ID returns the identifier of the trait.

func (*BaseTrait) InfluencesKit 

func (trait *BaseTrait) InfluencesKit() bool

InfluencesKit determines if the trait has any influence on Integration Kits.

func (*BaseTrait) InjectClient 

func (trait *BaseTrait) InjectClient(c client.Client)

InjectClient implements client.ClientInject and allows to inject a client into the trait.

func (*BaseTrait) IsAllowedInProfile 

func (trait *BaseTrait) IsAllowedInProfile(v1.TraitProfile) bool

IsAllowedInProfile returns true for any profile by default.

func (*BaseTrait) IsPlatformTrait 

func (trait *BaseTrait) IsPlatformTrait() bool

IsPlatformTrait marks all fundamental traits that allow the platform to work.

func (*BaseTrait) Order 

func (trait *BaseTrait) Order() int

Order contains the order value provided during initialization.

func (*BaseTrait) RequiresIntegrationPlatform 

func (trait *BaseTrait) RequiresIntegrationPlatform() bool

RequiresIntegrationPlatform indicates that the trait cannot work without an integration platform set.

type Catalog 

type Catalog struct {
	L log.Logger
	// contains filtered or unexported fields
}

Catalog collects all information about traits in one place.

func NewCatalog 

func NewCatalog(c client.Client) *Catalog

NewCatalog creates a new trait Catalog.

func (*Catalog) AllTraits 

func (c *Catalog) AllTraits() []Trait

func (*Catalog) Configure 

func (c *Catalog) Configure(env *Environment) error

Configure reads trait configurations from environment and applies them to catalog.

func (*Catalog) GetTrait 

func (c *Catalog) GetTrait(id string) Trait

GetTrait returns the trait with the given ID.

func (*Catalog) TraitsForProfile 

func (c *Catalog) TraitsForProfile(profile v1.TraitProfile) []Trait

TraitsForProfile returns all traits associated with a given profile.

Traits may depend on the result of previously executed ones, so care must be taken while changing the lists order.

type Comparable 

type Comparable interface {
	Matches(trait Trait) bool
}

Comparable is the interface exposing comparable funcs.

type ComparableTrait 

type ComparableTrait interface {
	Trait
	Comparable
}

ComparableTrait is the interface used to compare two traits between them.

type ControllerStrategy 

type ControllerStrategy string

ControllerStrategy is used to determine the kind of controller that needs to be created for the integration. 

const (
	ControllerStrategyDeployment     ControllerStrategy = "deployment"
	ControllerStrategyKnativeService ControllerStrategy = "knative-service"
	ControllerStrategyCronJob        ControllerStrategy = "cron-job"

	DefaultControllerStrategy = ControllerStrategyDeployment
)

List of controller strategies.

type ControllerStrategySelector 

type ControllerStrategySelector interface {
	// SelectControllerStrategy tells if the trait with current configuration can select a specific controller to use
	SelectControllerStrategy(env *Environment) (*ControllerStrategy, error)
	// ControllerStrategySelectorOrder returns the order (priority) of the controller strategy selector
	ControllerStrategySelectorOrder() int
}

ControllerStrategySelector is the interface for traits that can determine the kind of controller that will run the integration.

type Environment 

type Environment struct {
	CamelCatalog *camel.RuntimeCatalog
	Catalog      *Catalog
	// The Go standard context for the traits execution
	Ctx context.Context
	// The client to the API server
	Client client.Client
	// The active Platform
	Platform *v1.IntegrationPlatform
	// The active IntegrationProfile
	IntegrationProfile *v1.IntegrationProfile
	// The current Integration
	Integration *v1.Integration
	// The IntegrationKit associated to the Integration
	IntegrationKit *v1.IntegrationKit
	// The IntegrationKits to be created for the Integration
	IntegrationKits []v1.IntegrationKit
	// The resources owned by the Integration that are applied to the API server
	Resources             *kubernetes.Collection
	PostActions           []func(*Environment) error
	PostStepProcessors    []func(*Environment) error
	PostProcessors        []func(*Environment) error
	Pipeline              []v1.Task
	ConfiguredTraits      []Trait
	ExecutedTraits        []Trait
	EnvVars               []corev1.EnvVar
	ApplicationProperties map[string]string
}

An Environment provides the context for the execution of the traits.

func Apply 

func Apply(ctx context.Context, c client.Client, integration *v1.Integration, kit *v1.IntegrationKit) (*Environment, error)

func NewSyntheticEnvironment added in v2.3.0 

func NewSyntheticEnvironment(ctx context.Context, c client.Client, integration *v1.Integration, kit *v1.IntegrationKit) (*Environment, error)

NewSyntheticEnvironment creates an environment suitable for a synthetic Integration. If the application which generated the synthetic Integration has no longer the label, it will return a nil result.

func (*Environment) ConsumeMeta added in v2.5.0 

func (e *Environment) ConsumeMeta(originalSourcesOnly bool, consumeMeta func(metadata.IntegrationMetadata) bool) (bool, error)

ConsumeMeta is used to consume metadata information coming from Integration sources. If no sources available, would return false. When consuming from meta you should make sure that the configuration is stored in the status traits by setting each trait configuration when in "auto" mode. originalSourcesOnly flag indicates if you want to use only the sources provided originally to the Integration, otherwise it will consume all sources, also the one autogenerated by the operator.

func (*Environment) DetermineCatalogNamespace 

func (e *Environment) DetermineCatalogNamespace() string

func (*Environment) DetermineControllerStrategy 

func (e *Environment) DetermineControllerStrategy() (ControllerStrategy, error)

DetermineControllerStrategy determines the type of controller that should be used for the integration.

func (*Environment) DetermineProfile 

func (e *Environment) DetermineProfile() v1.TraitProfile

DetermineProfile determines the TraitProfile of the environment. First looking at the Integration.Spec for a Profile, next looking at the IntegrationKit.Spec and lastly the Platform Profile.

func (*Environment) GetIntegrationContainer 

func (e *Environment) GetIntegrationContainer() *corev1.Container

func (*Environment) GetIntegrationContainerName 

func (e *Environment) GetIntegrationContainerName() string

func (*Environment) GetIntegrationPodSpec 

func (e *Environment) GetIntegrationPodSpec() *corev1.PodSpec

GetIntegrationPodSpec return the Integration Template Pod Specification, regardless of the deployment strategy.

func (*Environment) GetTrait 

func (e *Environment) GetTrait(id ID) Trait

func (*Environment) InPhase 

func (e *Environment) InPhase(c v1.IntegrationKitPhase, i v1.IntegrationPhase) bool

func (*Environment) IntegrationInPhase 

func (e *Environment) IntegrationInPhase(phases ...v1.IntegrationPhase) bool

func (*Environment) IntegrationInRunningPhases 

func (e *Environment) IntegrationInRunningPhases() bool

func (*Environment) IntegrationKitInPhase 

func (e *Environment) IntegrationKitInPhase(phases ...v1.IntegrationKitPhase) bool

func (*Environment) PlatformInPhase 

func (e *Environment) PlatformInPhase(phases ...v1.IntegrationPlatformPhase) bool

type Factory 

type Factory = func() Trait

Factory is a generic factory for a trait.

type Finder 

type Finder interface {
	GetTrait(id string) Trait
}

type ID 

type ID string

ID uniquely identifies a trait.

type Identifiable 

type Identifiable interface {
	ID() ID
}

Identifiable represent an identifiable type.

type Options 

type Options map[string]map[string]interface{}

func NewSpecTraitsOptionsForIntegration added in v2.3.0 

func NewSpecTraitsOptionsForIntegration(c client.Client, i *v1.Integration) (Options, error)

func NewSpecTraitsOptionsForIntegrationAndPlatform added in v2.3.0 

func NewSpecTraitsOptionsForIntegrationAndPlatform(c client.Client, i *v1.Integration, pl *v1.IntegrationPlatform) (Options, error)

func NewSpecTraitsOptionsForIntegrationKit added in v2.3.0 

func NewSpecTraitsOptionsForIntegrationKit(c client.Client, i *v1.IntegrationKit) (Options, error)

func NewTraitsOptionsForKameletBinding 

func NewTraitsOptionsForKameletBinding(c client.Client, kb *v1alpha1.KameletBinding) (Options, error)

Deprecated.

func NewTraitsOptionsForPipe 

func NewTraitsOptionsForPipe(c client.Client, pipe *v1.Pipe) (Options, error)

func ToTraitMap 

func ToTraitMap(traits interface{}) (Options, error)

ToTraitMap accepts either v1.Traits or v1.IntegrationKitTraits and converts it to a map of traits.

func (Options) Get 

func (u Options) Get(id string) (map[string]interface{}, bool)

type Trait 

type Trait interface {
	Identifiable
	client.Injectable

	// Configure the trait
	Configure(environment *Environment) (bool, *TraitCondition, error)

	// Apply executes a customization of the Environment
	Apply(environment *Environment) error

	// InfluencesKit determines if the trait has any influence on Integration Kits
	InfluencesKit() bool

	// IsPlatformTrait marks all fundamental traits that allow the platform to work
	IsPlatformTrait() bool

	// RequiresIntegrationPlatform indicates that the trait cannot work without an integration platform set
	RequiresIntegrationPlatform() bool

	// IsAllowedInProfile tells if the trait supports the given profile
	IsAllowedInProfile(traitProfile v1.TraitProfile) bool

	// Order is the order in which the trait should be executed in the normal flow
	Order() int
}

Trait is the interface of all traits.

func NewInitTrait 

func NewInitTrait() Trait

func NewTelemetryTrait added in v2.5.0 

func NewTelemetryTrait() Trait

NewTelemetryTrait instance the telemetry trait as a BaseTrait capable to inject quarkus properties.

type TraitCondition added in v2.2.0 

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

TraitCondition is used to get all information/warning about a trait configuration. It should either use an IntegrationConditionType or IntegrationKitConditionType.

func NewIntegrationCondition added in v2.2.0 

func NewIntegrationCondition(traitID string, ict v1.IntegrationConditionType, cs corev1.ConditionStatus, reason, message string) *TraitCondition

func NewIntegrationConditionPlatformDisabledWithMessage added in v2.3.1 

func NewIntegrationConditionPlatformDisabledWithMessage(traitID string, message string) *TraitCondition

func NewIntegrationConditionUserDisabled added in v2.2.0 

func NewIntegrationConditionUserDisabled(traitID string) *TraitCondition

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.