We use analytics and cookies to understand site traffic. Information about your use of our site is shared with Google for that purpose. Learn more.
Eventing-contrib Resources
Packages:
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.
|
||||||
status
KafkaChannelStatus
|
(Optional)
Status represents the current state of the KafkaChannel. This data may be out of date. |
NatssChannel
NatssChannel is a resource representing a NATSS Channel.
Field | Description | ||
---|---|---|---|
apiVersion
string |
messaging.knative.dev/v1alpha1
|
||
kind
string
|
NatssChannel |
||
metadata
Kubernetes meta/v1.ObjectMeta
|
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||
spec
NatssChannelSpec
|
Spec defines the desired state of the Channel.
|
||
status
NatssChannelStatus
|
(Optional)
Status represents the current state of the NatssChannel. 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
knative.dev/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 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 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
knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
|
(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
NatssChannelSpec
(Appears on: NatssChannel)
NatssChannelSpec defines the specification for a NatssChannel.
Field | Description |
---|---|
subscribable
knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
NatssChannel conforms to Duck type Subscribable. |
NatssChannelStatus
(Appears on: NatssChannel)
NatssChannelStatus represents the current state of a NatssChannel.
Field | Description |
---|---|
Status
knative.dev/pkg/apis/duck/v1beta1.Status
|
(Members of 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 NatssChannel 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
knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
|
(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
sources.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.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
|
|
||||||||||
status
AwsSqsSourceStatus
|
CamelSource
CamelSource is the Schema for the camelsources API
Field | Description | ||||||
---|---|---|---|---|---|---|---|
apiVersion
string |
sources.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
|
|
||||||
status
CamelSourceStatus
|
CouchDbSource
CouchDbSource is the Schema for the githubsources API
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
sources.knative.dev/v1alpha1
|
||||||||||
kind
string
|
CouchDbSource |
||||||||||
metadata
Kubernetes meta/v1.ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec
CouchDbSourceSpec
|
|
||||||||||
status
CouchDbSourceStatus
|
GitHubSource
GitHubSource is the Schema for the githubsources API
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
sources.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
|
|
||||||||||||||||
status
GitHubSourceStatus
|
GitLabSource
GitLabSource is the Schema for the gitlabsources API
Field | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
sources.knative.dev/v1alpha1
|
||||||||||||||
kind
string
|
GitLabSource |
||||||||||||||
metadata
Kubernetes meta/v1.ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
spec
GitLabSourceSpec
|
|
||||||||||||||
status
GitLabSourceStatus
|
PrometheusSource
PrometheusSource is the Schema for the prometheussources API
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
sources.knative.dev/v1alpha1
|
||||||||||||||||
kind
string
|
PrometheusSource |
||||||||||||||||
metadata
Kubernetes meta/v1.ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec
PrometheusSourceSpec
|
|
||||||||||||||||
status
PrometheusSourceStatus
|
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
|
(Optional)
AwsCredsSecret is the credential to use to poll the AWS SQS |
annotations
map[string]string
|
(Optional)
Annotations to add to the pod, mostly used for Kube2IAM role |
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 |
---|---|
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus
|
(Members of inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source. |
CamelSourceOriginSpec
(Appears on: CamelSourceSpec)
CamelSourceOriginSpec is the integration flow to run
Field | Description |
---|---|
integration
github.com/apache/camel-k/pkg/apis/camel/v1.IntegrationSpec
|
Integration is a kind of source that contains a Camel K integration |
flow
Flow
|
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
knative.dev/pkg/apis/duck/v1beta1.Destination
|
(Optional)
Sink is a reference to an object that will resolve to a domain name to use as the sink. |
ceOverrides
knative.dev/pkg/apis/duck/v1.CloudEventOverrides
|
(Optional)
CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. |
CamelSourceStatus
(Appears on: CamelSource)
CamelSourceStatus defines the observed state of CamelSource
Field | Description |
---|---|
Status
knative.dev/pkg/apis/duck/v1.Status
|
(Members of 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. |
CouchDbSourceSpec
(Appears on: CouchDbSource)
CouchDbSourceSpec defines the desired state of CouchDbSource
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 CouchDbSource exists. |
credentials
Kubernetes core/v1.ObjectReference
|
CouchDbCredentials is the credential to use to access CouchDb. Must be a secret. Only Name and Namespace are used. |
feed
FeedType
|
Feed changes how CouchDB sends the response. More information: https://docs.couchdb.org/en/stable/api/database/changes.html#changes-feeds |
database
string
|
Database is the database to watch for changes |
sink
knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
Sink is a reference to an object that will resolve to a domain name to use as the sink. |
CouchDbSourceStatus
(Appears on: CouchDbSource)
CouchDbSourceStatus defines the observed state of CouchDbSource
Field | Description |
---|---|
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus
|
(Members of inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source. |
FeedType
(string
alias)
(Appears on: CouchDbSourceSpec)
FeedType is the type of Feed
Flow
(map[string]interface{}
alias)
(Appears on: CamelSourceOriginSpec)
Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL
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
knative.dev/pkg/apis/duck/v1.Destination
|
(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, or false to use http. Omitting it relies on the scheme of the Knative Service created (e.g. if auto-TLS is enabled it should do the right thing). |
GitHubSourceStatus
(Appears on: GitHubSource)
GitHubSourceStatus defines the observed state of GitHubSource
Field | Description |
---|---|
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus
|
(Members of inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source. |
webhookIDKey
string
|
WebhookIDKey is the ID of the webhook registered with GitHub |
GitLabSourceSpec
(Appears on: GitLabSource)
GitLabSourceSpec defines the desired state of GitLabSource
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 GitLabSource exists. |
projectUrl
string
|
ProjectUrl is the url of the GitLab project which we are interested in receiving events from. Examples: https://github.com/knative/eventing-contrib/tree/{{% branch %}}/gitlab/samples |
eventTypes
[]string
|
EventType is the type of event to receive from Gitlab. These correspond to supported events to the add project hook https://docs.gitlab.com/ee/api/projects.html#add-project-hook |
accessToken
SecretValueFromSource
|
AccessToken is the Kubernetes secret containing the GitLab access token |
secretToken
SecretValueFromSource
|
SecretToken is the Kubernetes secret containing the GitLab secret token |
sslverify
bool
|
SslVerify if true configure webhook so the ssl verification is done when triggering the hook |
sink
knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
Sink is a reference to an object that will resolve to a domain name to use as the sink. |
GitLabSourceStatus
(Appears on: GitLabSource)
GitLabSourceStatus defines the observed state of GitLabSource
Field | Description |
---|---|
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus
|
(Members of inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source. |
Id
string
|
ID of the project hook registered with GitLab |
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
|
KafkaSource
KafkaSource is the Schema for the kafkasources API.
Field | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata
Kubernetes meta/v1.ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
spec
KafkaSourceSpec
|
|
||||||||||||||
status
KafkaSourceStatus
|
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
knative.dev/pkg/apis/duck/v1.Destination
|
(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 |
---|---|
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus
|
(Members of inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source. |
KafkaSourceTLSSpec
=======
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. |
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 >>>>>>> 15673978d483a43af83f84279f409699774b4a97
(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. |
PrometheusSourceSpec
(Appears on: PrometheusSource)
PrometheusSourceSpec defines the desired state of PrometheusSource
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 PrometheusSource exists. |
serverURL
string
|
ServerURL is the URL of the Prometheus server |
promQL
string
|
PromQL is the Prometheus query for this source |
authTokenFile
string
|
(Optional)
The name of the file containing the authenication token |
caCertConfigMap
string
|
(Optional)
The name of the config map containing the CA certificate of the Prometheus service’s signer. |
schedule
string
|
A crontab-formatted schedule for running the PromQL query |
step
string
|
(Optional)
Query resolution step width in duration format or float number of seconds. Prometheus duration strings are of the form [0-9]+[smhdwy]. |
sink
knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
Sink is a reference to an object that will resolve to a host name to use as the sink. |
PrometheusSourceStatus
(Appears on: PrometheusSource)
PrometheusSourceStatus defines the observed state of PrometheusSource
Field | Description |
---|---|
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus
|
(Members of inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source. |
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. |
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: GitLabSourceSpec)
SecretValueFromSource represents the source of a secret value
Field | Description |
---|---|
secretKeyRef
Kubernetes core/v1.SecretKeySelector
|
The Secret key to select from. |
Generated with gen-crd-api-reference-docs
on git commit 6ba61a66
.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.