adapter

package
Version: v0.28.0 Latest Latest
Warning

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

Go to latest
Published: Dec 13, 2021 License: Apache-2.0 Imports: 37 Imported by: 209

Documentation

Overview

Copyright 2020 The Knative Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source
const (
	EnvConfigComponent            = "K_COMPONENT"
	EnvConfigNamespace            = "NAMESPACE"
	EnvConfigName                 = "NAME"
	EnvConfigResourceGroup        = "K_RESOURCE_GROUP"
	EnvConfigSink                 = "K_SINK"
	EnvConfigCEOverrides          = "K_CE_OVERRIDES"
	EnvConfigMetricsConfig        = "K_METRICS_CONFIG"
	EnvConfigLoggingConfig        = "K_LOGGING_CONFIG"
	EnvConfigTracingConfig        = "K_TRACING_CONFIG"
	EnvConfigLeaderElectionConfig = "K_LEADER_ELECTION_CONFIG"
	EnvSinkTimeout                = "K_SINK_TIMEOUT"
)

Variables

This section is empty.

Functions

func ContextWithMetricTag

func ContextWithMetricTag(ctx context.Context, metric *MetricTag) context.Context

ContextWithMetricTag returns a copy of parent context in which the value associated with metric key is the supplied metric tag.

func GetSinkTimeout added in v0.18.1

func GetSinkTimeout(logger *zap.SugaredLogger) int

func IsHAEnabled added in v0.17.0

func IsHAEnabled(ctx context.Context) bool

IsHAEnabled checks the context for the desire to enable leader elector.

func IsInjectorEnabled added in v0.17.0

func IsInjectorEnabled(ctx context.Context) bool

IsInjectorEnabled checks the context for the desire to enable injectors TODO: deprecated.

func LeaderElectionComponentConfigToJSON added in v0.19.0

func LeaderElectionComponentConfigToJSON(cfg *kle.ComponentConfig) (string, error)

LeaderElectionComponentConfigToJSON converts a ComponentConfig to a json string.

func Main

func Main(component string, ector EnvConfigConstructor, ctor AdapterConstructor)

func MainMessageAdapter added in v0.15.0

func MainMessageAdapter(component string, ector EnvConfigConstructor, ctor MessageAdapterConstructor)

func MainMessageAdapterWithContext added in v0.15.0

func MainMessageAdapterWithContext(ctx context.Context, component string, ector EnvConfigConstructor, ctor MessageAdapterConstructor)

func MainWithContext

func MainWithContext(ctx context.Context, component string, ector EnvConfigConstructor, ctor AdapterConstructor)

func MainWithEnv added in v0.17.0

func MainWithEnv(ctx context.Context, component string, env EnvConfigAccessor, ctor AdapterConstructor)

func MainWithInformers added in v0.17.0

func MainWithInformers(ctx context.Context, component string, env EnvConfigAccessor, ctor AdapterConstructor)

func NewCloudEventsClient

func NewCloudEventsClient(target string, ceOverrides *duckv1.CloudEventOverrides, reporter source.StatsReporter) (cloudevents.Client, error)

NewCloudEventsClient returns a client that will apply the ceOverrides to outbound events and report outbound event counts.

func NewCloudEventsClientCRStatus added in v0.17.0

func NewCloudEventsClientCRStatus(env EnvConfigAccessor, reporter source.StatsReporter, crStatusEventClient *crstatusevent.CRStatusEventClient) (cloudevents.Client, error)

NewCloudEventsClientCRStatus returns a client CR status

func NewCloudEventsClientWithOptions added in v0.24.0

func NewCloudEventsClientWithOptions(ceOverrides *duckv1.CloudEventOverrides, reporter source.StatsReporter, opts ...http.Option) (cloudevents.Client, error)

NewCloudEventsClientWithOptions returns a client created with provided options

func SetupInformers added in v0.17.0

func SetupInformers(ctx context.Context, logger *zap.SugaredLogger) (context.Context, []controller.Informer)

func StartInformers added in v0.17.0

func StartInformers(ctx context.Context, informers []controller.Informer)

func WithController added in v0.18.0

func WithController(ctx context.Context, ctor ControllerConstructor) context.Context

WithController signals to MainWithContext that it should create and configure a controller notifying the adapter when a resource is ready and removed

func WithHAEnabled added in v0.17.0

func WithHAEnabled(ctx context.Context) context.Context

WithHAEnabled signals to MainWithContext that it should set up an appropriate leader elector for this component.

func WithInjectorEnabled added in v0.17.0

func WithInjectorEnabled(ctx context.Context) context.Context

WithInjectorEnabled signals to MainWithInjectors that it should try to run injectors. TODO: deprecated. Use WithController instead

Types

type Adapter

type Adapter interface {
	Start(ctx context.Context) error
}

Adapter is the interface receive adapters are expected to implement

type AdapterConstructor

type AdapterConstructor func(ctx context.Context, env EnvConfigAccessor, client cloudevents.Client) Adapter

type ControllerConstructor added in v0.18.0

type ControllerConstructor func(ctx context.Context, adapter Adapter) *controller.Impl

ControllerConstructor is the function signature for creating controllers synchronizing the multi-tenant receive adapter state

func ControllerFromContext added in v0.18.0

