Eventing-contrib Resources

Packages:

sources.eventing.knative.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group

Resource Types:

AwsSqsSource

AwsSqsSource is the Schema for the AWS SQS API

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
AwsSqsSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AwsSqsSourceSpec


queueUrl
string

QueueURL of the SQS queue that we will poll from.

awsCredsSecret
Kubernetes core/v1.SecretKeySelector

AwsCredsSecret is the credential to use to poll the AWS SQS

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink. This is where events will be received.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

status
AwsSqsSourceStatus

CamelSource

CamelSource is the Schema for the camelsources API

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
CamelSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
CamelSourceSpec


source
CamelSourceOriginSpec

Source is the reference to the integration flow to run.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

status
CamelSourceStatus

GcpPubSubSource

GcpPubSubSource is the Schema for the gcppubsubsources API.

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
GcpPubSubSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GcpPubSubSourceSpec


gcpCredsSecret
Kubernetes core/v1.SecretKeySelector

GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used to create or delete the Subscription, only to poll it. The value of the secret entry must be a service account key in the JSON format ( see https://cloud.google.com/iam/docs/creating-managing-service-account-keys ).

googleCloudProject
string

GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in.

topic
string

Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not ‘projects/my-gcp-project/topics/laconia’.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

transformer
Kubernetes core/v1.ObjectReference
(Optional)

Transformer is a reference to an object that will resolve to a domain name to use as the transformer.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

status
GcpPubSubSourceStatus

GitHubSource

GitHubSource is the Schema for the githubsources API

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
GitHubSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GitHubSourceSpec


serviceAccountName
string
(Optional)

ServiceAccountName holds the name of the Kubernetes service account as which the underlying K8s resources should be run. If unspecified this will default to the “default” service account for the namespace in which the GitHubSource exists.

ownerAndRepository
string

OwnerAndRepository is the GitHub owner/org and repository to receive events from. The repository may be left off to receive events from an entire organization. Examples: myuser/project myorganization

eventTypes
[]string

EventType is the type of event to receive from GitHub. These correspond to the “Webhook event name” values listed at https://developer.github.com/v3/activity/events/types/ - ie “pull_request”

accessToken
SecretValueFromSource

AccessToken is the Kubernetes secret containing the GitHub access token

secretToken
SecretValueFromSource

SecretToken is the Kubernetes secret containing the GitHub secret token

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

githubAPIURL
string
(Optional)

API URL if using github enterprise (default https://api.github.com)

secure
bool
(Optional)

Secure can be set to true to configure the webhook to use https.

status
GitHubSourceStatus

KafkaSource

KafkaSource is the Schema for the kafkasources API.

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
KafkaSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
KafkaSourceSpec


bootstrapServers
string

Bootstrap servers are the Kafka servers the consumer will connect to.

topics
string

Topic topics to consume messages from

consumerGroup
string

ConsumerGroupID is the consumer group ID.

net
KafkaSourceNetSpec
sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

resources
KafkaResourceSpec

Resource limits and Request specifications of the Receive Adapter Deployment

status
KafkaSourceStatus

AwsSqsSourceSpec

(Appears on: AwsSqsSource)

AwsSqsSourceSpec defines the desired state of the source.

Field Description
queueUrl
string

QueueURL of the SQS queue that we will poll from.

awsCredsSecret
Kubernetes core/v1.SecretKeySelector

AwsCredsSecret is the credential to use to poll the AWS SQS

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink. This is where events will be received.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

AwsSqsSourceStatus

(Appears on: AwsSqsSource)

AwsSqsSourceStatus defines the observed state of the source.

Field Description
Status
knative.dev/pkg/apis/duck/v1alpha1.Status

(Members of Status are embedded into this type.)

inherits duck/v1alpha1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the source.

CamelSourceOriginComponentSpec

(Appears on: CamelSourceOriginSpec)

Field Description
uri
string

URI is a Camel component URI to use as starting point (e.g. “timer:tick?period=2s”)

properties
map[string]string
serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source.

context
string
(Optional)

The Camel K context to use when running the source

CamelSourceOriginSpec

(Appears on: CamelSourceSpec)

CamelSourceOriginSpec is the integration flow to run

Field Description
component
CamelSourceOriginComponentSpec

Component is a kind of source that directly references a Camel component DEPRECATED

integration
github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec

Integration is a kind of source that contains a Camel K integration

flow
string

Flow is a kind of source that contains a single Camel YAML flow route

CamelSourceSpec

(Appears on: CamelSource)

CamelSourceSpec defines the desired state of CamelSource

Field Description
source
CamelSourceOriginSpec

Source is the reference to the integration flow to run.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

CamelSourceStatus

(Appears on: CamelSource)

CamelSourceStatus defines the observed state of CamelSource

Field Description
Status
knative.dev/pkg/apis/duck/v1alpha1.Status

(Members of Status are embedded into this type.)

inherits duck/v1alpha1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the CamelSource.

GcpPubSubSourceSpec

(Appears on: GcpPubSubSource)

GcpPubSubSourceSpec defines the desired state of the GcpPubSubSource.

Field Description
gcpCredsSecret
Kubernetes core/v1.SecretKeySelector

GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used to create or delete the Subscription, only to poll it. The value of the secret entry must be a service account key in the JSON format ( see https://cloud.google.com/iam/docs/creating-managing-service-account-keys ).

googleCloudProject
string

GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in.

topic
string

Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not ‘projects/my-gcp-project/topics/laconia’.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

transformer
Kubernetes core/v1.ObjectReference
(Optional)

Transformer is a reference to an object that will resolve to a domain name to use as the transformer.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

GcpPubSubSourceStatus

(Appears on: GcpPubSubSource)

GcpPubSubSourceStatus defines the observed state of GcpPubSubSource.

Field Description
Status
knative.dev/pkg/apis/duck/v1alpha1.Status

(Members of Status are embedded into this type.)

inherits duck/v1alpha1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the GcpPubSubSource.

transformerUri
string
(Optional)

TransformerURI is the current active transformer URI that has been configured for the GcpPubSubSource.

GitHubSourceSpec

(Appears on: GitHubSource)

GitHubSourceSpec defines the desired state of GitHubSource

Field Description
serviceAccountName
string
(Optional)

ServiceAccountName holds the name of the Kubernetes service account as which the underlying K8s resources should be run. If unspecified this will default to the “default” service account for the namespace in which the GitHubSource exists.

ownerAndRepository
string

OwnerAndRepository is the GitHub owner/org and repository to receive events from. The repository may be left off to receive events from an entire organization. Examples: myuser/project myorganization

eventTypes
[]string

EventType is the type of event to receive from GitHub. These correspond to the “Webhook event name” values listed at https://developer.github.com/v3/activity/events/types/ - ie “pull_request”

accessToken
SecretValueFromSource

AccessToken is the Kubernetes secret containing the GitHub access token

secretToken
SecretValueFromSource

SecretToken is the Kubernetes secret containing the GitHub secret token

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

githubAPIURL
string
(Optional)

API URL if using github enterprise (default https://api.github.com)

secure
bool
(Optional)

Secure can be set to true to configure the webhook to use https.

GitHubSourceStatus

(Appears on: GitHubSource)

GitHubSourceStatus defines the observed state of GitHubSource

Field Description
Status
knative.dev/pkg/apis/duck/v1alpha1.Status

(Members of Status are embedded into this type.)

inherits duck/v1alpha1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.

webhookIDKey
string

WebhookIDKey is the ID of the webhook registered with GitHub

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the GitHubSource.

KafkaLimitsSpec

(Appears on: KafkaResourceSpec)

Field Description
cpu
string
memory
string

KafkaRequestsSpec

(Appears on: KafkaResourceSpec)

Field Description
cpu
string
memory
string

KafkaResourceSpec

(Appears on: KafkaSourceSpec)

Field Description
requests
KafkaRequestsSpec
limits
KafkaLimitsSpec

KafkaSourceNetSpec

(Appears on: KafkaSourceSpec)

Field Description
sasl
KafkaSourceSASLSpec
tls
KafkaSourceTLSSpec

KafkaSourceSASLSpec

(Appears on: KafkaSourceNetSpec)

Field Description
enable
bool
user
SecretValueFromSource
(Optional)

User is the Kubernetes secret containing the SASL username.

password
SecretValueFromSource
(Optional)

Password is the Kubernetes secret containing the SASL password.

KafkaSourceSpec

(Appears on: KafkaSource)

KafkaSourceSpec defines the desired state of the KafkaSource.

Field Description
bootstrapServers
string

Bootstrap servers are the Kafka servers the consumer will connect to.

topics
string

Topic topics to consume messages from

consumerGroup
string

ConsumerGroupID is the consumer group ID.

net
KafkaSourceNetSpec
sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

resources
KafkaResourceSpec

Resource limits and Request specifications of the Receive Adapter Deployment

KafkaSourceStatus

(Appears on: KafkaSource)

KafkaSourceStatus defines the observed state of KafkaSource.

Field Description
Status
knative.dev/pkg/apis/duck/v1alpha1.Status

(Members of Status are embedded into this type.)

inherits duck/v1alpha1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the KafkaSource.

KafkaSourceTLSSpec

(Appears on: KafkaSourceNetSpec)

Field Description
enable
bool
cert
SecretValueFromSource
(Optional)

Cert is the Kubernetes secret containing the client certificate.

key
SecretValueFromSource
(Optional)

Key is the Kubernetes secret containing the client key.

caCert
SecretValueFromSource
(Optional)

CACert is the Kubernetes secret containing the server CA cert.

SecretValueFromSource

(Appears on: GitHubSourceSpec)

SecretValueFromSource represents the source of a secret value

Field Description
secretKeyRef
Kubernetes core/v1.SecretKeySelector

The Secret key to select from.

SecretValueFromSource

(Appears on: KafkaSourceSASLSpec, KafkaSourceTLSSpec)

SecretValueFromSource represents the source of a secret value

Field Description
secretKeyRef
Kubernetes core/v1.SecretKeySelector

The Secret key to select from.


messaging.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

KafkaChannel

KafkaChannel is a resource representing a Kafka Channel.

Field Description
apiVersion
string
messaging.knative.dev/v1alpha1
kind
string
KafkaChannel
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
KafkaChannelSpec

Spec defines the desired state of the Channel.



numPartitions
int32

NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.

replicationFactor
int16

ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.

subscribable
github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable

KafkaChannel conforms to Duck type Subscribable.

status
KafkaChannelStatus
(Optional)

Status represents the current state of the KafkaChannel. This data may be out of date.

KafkaChannelSpec

(Appears on: KafkaChannel)

KafkaChannelSpec defines the specification for a KafkaChannel.

Field Description
numPartitions
int32

NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.

replicationFactor
int16

ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.

subscribable
github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable

KafkaChannel conforms to Duck type Subscribable.

KafkaChannelStatus

(Appears on: KafkaChannel)

KafkaChannelStatus represents the current state of a KafkaChannel.

Field Description
Status
knative.dev/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 Status, which currently provides: * ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.

AddressStatus
knative.dev/pkg/apis/duck/v1alpha1.AddressStatus

(Members of AddressStatus are embedded into this type.)

KafkaChannel is Addressable. It currently exposes the endpoint as a fully-qualified DNS name which will distribute traffic over the provided targets from inside the cluster.

It generally has the form {channel}.{namespace}.svc.{cluster domain name}

SubscribableTypeStatus
github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus

(Members of SubscribableTypeStatus are embedded into this type.)

Subscribers is populated with the statuses of each of the Channelable’s subscribers.


Generated with gen-crd-api-reference-docs on git commit 4bda4fca.