EventSource Specifications

Learn about EventSource Specifications.

1: EventSource Specifications
2: Redis
3: Kafka
4: Cron

1 - EventSource Specifications

EventSource Specifications.

This document describes the specifications of the EventSource CRD.

EventSource

Field	Description
apiVersion string	events.openfunction.io/v1alpha1
kind string	EventSource
metadata v1.ObjectMeta	(Optional) Refer to v1.ObjectMeta
spec EventSourceSpec	Refer to EventSourceSpec
status EventSourceStatus	Status of EventSource

EventSourceSpec

Belong to EventSource.

Field	Description
eventBus string	(Optional) Name of the EventBus resource associated with the event source.
redis map[string]RedisSpec	(Optional) The definition of a Redis event source, with key being the event name, refer to RedisSpec.
kafka map[string]KafkaSpec	(Optional) The definition of a Kafka event source, with key being the event name, refer to KafkaSpec.
cron map[string]CronSpec	(Optional) The definition of a Cron event source, with key being the event name, refer to CronSpec.
sink SinkSpec	(Optional) Definition of the Sink (addressable access resource, i.e. synchronization request) associated with the event source, cf. SinkSpec.

SinkSpec

Belong to EventSourceSpec.

Field	Description
ref Reference	Refer to Reference.

Reference

Belong to SinkSpec.

Note

The resources cited are generally Knative Service.

Field	Description
kind string	The type of the referenced resource. It defaults to `Service`.
namespace string	The namespace of the referenced resource, by default the same as the namespace of the Trigger.
name string	Name of the referenced resource, for example, `function-ksvc`.
apiVersion string	The apiVersion of the referenced resource. It defaults to `serving.knative.dev/v1`.

GenericScaleOption

Belong to scaleOption.

Field	Description
pollingInterval int	This is the interval to check each trigger on. It defaults to `30` seconds.
cooldownPeriod int	The period to wait after the last trigger reported active before scaling the resource back to 0. It defaults to `300` seconds.
minReplicaCount int	Minimum number of replicas KEDA will scale the resource down to. It defaults to `0`.
maxReplicaCount int	This setting is passed to the HPA definition that KEDA will create for a given resource.
advanced kedav1alpha1.AdvancedConfig	See KEDA documentation.
metadata map[string]string	KEDA trigger’s metadata
authRef kedav1alpha1.ScaledObjectAuthRef	Every parameter you define in `TriggerAuthentication` definition does not need to be included in the `metadata` of the trigger for your `ScaledObject` definition. To reference a `TriggerAuthentication` from a `ScaledObject` you add the `authenticationRef` to the trigger, refer to KEDA documentation.

2 - Redis

Event source specifications of Redis.

RedisSpec

Belong to EventSourceSpec.

Note

The EventSource generates Dapr Bindings Components for adapting Redis event sources according to the RedisSpec, and in principle we try to maintain the consistency of the relevant parameters. For more information, see Redis binding spec.

Field	Description
redisHost string	Address of the Redis server, e.g. `localhost:6379`.
redisPassword string	Password for the Redis server, e.g. `123456`.
enableTLS bool	(Optional) Whether to enable TLS access, which defaults to `false`. Value options: `true`, `false`.
failover bool	(Optional) Whether to enable the failover feature. Requires the sentinalMasterName to be set. It defaults to `false`. Value options: `true`, `false`.
sentinelMasterName string	(Optional) The name of the sentinel master. Refer to Redis Sentinel Documentation.
redeliverInterval string	(Optional) The interval for redeliver. It defaults to `60s`. `0` means the redeliver mechanism is disabled. E.g. `30s`
processingTimeout string	(Optional) Message processing timeout. It defaults to `15s`. `0` means timeout is disabled. E.g. `30s`
redisType string	(Optional) The type of Redis. Value options: `node` for single-node mode, `cluster` for cluster mode. It defaults to `node`.
redisDB int64	(Optional) The database index to connect to Redis. Effective only if redisType is `node`. It defaults to `0`.
redisMaxRetries int64	(Optional) Maximum number of retries. It defaults to no retries. E.g. `5`
redisMinRetryInterval string	(Optional) Minimum backoff time for retries. The default value is `8ms`. `-1` indicates that the backoff time is disabled. E.g. `10ms`
redisMaxRetryInterval string	(Optional) Maximum backoff time for retries. The default value is `512ms`. `-1` indicates that the backoff time is disabled. E.g. `5s`
dialTimeout string	(Optional) Timeout to establish a new connection. It defaults to `5s`.
readTimeout string	(Optional) Read timeout. A timeout causes Redis commands to fail rather than wait in a blocking fashion. It defaults to `3s`. `-1` means disabled.
writeTimeout string	(Optional) Write timeout. A timeout causes Redis commands to fail rather than wait in a blocking fashion. It defaults to consistent with readTimeout.
poolSize int64	(Optional) Maximum number of connections. It defaults to 10 connections per runtime.NumCPU. E.g. `20`
poolTimeout string	(Optional) The timeout for the connection pool. The default is readTimeout + 1 second. E.g. `50s`
maxConnAge string	(Optional) Connection aging time. The default is not to close the aging connection. E.g. `30m`
minIdleConns int64	(Optional) The minimum number of idle connections to maintain to avoid performance degradation from creating new connections. It defaults to `0`. E.g. `2`
idleCheckFrequency string	(Optional) Frequency of idle connection recycler checks. Default is `1m`. `-1` means the idle connection recycler is disabled. E.g. `-1`
idleTimeout string	(Optional) Timeout to close idle client connections, which should be less than the server’s timeout. It defaults to `5m`. `-1` means disable idle timeout check. E.g. `10m`

3 - Kafka

Event source specifications of Kafka.

KafkaSpec

Belong to EventSourceSpec.

Note

The EventSource generates Dapr Bindings Components for adapting Kafka event sources according to the KafkaSpec, and in principle we try to maintain the consistency of the relevant parameters. You can get more information by visiting the Kafka binding spec.

Field	Description
brokers string	A comma-separated string of Kafka server addresses, for example, `localhost:9092`.
authRequired bool	Whether to enable SASL authentication for the Kafka server. Value options: `true`, `false`.
topic string	The topic name of the Kafka event source, for example, `topicA`, `myTopic`.
saslUsername string	(Optional) The SASL username to use for authentication. Only required if authRequired is `true`. For example, `admin`.
saslPassword string	(Optional) The SASL user password for authentication. Only required if authRequired is `true`. For example, `123456`.
maxMessageBytes int64	(Optional) The maximum number of bytes a single message is allowed to contain. Default is `1024`. For example, `2048`.
scaleOption KafkaScaleOption	(Optional) Kafka’s scale configuration.

KafkaScaleOption

Belong to KafkaSpec.

Field	Description
GenericScaleOption	Generic scale configuration.
consumerGroup string	Kafka’s consumer group name.
topic string	Topic under monitoring, for example, `topicA`, `myTopic`.
lagThreshold string	Threshold for triggering scaling, in this case is the Kafka’s lag.

4 - Cron

Event source specifications of Cron.

CronSpec

Belong to EventSourceSpec.

Note

The EventSource generates Dapr Bindings Components for adapting Cron event sources according to the CronSpec, and in principle we try to maintain the consistency of the relevant parameters. For more information, see the Cron binding spec.

Field	Description
schedule string	Refer to Schedule format for a valid schedule format, for example, `@every 15m`.