func ControllerFromContext(ctx context.Context) ControllerConstructor

ControllerFromContext gets the controller constructor from the context

type EnvConfig

type EnvConfig struct {
	// Component is the kind of this adapter.
	Component string `envconfig:"K_COMPONENT"`

	// Environment variable containing the namespace of the adapter.
	Namespace string `envconfig:"NAMESPACE"`

	// Environment variable containing the name of the adapter.
	Name string `envconfig:"NAME" default:"adapter"`

	// Environment variable containing the resource group of the adapter for metrics.
	ResourceGroup string `envconfig:"K_RESOURCE_GROUP" default:"adapter.sources.knative.dev"`

	// Sink is the URI messages will be sent.
	Sink string `envconfig:"K_SINK"`

	// CEOverrides are the CloudEvents overrides to be applied to the outbound event.
	CEOverrides string `envconfig:"K_CE_OVERRIDES"`

	// MetricsConfigJson is a json string of metrics.ExporterOptions.
	// This is used to configure the metrics exporter options,
	// the config is stored in a config map inside the controllers
	// namespace and copied here.
	MetricsConfigJson string `envconfig:"K_METRICS_CONFIG" default:"{}"`

	// LoggingConfigJson is a json string of logging.Config.
	// This is used to configure the logging config, the config is stored in
	// a config map inside the controllers namespace and copied here.
	LoggingConfigJson string `envconfig:"K_LOGGING_CONFIG" default:"{}"`

	// TracingConfigJson is a json string of tracing.Config.
	// This is used to configure the tracing config, the config is stored in
	// a config map inside the controllers namespace and copied here.
	// Default is no-op.
	TracingConfigJson string `envconfig:"K_TRACING_CONFIG"`

	// LeaderElectionConfigJson is the leader election component configuration.
	LeaderElectionConfigJson string `envconfig:"K_LEADER_ELECTION_CONFIG"`

	// Time in seconds to wait for sink to respond
	EnvSinkTimeout string `envconfig:"K_SINK_TIMEOUT"`
	// contains filtered or unexported fields
}

EnvConfig is the minimal set of configuration parameters source adapters should support.

func (*EnvConfig) GetCloudEventOverrides

func (e *EnvConfig) GetCloudEventOverrides() (*duckv1.CloudEventOverrides, error)

func (*EnvConfig) GetLeaderElectionConfig added in v0.16.0

func (e *EnvConfig) GetLeaderElectionConfig() (*kle.ComponentConfig, error)

func (*EnvConfig) GetLogger

func (e *EnvConfig) GetLogger() *zap.SugaredLogger

func (*EnvConfig) GetMetricsConfig

func (e *EnvConfig) GetMetricsConfig() (*metrics.ExporterOptions, error)

func (*EnvConfig) GetName

func (e *EnvConfig) GetName() string

func (*EnvConfig) GetNamespace

func (e *EnvConfig) GetNamespace() string

func (*EnvConfig) GetSink

func (e *EnvConfig) GetSink() string

func (*EnvConfig) GetSinktimeout added in v0.18.1

func (e *EnvConfig) GetSinktimeout() int

func (*EnvConfig) SetComponent

func (e *EnvConfig) SetComponent(component string)

func (*EnvConfig) SetupTracing added in v0.15.0

func (e *EnvConfig) SetupTracing(logger *zap.SugaredLogger) error

type EnvConfigAccessor

type EnvConfigAccessor interface {
	// Set the component name.
	SetComponent(string)

	// Get the URI where messages will be forwarded to.
	GetSink() string

	// Get the namespace of the adapter.
	GetNamespace() string

	// Get the name of the adapter.
	GetName() string

	// Get the parsed metrics.ExporterOptions.
	GetMetricsConfig() (*metrics.ExporterOptions, error)

	// Get the parsed logger.
	GetLogger() *zap.SugaredLogger

	SetupTracing(*zap.SugaredLogger) error

	GetCloudEventOverrides() (*duckv1.CloudEventOverrides, error)

	// GetLeaderElectionConfig returns leader election configuration.
	GetLeaderElectionConfig() (*kle.ComponentConfig, error)

	// Get the timeout to apply on a request to a sink
	GetSinktimeout() int
}

EnvConfigAccessor defines accessors for the minimal set of source adapter configuration parameters.

func ConstructEnvOrDie added in v0.17.0

func ConstructEnvOrDie(ector EnvConfigConstructor) EnvConfigAccessor

type EnvConfigConstructor

type EnvConfigConstructor func() EnvConfigAccessor

type MessageAdapter added in v0.15.0

type MessageAdapter interface {
	Start(ctx context.Context) error
}

type MessageAdapterConstructor added in v0.15.0

type MessageAdapterConstructor func(ctx context.Context, env EnvConfigAccessor, adapter *kncloudevents.HTTPMessageSender, reporter source.StatsReporter) MessageAdapter

type MetricTag

type MetricTag struct {
	Name          string
	Namespace     string
	ResourceGroup string
}

MetricTag context

func MetricTagFromContext

func MetricTagFromContext(ctx context.Context) *MetricTag

MetricTagFromContext returns the metric tag stored in context. Returns nil if no metric tag is set in context, or if the stored value is not of correct type.

Directories

Path Synopsis
util

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL