Eventing
Package:
eventing.triggermesh.io/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types:
MemoryBroker
MemoryBroker is a Memory based broker implementation that collects a pool of events that are consumable using Triggers. Brokers provide a well-known endpoint for event delivery that senders can use with minimal knowledge of the event routing strategy. Subscribers use Triggers to request delivery of events from a broker’s pool to a specific URL or Addressable endpoint.
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersion
string |
eventing.triggermesh.io/v1alpha1
|
||||
kind
string
|
MemoryBroker |
||||
metadata
Kubernetes meta/v1.ObjectMeta
|
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
spec
MemoryBrokerSpec
|
Spec defines the desired state of the broker.
|
||||
status
MemoryBrokerStatus
|
(Optional)
Status represents the current state of the broker. This data may be out of date. |
RedisBroker
RedisBroker is a Redis based broker implementation that collects a pool of events that are consumable using Triggers. Brokers provide a well-known endpoint for event delivery that senders can use with minimal knowledge of the event routing strategy. Subscribers use Triggers to request delivery of events from a broker’s pool to a specific URL or Addressable endpoint.
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersion
string |
eventing.triggermesh.io/v1alpha1
|
||||
kind
string
|
RedisBroker |
||||
metadata
Kubernetes meta/v1.ObjectMeta
|
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
spec
RedisBrokerSpec
|
Spec defines the desired state of the broker.
|
||||
status
RedisBrokerStatus
|
(Optional)
Status represents the current state of the broker. This data may be out of date. |
Trigger
Trigger represents a request to have events delivered to a target from a Broker’s event pool.
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
eventing.triggermesh.io/v1alpha1
|
||||||||
kind
string
|
Trigger |
||||||||
metadata
Kubernetes meta/v1.ObjectMeta
|
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec
TriggerSpec
|
Spec defines the desired state of the Trigger.
|
||||||||
status
TriggerStatus
|
(Optional)
Status represents the current state of the Trigger. This data may be out of date. |
Broker
(Appears on: MemoryBrokerSpec, RedisBrokerSpec)
| Field | Description |
|---|---|
port
int
|
|
observability
Observability
|
Memory
(Appears on: MemoryBrokerSpec)
| Field | Description |
|---|---|
streamMaxLen
int
|
Maximum number of items the stream can host. |
MemoryBrokerSpec
(Appears on: MemoryBroker)
| Field | Description |
|---|---|
memory
Memory
|
|
broker
Broker
|
MemoryBrokerStatus
(Appears on: MemoryBroker)
MemoryBrokerStatus represents the current state of a Memory broker.
| Field | Description |
|---|---|
Status
knative.dev/pkg/apis/duck/v1.Status
|
(Members of inherits duck/v1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Broker that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state. |
address
knative.dev/pkg/apis/duck/v1.Addressable
|
(Optional)
Broker is Addressable. It exposes the endpoint as an URI to get events delivered into the Broker mesh. |
Observability
(Appears on: Broker)
| Field | Description |
|---|---|
valueFromConfigMap
string
|
ReconcilableBroker
ReconcilableBrokerStatus
Redis
(Appears on: RedisBrokerSpec)
| Field | Description |
|---|---|
connection
RedisConnection
|
Redis connection data. |
stream
string
|
Stream name used by the broker. |
streamMaxLen
int
|
Maximum number of items the stream can host. |
enableTrackingID
bool
|
Whether the Redis ID for the event is added as a CloudEvents attribute. |
RedisBrokerSpec
(Appears on: RedisBroker)
| Field | Description |
|---|---|
redis
Redis
|
|
broker
Broker
|
RedisBrokerStatus
(Appears on: RedisBroker)
RedisBrokerStatus represents the current state of a Redis broker.
| Field | Description |
|---|---|
Status
knative.dev/pkg/apis/duck/v1.Status
|
(Members of inherits duck/v1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Broker that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state. |
address
knative.dev/pkg/apis/duck/v1.Addressable
|
(Optional)
Broker is Addressable. It exposes the endpoint as an URI to get events delivered into the Broker mesh. |
RedisConnection
(Appears on: Redis)
| Field | Description |
|---|---|
url
string
|
Redis URL for standalone instances |
clusterURLs
[]string
|
Redis URLs for cluster instances |
username
SecretValueFromSource
|
Redis username. |
password
SecretValueFromSource
|
Redis password. |
tlsCACertificate
SecretValueFromSource
|
CA Certificate used to connect to Redis. |
tlsCertificate
SecretValueFromSource
|
Certificate used to connect to authenticate to Redis. |
tlsKey
SecretValueFromSource
|
Certificate Key used to connect to authenticate to Redis. |
tlsEnabled
bool
|
Use TLS enctrypted connection. |
tlsSkipVerify
bool
|
Skip TLS certificate verification. |
SecretValueFromSource
(Appears on: RedisConnection)
SecretValueFromSource represents the source of a secret value
| Field | Description |
|---|---|
secretKeyRef
Kubernetes core/v1.SecretKeySelector
|
The Secret key to select from. |
TriggerSpec
(Appears on: Trigger)
TriggerSpec defines the desired state of Trigger
| Field | Description |
|---|---|
broker
knative.dev/pkg/apis/duck/v1.KReference
|
Broker is the broker that this trigger receives events from. |
filters
[]github.com/triggermesh/brokers/pkg/config/broker.Filter
|
(Optional)
Filters is an experimental field that conforms to the CNCF CloudEvents Subscriptions API. It’s an array of filter expressions that evaluate to true or false. If any filter expression in the array evaluates to false, the event MUST NOT be sent to the target. If all the filter expressions in the array evaluate to true, the event MUST be attempted to be delivered. Absence of a filter or empty array implies a value of true. In the event of users specifying both Filter and Filters, then the latter will override the former. This will allow users to try out the effect of the new Filters field without compromising the existing attribute-based Filter and try it out on existing Trigger objects. |
target
knative.dev/pkg/apis/duck/v1.Destination
|
Target is the addressable that receives events from the Broker that pass the Filter. It is required. |
delivery
knative.dev/eventing/pkg/apis/duck/v1.DeliverySpec
|
(Optional)
Delivery contains the delivery spec for this specific trigger. |
TriggerStatus
(Appears on: Trigger)
TriggerStatus represents the current state of a Trigger.
| Field | Description |
|---|---|
Status
knative.dev/pkg/apis/duck/v1.Status
|
(Members of inherits duck/v1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Trigger that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state. |
targetUri
knative.dev/pkg/apis.URL
|
(Optional)
TargetURI is the resolved URI of the receiver for this Trigger. |
DeliveryStatus
knative.dev/eventing/pkg/apis/duck/v1.DeliveryStatus
|
(Members of DeliveryStatus contains a resolved URL to the dead letter sink address, and any other resolved delivery options. |
Generated with gen-crd-api-reference-docs
on git commit b997d49.