Eventing-contrib Resources
Packages:
- sources.knative.dev/v1beta1
- messaging.knative.dev/v1alpha1
- messaging.knative.dev/v1beta1
- bindings.knative.dev/v1alpha1
- bindings.knative.dev/v1beta1
- sources.knative.dev/v1alpha1
sources.knative.dev/v1beta1
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group
Resource Types:
KafkaLimitsSpec
(Appears on: KafkaResourceSpec)
Field | Description |
---|---|
cpu string | |
memory string |
KafkaRequestsSpec
(Appears on: KafkaResourceSpec)
Field | Description |
---|---|
cpu string | |
memory string |
KafkaResourceSpec
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 |
KafkaSourceSpec
(Appears on: KafkaSource)
KafkaSourceSpec defines the desired state of the KafkaSource.
Field | Description |
---|---|
KafkaAuthSpec KafkaAuthSpec | (Members of |
topics []string | Topic topics to consume messages from |
consumerGroup string | (Optional) ConsumerGroupID is the consumer group ID. |
SourceSpec knative.dev/pkg/apis/duck/v1.SourceSpec | (Members of inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink. |
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. |
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. |
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/v1.Status | (Members of inherits duck/v1 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. |
messaging.knative.dev/v1beta1
Package v1beta1 is the v1beta1 version of the API.
Resource Types:
KafkaChannel
KafkaChannel is a resource representing a Kafka Channel.
Field | Description | ||||||
---|---|---|---|---|---|---|---|
apiVersion string | messaging.knative.dev/v1beta1 | ||||||
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. |
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. |
ChannelableSpec knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec | (Members of Channel conforms to Duck type Channelable. |
KafkaChannelStatus
(Appears on: KafkaChannel)
KafkaChannelStatus represents the current state of a KafkaChannel.
Field | Description |
---|---|
ChannelableStatus knative.dev/eventing/pkg/apis/duck/v1.ChannelableStatus | (Members of Channel conforms to Duck type Channelable. |
bindings.knative.dev/v1alpha1
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Resource Types:
KafkaAuthSpec
(Appears on: KafkaBindingSpec, KafkaSourceSpec)
Field | Description |
---|---|
bootstrapServers []string | Bootstrap servers are the Kafka servers the consumer will connect to. |
net KafkaNetSpec |
KafkaBinding
KafkaBinding 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 KafkaBindingSpec |
| ||||
status KafkaBindingStatus |
KafkaBindingSpec
(Appears on: KafkaBinding)
KafkaBindingSpec defines the desired state of the KafkaBinding.
Field | Description |
---|---|
BindingSpec knative.dev/pkg/apis/duck/v1alpha1.BindingSpec | (Members of |
KafkaAuthSpec KafkaAuthSpec | (Members of |
KafkaBindingStatus
(Appears on: KafkaBinding)
KafkaBindingStatus defines the observed state of KafkaBinding.
Field | Description |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status | (Members of |
KafkaNetSpec
(Appears on: KafkaAuthSpec)
Field | Description |
---|---|
sasl KafkaSASLSpec | |
tls KafkaTLSSpec |
KafkaSASLSpec
(Appears on: KafkaNetSpec)
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. |
KafkaTLSSpec
(Appears on: KafkaNetSpec)
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: KafkaSASLSpec, KafkaTLSSpec)
SecretValueFromSource represents the source of a secret value
Field | Description |
---|---|
secretKeyRef Kubernetes core/v1.SecretKeySelector | The Secret key to select from. |
bindings.knative.dev/v1beta1
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group
Resource Types:
KafkaAuthSpec
(Appears on: KafkaBindingSpec, KafkaSourceSpec)
Field | Description |
---|---|
bootstrapServers []string | Bootstrap servers are the Kafka servers the consumer will connect to. |
net KafkaNetSpec |
KafkaBinding
KafkaBinding 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 KafkaBindingSpec |
| ||||
status KafkaBindingStatus |
KafkaBindingSpec
(Appears on: KafkaBinding)
KafkaBindingSpec defines the desired state of the KafkaBinding.
Field | Description |
---|---|
BindingSpec knative.dev/pkg/apis/duck/v1alpha1.BindingSpec | (Members of |
KafkaAuthSpec KafkaAuthSpec | (Members of |
KafkaBindingStatus
(Appears on: KafkaBinding)
KafkaBindingStatus defines the observed state of KafkaBinding.
Field | Description |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status | (Members of |
KafkaNetSpec
(Appears on: KafkaAuthSpec)
Field | Description |
---|---|
sasl KafkaSASLSpec | |
tls KafkaTLSSpec |
KafkaSASLSpec
(Appears on: KafkaNetSpec)
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. |
KafkaTLSSpec
(Appears on: KafkaNetSpec)
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: KafkaSASLSpec, KafkaTLSSpec)
SecretValueFromSource represents the source of a secret value
Field | Description |
---|---|
secretKeyRef Kubernetes core/v1.SecretKeySelector | The Secret key to select from. |
sources.knative.dev/v1alpha1
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Resource Types:
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 |
KafkaSourceSpec
(Appears on: KafkaSource)
KafkaSourceSpec defines the desired state of the KafkaSource.
Field | Description |
---|---|
KafkaAuthSpec KafkaAuthSpec | (Members of |
topics []string | Topic topics to consume messages from |
consumerGroup string | (Optional) ConsumerGroupID is the consumer group ID. |
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. Deprecated: v1beta1 drops this field. |
resources KafkaResourceSpec | Resource limits and Request specifications of the Receive Adapter Deployment Deprecated: v1beta1 drops this field. |
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. |
Generated with gen-crd-api-reference-docs
on git commit ef8b78ed
.