Version:

Subscription

The subscriptions.eventing.kyma-project.io CustomResourceDefinition (CRD) is a detailed description of the kind of data and the format used to subscribe to events. To get the up-to-date CRD and show the output in the YAML format, run this command:

kubectl get crd subscriptions.eventing.kyma-project.io -o yaml

Sample custom resource

This sample Subscription custom resource (CR) subscribes to an event called order.created.v1.

WARNING: Prohibited characters in event names under the spec.types property, are not supported in some backends. If any are detected, Eventing will remove them. Read Event names for more information.

NOTE: Both the subscriber and the Subscription should exist in the same Namespace.

Click to copy

apiVersion: eventing.kyma-project.io/v1alpha2
kind: Subscription
metadata:
  name: test
  namespace: test
spec:
  typeMatching: standard
  source: commerce
  types:
    - order.created.v1
  sink: http://test.test.svc.cluster.local
  config:
    maxInFlightMessages: "10"

Custom resource parameters

This table lists all the possible parameters of a given resource together with their descriptions:

Subscription.eventing.kyma-project.io/v1alpha2

Spec:

Parameter	Type	Description
config	map[string]string	Map of configuration options that will be applied on the backend.
id	string	Unique identifier of the Subscription, read-only.
sink (required)	string	Kubernetes Service that should be used as a target for the events that match the Subscription. Must exist in the same Namespace as the Subscription.
source (required)	string	Defines the origin of the event.
typeMatching	string	Defines how types should be handled. - `standard`: backend-specific logic will be applied to the configured source and types. - `exact`: no further processing will be applied to the configured source and types.
types (required)	[]string	List of event types that will be used for subscribing on the backend.

Status:

Parameter	Type	Description
backend	object	Backend-specific status which is applicable to the active backend only.
backend.apiRuleName	string	Name of the APIRule which is used by the Subscription.
backend.emsSubscriptionStatus	object	Status of the Subscription as reported by EventMesh.
backend.emsSubscriptionStatus.lastFailedDelivery	string	Timestamp of the last failed delivery.
backend.emsSubscriptionStatus.lastFailedDeliveryReason	string	Reason for the last failed delivery.
backend.emsSubscriptionStatus.lastSuccessfulDelivery	string	Timestamp of the last successful delivery.
backend.emsSubscriptionStatus.status	string	Status of the Subscription as reported by the backend.
backend.emsSubscriptionStatus.statusReason	string	Reason for the current status.
backend.emsTypes	[]object	List of mappings from event type to EventMesh compatible types. Used only with EventMesh as the backend.
backend.emsTypes.eventMeshType (required)	string	Event type that is used on the EventMesh backend.
backend.emsTypes.originalType (required)	string	Event type that was originally used to subscribe.
backend.emshash	integer	Hash used to identify an EventMesh Subscription retrieved from the server without the WebhookAuth config.
backend.ev2hash	integer	Checksum for the Subscription custom resource.
backend.eventMeshLocalHash	integer	Hash used to identify an EventMesh Subscription posted to the server without the WebhookAuth config.
backend.externalSink	string	Webhook URL used by EventMesh to trigger subscribers.
backend.failedActivation	string	Provides the reason if a Subscription failed activation in EventMesh.
backend.types	[]object	List of event type to consumer name mappings for the NATS backend.
backend.types.consumerName	string	Name of the JetStream consumer created for the event type.
backend.types.originalType (required)	string	Event type that was originally used to subscribe.
backend.webhookAuthHash	integer	Hash used to identify the WebhookAuth of an EventMesh Subscription existing on the server.
conditions	[]object	Current state of the Subscription.
conditions.lastTransitionTime	string	Defines the date of the last condition status change.
conditions.message	string	Provides more details about the condition status change.
conditions.reason	string	Defines the reason for the condition status change.
conditions.status (required)	string	Status of the condition. The value is either `True`, `False`, or `Unknown`.
conditions.type	string	Short description of the condition.
ready (required)	boolean	Overall readiness of the Subscription.
types (required)	[]object	List of event types after cleanup for use with the configured backend.
types.cleanType (required)	string	Event type after it was cleaned up from backend compatible characters.
types.originalType (required)	string	Event type as specified in the Subscription spec.

Subscription.eventing.kyma-project.io/v1alpha1

CAUTION: The v1alpha1 API version is deprecated as of Kyma 2.14.X.