From 459b6463d1186cf55c80e4dd6588a2a3309fa501 Mon Sep 17 00:00:00 2001 From: Richie Escarez Date: Wed, 19 Aug 2020 16:37:37 -0700 Subject: [PATCH 1/9] build API docs for 0.17 --- docs/reference/eventing/eventing-contrib.md | 3832 +++++----- docs/reference/eventing/eventing.md | 7215 ++++++++++--------- docs/reference/serving.md | 1079 +-- 3 files changed, 6100 insertions(+), 6026 deletions(-) diff --git a/docs/reference/eventing/eventing-contrib.md b/docs/reference/eventing/eventing-contrib.md index a39fe315f2..a8cb795b1f 100644 --- a/docs/reference/eventing/eventing-contrib.md +++ b/docs/reference/eventing/eventing-contrib.md @@ -1,12 +1,6 @@

Packages:

-

sources.knative.dev/v1alpha1

+

messaging.knative.dev/v1alpha1

-

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

+

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types: -

AwsSqsSource +

KafkaChannel

-

AwsSqsSource is the Schema for the AWS SQS API

+

KafkaChannel is a resource representing a Kafka Channel.

@@ -56,7 +48,7 @@ Resource Types: string @@ -65,7 +57,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -85,77 +78,47 @@ Refer to the Kubernetes API documentation for the fields of the
-sources.knative.dev/v1alpha1 +messaging.knative.dev/v1alpha1
AwsSqsSourceKafkaChannel
@@ -77,6 +69,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -AwsSqsSourceSpec + +KafkaChannelSpec 		+

Spec defines the desired state of the Channel.



- - - - - - - -
-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
+numPartitions
-map[string]string +int32 		-(Optional) -

Annotations to add to the pod, mostly used for Kube2IAM role

+

NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.
-sink
+replicationFactor
- -Kubernetes core/v1.ObjectReference - +int16 		-(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.

+

ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.
-serviceAccountName
+subscribable
-string +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable 		-

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

+

KafkaChannel conforms to Duck type Subscribable.
@@ -165,20 +128,23 @@ run the Receive Adapter Deployment.

 status
- -AwsSqsSourceStatus + +KafkaChannelStatus 		+(Optional) +

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

CamelSource +

NatssChannel

-

CamelSource is the Schema for the camelsources API

+

NatssChannel is a resource representing a NATSS Channel.

@@ -194,7 +160,7 @@ AwsSqsSourceStatus string @@ -203,7 +169,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -223,51 +190,25 @@ Refer to the Kubernetes API documentation for the fields of the
-sources.knative.dev/v1alpha1 +messaging.knative.dev/v1alpha1
CamelSourceNatssChannel
@@ -215,6 +181,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -CamelSourceSpec + +NatssChannelSpec 		+

Spec defines the desired state of the Channel.



- - - - - - - -
-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
+subscribable
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable 		-(Optional) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

+

NatssChannel conforms to Duck type Subscribable.
@@ -277,20 +218,27 @@ modifications of the event sent to the sink.

 status
- -CamelSourceStatus + +NatssChannelStatus 		+(Optional) +

Status represents the current state of the NatssChannel. This data may be out of +date.
-

CouchDbSource +

KafkaChannelSpec

-

CouchDbSource is the Schema for the githubsources API

+(Appears on: +KafkaChannel) +

+

+

KafkaChannelSpec defines the specification for a KafkaChannel.

@@ -302,135 +250,214 @@ CamelSourceStatus - - - - + + +
-apiVersion
-string		 - -sources.knative.dev/v1alpha1 - +numPartitions
+ +int32 +
-kind
-string +

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

CouchDbSource
-metadata
+replicationFactor
- -Kubernetes meta/v1.ObjectMeta - +int16 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.
-spec
+subscribable
- -CouchDbSourceSpec - +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.

+

+ + + + + + + + +
FieldDescription
-serviceAccountName
+Status
-string +knative.dev/pkg/apis/duck/v1.Status 		-(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.

+

+(Members of Status are embedded into this type.) +

+

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.
-credentials
+AddressStatus
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus 		-

CouchDbCredentials is the credential to use to access CouchDb. -Must be a secret. Only Name and Namespace are used.

+

+(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}
-feed
+SubscribableTypeStatus
- -FeedType - +knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus 		-

Feed changes how CouchDB sends the response. -More information: https://docs.couchdb.org/en/stable/api/database/changes.html#changes-feeds

+

+(Members of SubscribableTypeStatus are embedded into this type.) +

+

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

NatssChannelSpec +

+

+(Appears on: +NatssChannel) +

+

+

NatssChannelSpec defines the specification for a NatssChannel.

+

+ + + + + + + + + +
FieldDescription
-database
+subscribable
-string +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable 		-

Database is the database to watch for changes

+

NatssChannel conforms to Duck type Subscribable.
+

NatssChannelStatus +

+

+(Appears on: +NatssChannel) +

+

+

NatssChannelStatus represents the current state of a NatssChannel.

+

+ + + + + + + + -
FieldDescription
-sink
+Status
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.Status 		-(Optional) -

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

+

+(Members of Status are embedded into this type.) +

+

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 AddressStatus are embedded into this type.) +

+

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}

-status
+SubscribableTypeStatus
- -CouchDbSourceStatus - +knative.dev/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.

-

GitHubSource +
+

messaging.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

KafkaChannel

-

GitHubSource is the Schema for the githubsources API

+

KafkaChannel is a resource representing a Kafka Channel.

@@ -446,7 +473,7 @@ CouchDbSourceStatus string @@ -455,7 +482,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -475,154 +503,175 @@ Refer to the Kubernetes API documentation for the fields of the + +
-sources.knative.dev/v1alpha1 +messaging.knative.dev/v1beta1
GitHubSourceKafkaChannel
@@ -467,6 +494,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -GitHubSourceSpec + +KafkaChannelSpec 		+

Spec defines the desired state of the Channel.



- - -
-serviceAccountName
+numPartitions
-string +int32 		-(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.

+

NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.
-ownerAndRepository
+replicationFactor
-string +int16 		-

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

+

ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.
-eventTypes
+ChannelableSpec
-[]string +knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec 		-

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”

+

+(Members of ChannelableSpec are embedded into this type.) +

+

Channel conforms to Duck type Channelable.
-accessToken
- - -SecretValueFromSource - - -		 -

AccessToken is the Kubernetes secret containing the GitHub -access token

+
-secretToken
+status
- -SecretValueFromSource + +KafkaChannelStatus 		-

SecretToken is the Kubernetes secret containing the GitHub -secret token

+(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.

+

+ + + + + + + + +
FieldDescription
-githubAPIURL
+numPartitions
-string +int32 		-(Optional) -

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

+

NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.
-secure
+replicationFactor
-bool +int16 		-(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).

+

ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.
-SourceSpec
+ChannelableSpec
-knative.dev/pkg/apis/duck/v1.SourceSpec +knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec

-(Members of SourceSpec are embedded into this type.) +(Members of ChannelableSpec are embedded into this type.)

-

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.

+

Channel conforms to Duck type Channelable.
- +

KafkaChannelStatus +

+

+(Appears on: +KafkaChannel) +

+

+

KafkaChannelStatus represents the current state of a KafkaChannel.

+

+ + + + + + +
FieldDescription
-status
+ChannelableStatus
- -GitHubSourceStatus - +knative.dev/eventing/pkg/apis/duck/v1.ChannelableStatus 		+

+(Members of ChannelableStatus are embedded into this type.) +

+

Channel conforms to Duck type Channelable.
-

GitLabSource +
+

bindings.knative.dev/v1beta1

+

+

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

+

+Resource Types: + +

KafkaAuthSpec

-

GitLabSource is the Schema for the gitlabsources API

+(Appears on: +KafkaBindingSpec, +KafkaSourceSpec) +

+

@@ -634,21 +683,42 @@ GitHubSourceStatus - + - + + + +
-apiVersion
-string		 - -sources.knative.dev/v1alpha1 - +bootstrapServers
+ +[]string + +		 +

Bootstrap servers are the Kafka servers the consumer will connect to.
-kind
-string +net
+ + +KafkaNetSpec + + 		GitLabSource +
+

KafkaBinding +

+

+

KafkaBinding is the Schema for the kafkasources API.

+

+ + + + + + + @@ -678,107 +748,162 @@ GitLabSourceSpec
FieldDescription
metadata
@@ -667,8 +737,8 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -GitLabSourceSpec + +KafkaBindingSpec
+ +
-serviceAccountName
+BindingSpec
-string +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec 		-(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.

+

+(Members of BindingSpec are embedded into this type.) +
-projectUrl
+KafkaAuthSpec
-string + +KafkaAuthSpec + 		-

ProjectUrl is the url of the GitLab project for which we are interested -to receive events from. -Examples: -https://gitlab.com/gitlab-org/gitlab-foss

+

+(Members of KafkaAuthSpec are embedded into this type.) +

+
-eventTypes
+status
-[]string + +KafkaBindingStatus + -

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

+ + +

KafkaBindingSpec +

+

+(Appears on: +KafkaBinding) +

+

+

KafkaBindingSpec defines the desired state of the KafkaBinding.

+

+ + + + + + + + + +
FieldDescription
-accessToken
+BindingSpec
- -SecretValueFromSource - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec 		-

AccessToken is the Kubernetes secret containing the GitLab -access token

+

+(Members of BindingSpec are embedded into this type.) +
-secretToken
+KafkaAuthSpec
- -SecretValueFromSource + +KafkaAuthSpec 		-

SecretToken is the Kubernetes secret containing the GitLab -secret token

+

+(Members of KafkaAuthSpec are embedded into this type.) +
+

KafkaBindingStatus +

+

+(Appears on: +KafkaBinding) +

+

+

KafkaBindingStatus defines the observed state of KafkaBinding.

+

+ + + + + + + + + +
FieldDescription
-sslverify
+Status
-bool +knative.dev/pkg/apis/duck/v1.Status 		-

SslVerify if true configure webhook so the ssl verification is done when triggering the hook

+

+(Members of Status are embedded into this type.) +
+

KafkaNetSpec +

+

+(Appears on: +KafkaAuthSpec) +

+

+

+ + + + + + + + - -
FieldDescription
-sink
+sasl
-knative.dev/pkg/apis/duck/v1.Destination + +KafkaSASLSpec + 		-(Optional) -

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

-
-status
+tls
- -GitLabSourceStatus + +KafkaTLSSpec @@ -787,10 +912,13 @@ GitLabSourceStatus -

PrometheusSource +

KafkaSASLSpec

-

PrometheusSource is the Schema for the prometheussources API

+(Appears on: +KafkaNetSpec) +

+

@@ -802,172 +930,123 @@ GitLabSourceStatus - - - - + + +
-apiVersion
-string		 - -sources.knative.dev/v1alpha1 - +enable
+ +bool +
-kind
-string 		PrometheusSource
-metadata
+user
- -Kubernetes meta/v1.ObjectMeta + +SecretValueFromSource 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +(Optional) +

User is the Kubernetes secret containing the SASL username.
-spec
+password
- -PrometheusSourceSpec + +SecretValueFromSource 		-
-
+(Optional) +

Password is the Kubernetes secret containing the SASL password.

+
+

KafkaTLSSpec +

+

+(Appears on: +KafkaNetSpec) +

+

+

+ + + + + + + - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-serviceAccountName
+enable
-string +bool 		-(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
+cert
-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 + +SecretValueFromSource + 		(Optional) -

Query resolution step width in duration format or float number of seconds. -Prometheus duration strings are of the form [0-9]+[smhdwy].

+

Cert is the Kubernetes secret containing the client certificate.
-sink
+key
-knative.dev/pkg/apis/duck/v1.Destination + +SecretValueFromSource + 		(Optional) -

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

-
+

Key is the Kubernetes secret containing the client key.

-status
+caCert
- -PrometheusSourceStatus + +SecretValueFromSource +(Optional) +

CACert is the Kubernetes secret containing the server CA cert.

-

AwsSqsSourceSpec +

SecretValueFromSource

(Appears on: -AwsSqsSource) +KafkaSASLSpec, +KafkaTLSSpec)

-

AwsSqsSourceSpec defines the desired state of the source.

+

SecretValueFromSource represents the source of a secret value

@@ -979,18 +1058,7 @@ PrometheusSourceStatus - - - - + +
-queueUrl
- -string - -		 -

QueueURL of the SQS queue that we will poll from.

-
-awsCredsSecret
+secretKeyRef
Kubernetes core/v1.SecretKeySelector @@ -998,59 +1066,63 @@ Kubernetes core/v1.SecretKeySelector 		-(Optional) -

AwsCredsSecret is the credential to use to poll the AWS SQS

+

The Secret key to select from.
+
+

sources.knative.dev/v1beta1

+

+

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

+

+Resource Types: + +

KafkaLimitsSpec +

+

+(Appears on: +KafkaResourceSpec) +

+

+

+ + - - + + + +
-annotations
- -map[string]string - -		 -(Optional) -

Annotations to add to the pod, mostly used for Kube2IAM role

-		FieldDescription
-sink
+cpu
- -Kubernetes core/v1.ObjectReference - +string 		-(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
+memory
string 		-

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

AwsSqsSourceStatus +

KafkaRequestsSpec

(Appears on: -AwsSqsSource) +KafkaResourceSpec)

-

AwsSqsSourceStatus defines the observed state of the source.

@@ -1062,34 +1134,29 @@ run the Receive Adapter Deployment.

+ + + +
-SourceStatus
+cpu
-knative.dev/pkg/apis/duck/v1.SourceStatus +string + +		 +
+memory
+ +string 		-

-(Members of SourceStatus are embedded into this type.) -

-

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 +

KafkaResourceSpec

-(Appears on: -CamelSourceSpec) -

-

-

CamelSourceOriginSpec is the integration flow to run

@@ -1101,38 +1168,34 @@ Source.

-integration
+requests
-github.com/apache/camel-k/pkg/apis/camel/v1.IntegrationSpec + +KafkaRequestsSpec + 		-

Integration is a kind of source that contains a Camel K integration
-flow
+limits
- -Flow + +KafkaLimitsSpec 		-

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

CamelSourceSpec +

KafkaSource

-(Appears on: -CamelSource) -

-

-

CamelSourceSpec defines the desired state of CamelSource

+

KafkaSource is the Schema for the kafkasources API.

@@ -1144,99 +1207,112 @@ Flow
-source
+metadata
- -CamelSourceOriginSpec + +Kubernetes meta/v1.ObjectMeta 		-

Source is the reference to the integration flow to run.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-sink
+spec
-knative.dev/pkg/apis/duck/v1beta1.Destination + +KafkaSourceSpec + 		-(Optional) -

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

+
+
+ + + + - -
+KafkaAuthSpec
+ + +KafkaAuthSpec + + +		 +

+(Members of KafkaAuthSpec are embedded into this type.) +
-ceOverrides
+topics
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides +[]string 		-(Optional) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

+

Topic topics to consume messages from
-

CamelSourceStatus -

-

-(Appears on: -CamelSource) -

-

-

CamelSourceStatus defines the observed state of CamelSource

-

- - - - + + - - + +
FieldDescription +consumerGroup
+ +string + +		 +(Optional) +

ConsumerGroupID is the consumer group ID.

+
-Status
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.SourceSpec

-(Members of Status are embedded into this type.) +(Members of SourceSpec 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.

+

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.

+
-sinkUri
+status
-string + +KafkaSourceStatus + 		-(Optional) -

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

CouchDbSourceSpec +

KafkaSourceSpec

(Appears on: -CouchDbSource) +KafkaSource)

-

CouchDbSourceSpec defines the desired state of CouchDbSource

+

KafkaSourceSpec defines the desired state of the KafkaSource.

@@ -1248,80 +1324,70 @@ string - - - -
-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
+KafkaAuthSpec
- -Kubernetes core/v1.ObjectReference + +KafkaAuthSpec 		-

CouchDbCredentials is the credential to use to access CouchDb. -Must be a secret. Only Name and Namespace are used.

+

+(Members of KafkaAuthSpec are embedded into this type.) +
-feed
+topics
- -FeedType - +[]string 		-

Feed changes how CouchDB sends the response. -More information: https://docs.couchdb.org/en/stable/api/database/changes.html#changes-feeds

+

Topic topics to consume messages from
-database
+consumerGroup
string 		-

Database is the database to watch for changes

+(Optional) +

ConsumerGroupID is the consumer group ID.
-sink
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.SourceSpec 		-(Optional) -

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

+

+(Members of SourceSpec are embedded into this type.) +

+

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.
-

CouchDbSourceStatus +

KafkaSourceStatus

(Appears on: -CouchDbSource) +KafkaSource)

-

CouchDbSourceStatus defines the observed state of CouchDbSource

+

KafkaSourceStatus defines the observed state of KafkaSource.

@@ -1353,32 +1419,29 @@ Source.

-

FeedType -(string alias)

-

-(Appears on: -CouchDbSourceSpec) -

-

-

FeedType is the type of Feed

-

-

Flow -(map[string]interface{} alias)

-

-(Appears on: -CamelSourceOriginSpec) -

+
+

sources.knative.dev/v1alpha1

-

Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL

+

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

-

GitHubSourceSpec +Resource Types: + +

AwsSqsSource

-(Appears on: -GitHubSource) -

-

-

GitHubSourceSpec defines the desired state of GitHubSource

+

AwsSqsSource is the Schema for the AWS SQS API

@@ -1390,182 +1453,133 @@ Source.

+ + + + - +
+
+
-serviceAccountName
- -string - +apiVersion
+string		 + +sources.knative.dev/v1alpha1 +
-(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.

+kind
+string 		AwsSqsSource
-ownerAndRepository
+metadata
-string + +Kubernetes meta/v1.ObjectMeta + 		-

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

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-eventTypes
+spec
-[]string + +AwsSqsSourceSpec + 		-

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
+queueUrl
- -SecretValueFromSource - +string 		-

AccessToken is the Kubernetes secret containing the GitHub -access token

+

QueueURL of the SQS queue that we will poll from.
-secretToken
+awsCredsSecret
- -SecretValueFromSource + +Kubernetes core/v1.SecretKeySelector 		-

SecretToken is the Kubernetes secret containing the GitHub -secret token

+(Optional) +

AwsCredsSecret is the credential to use to poll the AWS SQS
-githubAPIURL
+annotations
-string +map[string]string 		(Optional) -

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

+

Annotations to add to the pod, mostly used for Kube2IAM role
-secure
+sink
-bool + +Kubernetes core/v1.ObjectReference + 		(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).

+

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.
-SourceSpec
+serviceAccountName
-knative.dev/pkg/apis/duck/v1.SourceSpec +string 		-

-(Members of SourceSpec are embedded into this type.) -

-

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.

+

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

GitHubSourceStatus -

-

-(Appears on: -GitHubSource) -

-

-

GitHubSourceStatus defines the observed state of GitHubSource

-

- - - - - - - - - - -
FieldDescription
-SourceStatus
- -knative.dev/pkg/apis/duck/v1.SourceStatus - -		 -

-(Members of SourceStatus are embedded into this type.) -

-

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
+status
-string + +AwsSqsSourceStatus + 		-

WebhookIDKey is the ID of the webhook registered with GitHub
-

GitLabSourceSpec +

CamelSource

-(Appears on: -GitLabSource) -

-

-

GitLabSourceSpec defines the desired state of GitLabSource

+

CamelSource is the Schema for the camelsources API

@@ -1577,108 +1591,107 @@ string + + + + - +
+
+
-serviceAccountName
- -string - +apiVersion
+string		 + +sources.knative.dev/v1alpha1 +
-(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.

+kind
+string 		CamelSource
-projectUrl
+metadata
-string + +Kubernetes meta/v1.ObjectMeta + 		-

ProjectUrl is the url of the GitLab project for which we are interested -to receive events from. -Examples: -https://gitlab.com/gitlab-org/gitlab-foss

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-eventTypes
+spec
-[]string + +CamelSourceSpec + 		-

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
+source
- -SecretValueFromSource + +CamelSourceOriginSpec 		-

AccessToken is the Kubernetes secret containing the GitLab -access token

+

Source is the reference to the integration flow to run.
-secretToken
+sink
- -SecretValueFromSource - +knative.dev/pkg/apis/duck/v1beta1.Destination 		-

SecretToken is the Kubernetes secret containing the GitLab -secret token

+(Optional) +

Sink is a reference to an object that will resolve to a domain name to use as the sink.
-sslverify
+ceOverrides
-bool +knative.dev/pkg/apis/duck/v1.CloudEventOverrides 		-

SslVerify if true configure webhook so the ssl verification is done when triggering the hook

+(Optional) +

CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.

+
-sink
+status
-knative.dev/pkg/apis/duck/v1.Destination + +CamelSourceStatus + -(Optional) -

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

-

GitLabSourceStatus +

CouchDbSource

-(Appears on: -GitLabSource) -

-

-

GitLabSourceStatus defines the observed state of GitLabSource

+

CouchDbSource is the Schema for the githubsources API

@@ -1690,147 +1703,123 @@ name to use as the sink.

+ + + + - -
-SourceStatus
- -knative.dev/pkg/apis/duck/v1.SourceStatus - +apiVersion
+string		 + +sources.knative.dev/v1alpha1 +
-

-(Members of SourceStatus are embedded into this type.) -

-

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.

+kind
+string 		CouchDbSource
-Id
+metadata
-string + +Kubernetes meta/v1.ObjectMeta + 		-

ID of the project hook registered with GitLab

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-

KafkaLimitsSpec -

-

-(Appears on: -KafkaResourceSpec) -

-

-

- - - - - - - + + @@ -1839,10 +1828,10 @@ KafkaLimitsSpec
FieldDescription
+spec
+ + +CouchDbSourceSpec + + +		 +
+
+ - -
-cpu
+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.
-memory
+credentials
-string + +Kubernetes core/v1.ObjectReference + 		+

CouchDbCredentials is the credential to use to access CouchDb. +Must be a secret. Only Name and Namespace are used.
-

KafkaRequestsSpec -

-

-(Appears on: -KafkaResourceSpec) -

-

-

- - - - - - - - - -
FieldDescription
-cpu
+feed
-string + +FeedType + 		+

Feed changes how CouchDB sends the response. +More information: https://docs.couchdb.org/en/stable/api/database/changes.html#changes-feeds
-memory
+database
string 		+

Database is the database to watch for changes
-

KafkaResourceSpec -

-

-(Appears on: -KafkaSourceSpec) -

-

-

- - - - - - - - + +
FieldDescription
-requests
+sink
- -KafkaRequestsSpec - +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.

+
-limits
+status
- -KafkaLimitsSpec + +CouchDbSourceStatus
-

KafkaSource +

GitHubSource

-

KafkaSource is the Schema for the kafkasources API.

+

GitHubSource is the Schema for the githubsources API

@@ -1854,6 +1843,23 @@ KafkaLimitsSpec + + + + + + + + @@ -1881,79 +1887,120 @@ KafkaSourceSpec
+apiVersion
+string		 + +sources.knative.dev/v1alpha1 + +
+kind
+string +		GitHubSource
metadata
@@ -1870,8 +1876,8 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -KafkaSourceSpec + +GitHubSourceSpec
+ + + + + + + +
-KafkaAuthSpec
+serviceAccountName
- -KafkaAuthSpec - +string 		-

-(Members of KafkaAuthSpec are embedded into this type.) -

+(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.
-topics
+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 		-

Topic topics to consume messages from

+

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”
-consumerGroup
+accessToken
-string + +SecretValueFromSource + 		-(Optional) -

ConsumerGroupID is the consumer group ID.

+

AccessToken is the Kubernetes secret containing the GitHub +access token
-sink
+secretToken
-knative.dev/pkg/apis/duck/v1.Destination + +SecretValueFromSource + 		-(Optional) -

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

+

SecretToken is the Kubernetes secret containing the GitHub +secret token
-serviceAccountName
+githubAPIURL
string 		-

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. -Deprecated: v1beta1 drops this field.

+(Optional) +

API URL if using github enterprise (default https://api.github.com)
-resources
+secure
- -KafkaResourceSpec - +bool 		-

Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

+(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).

+
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.
@@ -1963,8 +2010,8 @@ Deprecated: v1beta1 drops this field.

status
- -KafkaSourceStatus + +GitHubSourceStatus @@ -1973,14 +2020,10 @@ KafkaSourceStatus -

KafkaSourceSpec +

GitLabSource

-(Appears on: -KafkaSource) -

-

-

KafkaSourceSpec defines the desired state of the KafkaSource.

+

GitLabSource is the Schema for the gitlabsources API

@@ -1992,40 +2035,127 @@ KafkaSourceStatus + + + + + + + + + + + + +
-KafkaAuthSpec
+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 + + +		 +
+
+ + + + + + + + + + + + + + + @@ -2037,46 +2167,31 @@ knative.dev/pkg/apis/duck/v1.Destination - - -
+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 for which we are interested +to receive events from. +Examples: +https://gitlab.com/gitlab-org/gitlab-foss

+
+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
- -KafkaAuthSpec + +SecretValueFromSource 		-

-(Members of KafkaAuthSpec are embedded into this type.) -

+

AccessToken is the Kubernetes secret containing the GitLab +access token
-topics
+secretToken
-[]string + +SecretValueFromSource + 		-

Topic topics to consume messages from

+

SecretToken is the Kubernetes secret containing the GitLab +secret token
-consumerGroup
+sslverify
-string +bool 		-(Optional) -

ConsumerGroupID is the consumer group ID.

+

SslVerify if true configure webhook so the ssl verification is done when triggering the hook
(Optional) -

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

+

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
+status
- -KafkaResourceSpec + +GitLabSourceStatus 		-

Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.
-

KafkaSourceStatus +

PrometheusSource

-(Appears on: -KafkaSource) -

-

-

KafkaSourceStatus defines the observed state of KafkaSource.

+

PrometheusSource is the Schema for the prometheussources API

@@ -2088,43 +2203,48 @@ Deprecated: v1beta1 drops this field.

+ + + + + + + + - -
-SourceStatus
+apiVersion
+string		 + +sources.knative.dev/v1alpha1 + +
+kind
+string +		PrometheusSource
+metadata
-knative.dev/pkg/apis/duck/v1.SourceStatus + +Kubernetes meta/v1.ObjectMeta + 		-

-(Members of SourceStatus are embedded into this type.) -

-

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.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-

PrometheusSourceSpec -

-

-(Appears on: -PrometheusSource) -

-

-

PrometheusSourceSpec defines the desired state of PrometheusSource

-

- - - - - - - + +
FieldDescription
+spec
+ + +PrometheusSourceSpec + + +		 +
+
+ -
serviceAccountName
@@ -2224,237 +2344,114 @@ knative.dev/pkg/apis/duck/v1.Destination name to use as the sink.
-

PrometheusSourceStatus -

-

-(Appears on: -PrometheusSource) -

-

-

PrometheusSourceStatus defines the observed state of PrometheusSource

-

- - - - - - - - - - - - -
FieldDescription
-SourceStatus
- -knative.dev/pkg/apis/duck/v1.SourceStatus - -		 -

-(Members of SourceStatus are embedded into this type.) -

-

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: -GitLabSourceSpec) -

-

-

SecretValueFromSource represents the source of a secret value

-

- - - - - - - -
FieldDescription
-secretKeyRef
+status
- -Kubernetes core/v1.SecretKeySelector + +PrometheusSourceStatus 		-

The Secret key to select from.
-

SecretValueFromSource +

AwsSqsSourceSpec

(Appears on: -GitHubSourceSpec) -

-

-

SecretValueFromSource represents the source of a secret value

-

- - - - - - - - - - - - - -
FieldDescription
-secretKeyRef
- - -Kubernetes core/v1.SecretKeySelector - - -		 -

The Secret key to select from.

-
-
-

bindings.knative.dev/v1alpha1

-

-

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

+AwsSqsSource)

-Resource Types: - -

GitHubBinding -

-

GitHubBinding describes a Binding that is also a Source. -The sink (from the Source duck) is resolved to a URL and -then projected into the subject by augmenting the runtime -contract of the referenced containers to have a K_SINK -environment variable holding the endpoint to which to send -cloud events.

+

AwsSqsSourceSpec defines the desired state of the source.

- - - - - - - - - - - - - + + + + +
FieldDescription
-apiVersion
-string		 - -bindings.knative.dev/v1alpha1 - -
-kind
-string -		GitHubBinding
FieldDescription
-metadata
+queueUrl
- -Kubernetes meta/v1.ObjectMeta - +string 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

QueueURL of the SQS queue that we will poll from.
-spec
+awsCredsSecret
- -GitHubBindingSpec + +Kubernetes core/v1.SecretKeySelector 		-
-
- +(Optional) +

AwsCredsSecret is the credential to use to poll the AWS SQS

+ + - -
-BindingSpec
+annotations
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +map[string]string 		-

-(Members of BindingSpec are embedded into this type.) -

+(Optional) +

Annotations to add to the pod, mostly used for Kube2IAM role
-accessToken
+sink
- -SecretValueFromSource + +Kubernetes core/v1.ObjectReference 		-

AccessToken is the Kubernetes secret containing the GitHub -access token

-
+(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.
-status
+serviceAccountName
- -GitHubBindingStatus - +string 		+

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

GitLabBinding +

AwsSqsSourceStatus

-

GitLabBinding describes a Binding that is also a Source. -The sink (from the Source duck) is resolved to a URL and -then projected into the subject by augmenting the runtime -contract of the referenced containers to have a K_SINK -environment variable holding the endpoint to which to send -cloud events.

+(Appears on: +AwsSqsSource) +

+

+

AwsSqsSourceStatus defines the observed state of the source.

@@ -2466,100 +2463,134 @@ cloud events.

+SourceStatus
+ +knative.dev/pkg/apis/duck/v1.SourceStatus + + + +
-apiVersion
-string		 - -bindings.knative.dev/v1alpha1 - +

+(Members of SourceStatus are embedded into this type.) +

+

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

+

+ + - - + + + + + + +
-kind
-string -		GitLabBindingFieldDescription
-metadata
+integration
- -Kubernetes meta/v1.ObjectMeta - +github.com/apache/camel-k/pkg/apis/camel/v1.IntegrationSpec 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

Integration is a kind of source that contains a Camel K integration
-spec
+flow
- -GitLabBindingSpec + +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

+

+ + + + + + + - -
FieldDescription
-BindingSpec
+source
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +CamelSourceOriginSpec + 		-

-(Members of BindingSpec are embedded into this type.) -

+

Source is the reference to the integration flow to run.
-accessToken
+sink
- -SecretValueFromSource - +knative.dev/pkg/apis/duck/v1beta1.Destination 		-

AccessToken is the Kubernetes secret containing the GitLab -access token

-
+(Optional) +

Sink is a reference to an object that will resolve to a domain name to use as the sink.
-status
+ceOverrides
- -GitLabBindingStatus - +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.
-

GitHubBindingSpec +

CamelSourceStatus

(Appears on: -GitHubBinding) +CamelSource)

-

GitHubBindingSpec holds the desired state of the GitHubBinding (from the client).

+

CamelSourceStatus defines the observed state of CamelSource

@@ -2571,41 +2602,42 @@ GitLabBindingStatus
-BindingSpec
+Status
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +knative.dev/pkg/apis/duck/v1.Status

-(Members of BindingSpec are embedded into this type.) +(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.
-accessToken
+sinkUri
- -SecretValueFromSource - +string 		-

AccessToken is the Kubernetes secret containing the GitHub -access token

+(Optional) +

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

GitHubBindingStatus +

CouchDbSourceSpec

(Appears on: -GitHubBinding) +CouchDbSource)

-

GitHubBindingStatus communicates the observed state of the GitHubBinding (from the controller).

+

CouchDbSourceSpec defines the desired state of CouchDbSource

@@ -2617,73 +2649,80 @@ access token

- -
-SourceStatus
+serviceAccountName
-knative.dev/pkg/apis/duck/v1.SourceStatus +string 		-

-(Members of SourceStatus are embedded into this type.) -

+(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.
-

GitLabBindingSpec -

-

-(Appears on: -GitLabBinding) -

-

-

GitLabBindingSpec holds the desired state of the GitLabBinding (from the client).

-

- - - - + + + + + + - -
FieldDescription +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

+
-BindingSpec
+database
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +string 		-

-(Members of BindingSpec are embedded into this type.) -

+

Database is the database to watch for changes
-accessToken
+sink
- -SecretValueFromSource - +knative.dev/pkg/apis/duck/v1.Destination 		-

AccessToken is the Kubernetes secret containing the GitLab -access token

+(Optional) +

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

GitLabBindingStatus +

CouchDbSourceStatus

(Appears on: -GitLabBinding) +CouchDbSource)

-

GitLabBindingStatus communicates the observed state of the GitLabBinding (from the controller).

+

CouchDbSourceStatus defines the observed state of CouchDbSource

@@ -2704,18 +2743,43 @@ knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)

+

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.

-

KafkaAuthSpec +

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: -KafkaBindingSpec, -KafkaSourceSpec) +GitHubSource)

+

GitHubSourceSpec defines the desired state of GitHubSource

@@ -2727,169 +2791,132 @@ knative.dev/pkg/apis/duck/v1.SourceStatus - -
-bootstrapServers
+serviceAccountName
-[]string +string 		-

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

+(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.
-net
+ownerAndRepository
- -KafkaNetSpec - +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
-

KafkaBinding -

-

-

KafkaBinding is the Schema for the kafkasources API.

-

- - - - - - - - - -
FieldDescription
-metadata
+eventTypes
- -Kubernetes meta/v1.ObjectMeta - +[]string 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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”
-spec
+accessToken
- -KafkaBindingSpec + +SecretValueFromSource 		-
-
- - - - - -
-BindingSpec
- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -		 -

-(Members of BindingSpec are embedded into this type.) -

+

AccessToken is the Kubernetes secret containing the GitHub +access token
-KafkaAuthSpec
+secretToken
- -KafkaAuthSpec + +SecretValueFromSource 		-

-(Members of KafkaAuthSpec are embedded into this type.) -

-
+

SecretToken is the Kubernetes secret containing the GitHub +secret token
-status
+githubAPIURL
- -KafkaBindingStatus - +string 		+(Optional) +

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

KafkaBindingSpec -

-

-(Appears on: -KafkaBinding) -

-

-

KafkaBindingSpec defines the desired state of the KafkaBinding.

-

- - - - - - - -
FieldDescription
-BindingSpec
+secure
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +bool 		-

-(Members of BindingSpec are embedded into this type.) -

+(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).
-KafkaAuthSpec
+SourceSpec
- -KafkaAuthSpec - +knative.dev/pkg/apis/duck/v1.SourceSpec

-(Members of KafkaAuthSpec are embedded into this type.) +(Members of SourceSpec are embedded into this type.)

+

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.
-

KafkaBindingStatus +

GitHubSourceStatus

(Appears on: -KafkaBinding) +GitHubSource)

-

KafkaBindingStatus defines the observed state of KafkaBinding.

+

GitHubSourceStatus defines the observed state of GitHubSource

@@ -2901,68 +2928,45 @@ KafkaAuthSpec - - -
-Status
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.SourceStatus

-(Members of Status are embedded into this type.) -

-
-

KafkaNetSpec -

-

-(Appears on: -KafkaAuthSpec) -

-

+(Members of SourceStatus are embedded into this type.)

- - - - - - - - - - -
FieldDescription
-sasl
- - -KafkaSASLSpec - - -		 +

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.
-tls
+webhookIDKey
- -KafkaTLSSpec - +string 		+

WebhookIDKey is the ID of the webhook registered with GitHub
-

KafkaSASLSpec +

GitLabSourceSpec

(Appears on: -KafkaNetSpec) +GitLabSource)

+

GitLabSourceSpec defines the desired state of GitLabSource

@@ -2974,122 +2978,108 @@ KafkaTLSSpec - -
-enable
+serviceAccountName
-bool +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.
-user
+projectUrl
- -SecretValueFromSource - +string 		-(Optional) -

User is the Kubernetes secret containing the SASL username.

+

ProjectUrl is the url of the GitLab project for which we are interested +to receive events from. +Examples: +https://gitlab.com/gitlab-org/gitlab-foss
-password
+eventTypes
- -SecretValueFromSource - +[]string 		-(Optional) -

Password is the Kubernetes secret containing the SASL password.

+

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
-

KafkaTLSSpec -

-

-(Appears on: -KafkaNetSpec) -

-

-

- - - - - - - -
FieldDescription
-enable
+accessToken
-bool + +SecretValueFromSource + 		+

AccessToken is the Kubernetes secret containing the GitLab +access token
-cert
+secretToken
- + SecretValueFromSource 		-(Optional) -

Cert is the Kubernetes secret containing the client certificate.

+

SecretToken is the Kubernetes secret containing the GitLab +secret token
-key
+sslverify
- -SecretValueFromSource - +bool 		-(Optional) -

Key is the Kubernetes secret containing the client key.

+

SslVerify if true configure webhook so the ssl verification is done when triggering the hook
-caCert
+sink
- -SecretValueFromSource - +knative.dev/pkg/apis/duck/v1.Destination 		(Optional) -

CACert is the Kubernetes secret containing the server CA cert.

+

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

SecretValueFromSource +

GitLabSourceStatus

(Appears on: -GitHubBindingSpec) +GitLabSource)

-

SecretValueFromSource represents the source of a secret value

+

GitLabSourceStatus defines the observed state of GitLabSource

@@ -3101,60 +3091,44 @@ SecretValueFromSource - - -
-secretKeyRef
+SourceStatus
- -Kubernetes core/v1.SecretKeySelector - +knative.dev/pkg/apis/duck/v1.SourceStatus 		-

The Secret key to select from.

-
-

SecretValueFromSource -

-

-(Appears on: -KafkaSASLSpec, -KafkaTLSSpec) -

-

SecretValueFromSource represents the source of a secret value

+(Members of SourceStatus are embedded into this type.)

- - - - - +

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.

+ - -
FieldDescription
-secretKeyRef
+Id
- -Kubernetes core/v1.SecretKeySelector - +string 		-

The Secret key to select from.

+

ID of the project hook registered with GitLab
-

SecretValueFromSource +

KafkaLimitsSpec

(Appears on: -GitLabBindingSpec) +KafkaResourceSpec)

-

SecretValueFromSource represents the source of a secret value

@@ -3166,34 +3140,33 @@ Kubernetes core/v1.SecretKeySelector + + + +
-secretKeyRef
+cpu
- -Kubernetes core/v1.SecretKeySelector - +string + +		 +
+memory
+ +string 		-

The Secret key to select from.
-
-

messaging.knative.dev/v1alpha1

+

KafkaRequestsSpec +

-

Package v1alpha1 is the v1alpha1 version of the API.

+(Appears on: +KafkaResourceSpec)

-Resource Types: - -

KafkaChannel -

-

KafkaChannel is a resource representing a Kafka Channel.

@@ -3205,107 +3178,72 @@ Resource Types: - - - - - - - - -
-apiVersion
-string		 - -messaging.knative.dev/v1alpha1 - -
-kind
-string -		KafkaChannel
-metadata
+cpu
- -Kubernetes meta/v1.ObjectMeta - +string 		-(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
+memory
-int32 +string 		-

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

KafkaResourceSpec +

+

+(Appears on: +KafkaSourceSpec) +

+

+

+ + - - + + + + - -
-replicationFactor
- -int16 - -		 -

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

-		FieldDescription
-subscribable
+requests
-knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable + +KafkaRequestsSpec + 		-

KafkaChannel conforms to Duck type Subscribable.

-
-status
+limits
- -KafkaChannelStatus + +KafkaLimitsSpec 		-(Optional) -

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

NatssChannel +

KafkaSource

-

NatssChannel is a resource representing a NATSS Channel.

+

KafkaSource is the Schema for the kafkasources API.

@@ -3317,23 +3255,6 @@ date.

- - - - - - - - @@ -3351,107 +3271,117 @@ Refer to the Kubernetes API documentation for the fields of the + + - -
-apiVersion
-string		 - -messaging.knative.dev/v1alpha1 - -
-kind
-string -		NatssChannel
metadata
@@ -3342,7 +3263,6 @@ Kubernetes meta/v1.ObjectMeta 		-(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -NatssChannelSpec + +KafkaSourceSpec 		-

Spec defines the desired state of the Channel.



-
-subscribable
+KafkaAuthSpec
-knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable + +KafkaAuthSpec + 		-

NatssChannel conforms to Duck type Subscribable.

+

+(Members of KafkaAuthSpec are embedded into this type.) +
+
+topics
+ +[]string + +		 +

Topic topics to consume messages from
-status
+consumerGroup
- -NatssChannelStatus - +string 		(Optional) -

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

+

ConsumerGroupID is the consumer group ID.
-

KafkaChannelSpec -

-

-(Appears on: -KafkaChannel) -

-

-

KafkaChannelSpec defines the specification for a KafkaChannel.

-

- - - - + + - - + +
FieldDescription +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.

+
-numPartitions
+serviceAccountName
-int32 +string 		-

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

+

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. +Deprecated: v1beta1 drops this field.
-replicationFactor
+resources
-int16 + +KafkaResourceSpec + 		-

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

+

Resource limits and Request specifications of the Receive Adapter Deployment +Deprecated: v1beta1 drops this field.

+
-subscribable
+status
-knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable + +KafkaSourceStatus + -

KafkaChannel conforms to Duck type Subscribable.

-

KafkaChannelStatus +

KafkaSourceSpec

(Appears on: -KafkaChannel) +KafkaSource)

-

KafkaChannelStatus represents the current state of a KafkaChannel.

+

KafkaSourceSpec defines the desired state of the KafkaSource.

@@ -3463,91 +3393,91 @@ knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable - -
-Status
+KafkaAuthSpec
-knative.dev/pkg/apis/duck/v1.Status + +KafkaAuthSpec +

-(Members of Status are embedded into this type.) +(Members of KafkaAuthSpec are embedded into this type.)

-

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
+topics
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus +[]string 		-

-(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}

+

Topic topics to consume messages from
-SubscribableTypeStatus
+consumerGroup
-knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus +string 		-

-(Members of SubscribableTypeStatus are embedded into this type.) -

-

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

+(Optional) +

ConsumerGroupID is the consumer group ID.
-

NatssChannelSpec -

-

-(Appears on: -NatssChannel) -

-

-

NatssChannelSpec defines the specification for a NatssChannel.

-

- - - - + + - - + + + +
FieldDescription +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.

+
-subscribable
+serviceAccountName
-knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable +string 		-

NatssChannel conforms to Duck type Subscribable.

+

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.
-

NatssChannelStatus +

KafkaSourceStatus

(Appears on: -NatssChannel) +KafkaSource)

-

NatssChannelStatus represents the current state of a NatssChannel.

+

KafkaSourceStatus defines the observed state of KafkaSource.

@@ -3559,66 +3489,34 @@ knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable - - - - - - - -
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-

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 AddressStatus are embedded into this type.) -

-

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
+SourceStatus
-knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus +knative.dev/pkg/apis/duck/v1.SourceStatus

-(Members of SubscribableTypeStatus are embedded into this type.) +(Members of SourceStatus are embedded into this type.)

-

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

+

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/v1beta1

+

PrometheusSourceSpec +

-

Package v1beta1 is the v1beta1 version of the API.

+(Appears on: +PrometheusSource)

-Resource Types: - -

KafkaChannel -

-

KafkaChannel is a resource representing a Kafka Channel.

+

PrometheusSourceSpec defines the desired state of PrometheusSource

@@ -3630,114 +3528,113 @@ Resource Types: +serviceAccountName
+ +string + + + -
-apiVersion
-string		 - -messaging.knative.dev/v1beta1 - +(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.
-kind
+serverURL
+ string + +		 +

ServerURL is the URL of the Prometheus server

KafkaChannel
-metadata
+promQL
- -Kubernetes meta/v1.ObjectMeta - +string 		-(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

PromQL is the Prometheus query for this source
-spec
+authTokenFile
- -KafkaChannelSpec - +string 		-

Spec defines the desired state of the Channel.

-
-
- +(Optional) +

The name of the file containing the authenication token

+ + - -
-numPartitions
+caCertConfigMap
-int32 +string 		-

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

+(Optional) +

The name of the config map containing the CA certificate of the +Prometheus service’s signer.
-replicationFactor
+schedule
-int16 +string 		-

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

+

A crontab-formatted schedule for running the PromQL query
-ChannelableSpec
+step
-knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec +string 		-

-(Members of ChannelableSpec are embedded into this type.) -

-

Channel conforms to Duck type Channelable.

-
+(Optional) +

Query resolution step width in duration format or float number of seconds. +Prometheus duration strings are of the form [0-9]+[smhdwy].
-status
+sink
- -KafkaChannelStatus - +knative.dev/pkg/apis/duck/v1.Destination 		(Optional) -

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

+

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

KafkaChannelSpec +

PrometheusSourceStatus

(Appears on: -KafkaChannel) +PrometheusSource)

-

KafkaChannelSpec defines the specification for a KafkaChannel.

+

PrometheusSourceStatus defines the observed state of PrometheusSource

@@ -3749,50 +3646,66 @@ date.

+ +
-numPartitions
+SourceStatus
-int32 +knative.dev/pkg/apis/duck/v1.SourceStatus 		-

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

+

+(Members of SourceStatus are embedded into this type.) +

+

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: +GitHubSourceSpec) +

+

+

SecretValueFromSource represents the source of a secret value

+

+ + - - + + + +
-replicationFactor
- -int16 - -		 -

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

-		FieldDescription
-ChannelableSpec
+secretKeyRef
-knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec + +Kubernetes core/v1.SecretKeySelector + 		-

-(Members of ChannelableSpec are embedded into this type.) -

-

Channel conforms to Duck type Channelable.

+

The Secret key to select from.
-

KafkaChannelStatus +

SecretValueFromSource

(Appears on: -KafkaChannel) +GitLabSourceSpec)

-

KafkaChannelStatus represents the current state of a KafkaChannel.

+

SecretValueFromSource represents the source of a secret value

@@ -3804,61 +3717,128 @@ knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec
-ChannelableStatus
+secretKeyRef
-knative.dev/eventing/pkg/apis/duck/v1.ChannelableStatus + +Kubernetes core/v1.SecretKeySelector + 		-

-(Members of ChannelableStatus are embedded into this type.) -

-

Channel conforms to Duck type Channelable.

+

The Secret key to select from.
-

bindings.knative.dev/v1beta1

+

bindings.knative.dev/v1alpha1

-

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

+

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

Resource Types: - -

KafkaAuthSpec + +

GitHubBinding

-(Appears on: -KafkaBindingSpec, -KafkaSourceSpec) -

-

+

GitHubBinding describes a Binding that is also a Source. +The sink (from the Source duck) is resolved to a URL and +then projected into the subject by augmenting the runtime +contract of the referenced containers to have a K_SINK +environment variable holding the endpoint to which to send +cloud events.

- + + + + + + + + + + + + + + + + + + + + + + @@ -3867,10 +3847,15 @@ KafkaNetSpec
FieldDescription
+apiVersion
+string		 + +bindings.knative.dev/v1alpha1 + +
+kind
+string +		GitHubBinding
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +GitHubBindingSpec + + +		 +
+
+ - - + + - - + +
FieldDescription +BindingSpec
+ +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +		 +

+(Members of BindingSpec are embedded into this type.) +

+
-bootstrapServers
+accessToken
-[]string + +SecretValueFromSource + 		-

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

+

AccessToken is the Kubernetes secret containing the GitHub +access token

+
-net
+status
- -KafkaNetSpec + +GitHubBindingStatus
-

KafkaBinding +

GitLabBinding

-

KafkaBinding is the Schema for the kafkasources API.

+

GitLabBinding describes a Binding that is also a Source. +The sink (from the Source duck) is resolved to a URL and +then projected into the subject by augmenting the runtime +contract of the referenced containers to have a K_SINK +environment variable holding the endpoint to which to send +cloud events.

@@ -3882,6 +3867,23 @@ KafkaNetSpec + + + + + + + + @@ -3922,17 +3924,16 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+apiVersion
+string		 + +bindings.knative.dev/v1alpha1 + +
+kind
+string +		GitLabBinding
metadata
@@ -3898,8 +3900,8 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -KafkaBindingSpec + +GitLabBindingSpec
-KafkaAuthSpec
+accessToken
- -KafkaAuthSpec + +SecretValueFromSource 		-

-(Members of KafkaAuthSpec are embedded into this type.) -

+

AccessToken is the Kubernetes secret containing the GitLab +access token
@@ -3942,8 +3943,8 @@ KafkaAuthSpec status
- -KafkaBindingStatus + +GitLabBindingStatus @@ -3952,14 +3953,14 @@ KafkaBindingStatus -

KafkaBindingSpec +

GitHubBindingSpec

(Appears on: -KafkaBinding) +GitHubBinding)

-

KafkaBindingSpec defines the desired state of the KafkaBinding.

+

GitHubBindingSpec holds the desired state of the GitHubBinding (from the client).

@@ -3984,29 +3985,28 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
-KafkaAuthSpec
+accessToken
- -KafkaAuthSpec + +SecretValueFromSource 		-

-(Members of KafkaAuthSpec are embedded into this type.) -

+

AccessToken is the Kubernetes secret containing the GitHub +access token
-

KafkaBindingStatus +

GitHubBindingStatus

(Appears on: -KafkaBinding) +GitHubBinding)

-

KafkaBindingStatus defines the observed state of KafkaBinding.

+

GitHubBindingStatus communicates the observed state of the GitHubBinding (from the controller).

@@ -4018,26 +4018,27 @@ KafkaAuthSpec
-Status
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.SourceStatus

-(Members of Status are embedded into this type.) +(Members of SourceStatus are embedded into this type.)

-

KafkaNetSpec +

GitLabBindingSpec

(Appears on: -KafkaAuthSpec) +GitLabBinding)

+

GitLabBindingSpec holds the desired state of the GitLabBinding (from the client).

@@ -4049,37 +4050,41 @@ knative.dev/pkg/apis/duck/v1.Status
-sasl
+BindingSpec
- -KafkaSASLSpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec 		+

+(Members of BindingSpec are embedded into this type.) +
-tls
+accessToken
- -KafkaTLSSpec + +SecretValueFromSource 		+

AccessToken is the Kubernetes secret containing the GitLab +access token
-

KafkaSASLSpec +

GitLabBindingStatus

(Appears on: -KafkaNetSpec) +GitLabBinding)

+

GitLabBindingStatus communicates the observed state of the GitLabBinding (from the controller).

@@ -4091,51 +4096,65 @@ KafkaTLSSpec + +
-enable
+SourceStatus
-bool +knative.dev/pkg/apis/duck/v1.SourceStatus 		+

+(Members of SourceStatus are embedded into this type.) +
+

KafkaAuthSpec +

+

+(Appears on: +KafkaBindingSpec, +KafkaSourceSpec) +

+

+

+ + + + + + + +
FieldDescription
-user
+bootstrapServers
- -SecretValueFromSource - +[]string 		-(Optional) -

User is the Kubernetes secret containing the SASL username.

+

Bootstrap servers are the Kafka servers the consumer will connect to.
-password
+net
- -SecretValueFromSource + +KafkaNetSpec 		-(Optional) -

Password is the Kubernetes secret containing the SASL password.
-

KafkaTLSSpec +

KafkaBinding

-(Appears on: -KafkaNetSpec) -

-

+

KafkaBinding is the Schema for the kafkasources API.

@@ -4147,105 +4166,84 @@ SecretValueFromSource - +
+
+
-enable
+metadata
-bool + +Kubernetes meta/v1.ObjectMeta + 		+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-cert
+spec
- -SecretValueFromSource + +KafkaBindingSpec 		-(Optional) -

Cert is the Kubernetes secret containing the client certificate.

-
-
-key
+BindingSpec
- -SecretValueFromSource - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec 		-(Optional) -

Key is the Kubernetes secret containing the client key.

+

+(Members of BindingSpec are embedded into this type.) +
-caCert
+KafkaAuthSpec
- -SecretValueFromSource + +KafkaAuthSpec 		-(Optional) -

CACert is the Kubernetes secret containing the server CA cert.

+

+(Members of KafkaAuthSpec are embedded into this type.) +
-

SecretValueFromSource -

-

-(Appears on: -KafkaSASLSpec, -KafkaTLSSpec) -

-

-

SecretValueFromSource represents the source of a secret value

-

- - - - - + - -
FieldDescription
-secretKeyRef
+status
- -Kubernetes core/v1.SecretKeySelector + +KafkaBindingStatus 		-

The Secret key to select from.
-
-

sources.knative.dev/v1beta1

-

-

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

-

-Resource Types: - -

KafkaLimitsSpec +

KafkaBindingSpec

(Appears on: -KafkaResourceSpec) +KafkaBinding)

+

KafkaBindingSpec defines the desired state of the KafkaBinding.

@@ -4257,33 +4255,42 @@ Resource Types:
-cpu
+BindingSpec
-string +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec 		+

+(Members of BindingSpec are embedded into this type.) +
-memory
+KafkaAuthSpec
-string + +KafkaAuthSpec + 		+

+(Members of KafkaAuthSpec are embedded into this type.) +
-

KafkaRequestsSpec +

KafkaBindingStatus

(Appears on: -KafkaResourceSpec) +KafkaBinding)

+

KafkaBindingStatus defines the observed state of KafkaBinding.

@@ -4295,29 +4302,26 @@ string - - - -
-cpu
- -string - -		 -
-memory
+Status
-string +knative.dev/pkg/apis/duck/v1.Status 		+

+(Members of Status are embedded into this type.) +
-

KafkaResourceSpec +

KafkaNetSpec

+(Appears on: +KafkaAuthSpec) +

+

@@ -4329,10 +4333,10 @@ string @@ -4341,10 +4345,10 @@ KafkaRequestsSpec @@ -4353,10 +4357,13 @@ KafkaLimitsSpec
-requests
+sasl
- -KafkaRequestsSpec + +KafkaSASLSpec
-limits
+tls
- -KafkaLimitsSpec + +KafkaTLSSpec
-

KafkaSource +

KafkaSASLSpec

-

KafkaSource is the Schema for the kafkasources API.

+(Appears on: +KafkaNetSpec) +

+

@@ -4368,112 +4375,122 @@ KafkaLimitsSpec +

+

+
-metadata
+enable
- -Kubernetes meta/v1.ObjectMeta - +bool 		-Refer to the Kubernetes API documentation for the fields of the -metadata field.
-spec
+user
- -KafkaSourceSpec + +SecretValueFromSource 		-
-
- +(Optional) +

User is the Kubernetes secret containing the SASL username.

+ + + + +
-KafkaAuthSpec
+password
- -KafkaAuthSpec + +SecretValueFromSource 		+(Optional) +

Password is the Kubernetes secret containing the SASL password.

+
+

KafkaTLSSpec +

-(Members of KafkaAuthSpec are embedded into this type.) +(Appears on: +KafkaNetSpec)

-
+ + + + + + - -
FieldDescription
-topics
+enable
-[]string +bool 		-

Topic topics to consume messages from
-consumerGroup
+cert
-string + +SecretValueFromSource + 		(Optional) -

ConsumerGroupID is the consumer group ID.

+

Cert is the Kubernetes secret containing the client certificate.
-SourceSpec
+key
-knative.dev/pkg/apis/duck/v1.SourceSpec + +SecretValueFromSource + 		-

-(Members of SourceSpec are embedded into this type.) -

-

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.

-
+(Optional) +

Key is the Kubernetes secret containing the client key.

-status
+caCert
- -KafkaSourceStatus + +SecretValueFromSource +(Optional) +

CACert is the Kubernetes secret containing the server CA cert.

-

KafkaSourceSpec +

SecretValueFromSource

(Appears on: -KafkaSource) +GitLabBindingSpec)

-

KafkaSourceSpec defines the desired state of the KafkaSource.

+

SecretValueFromSource represents the source of a secret value

@@ -4485,70 +4502,60 @@ KafkaSourceStatus - - - - + +
-KafkaAuthSpec
+secretKeyRef
- -KafkaAuthSpec + +Kubernetes core/v1.SecretKeySelector 		-

-(Members of KafkaAuthSpec are embedded into this type.) -

-
-topics
- -[]string - -		 -

Topic topics to consume messages from

+

The Secret key to select from.
+

SecretValueFromSource +

+

+(Appears on: +GitHubBindingSpec) +

+

+

SecretValueFromSource represents the source of a secret value

+

+ + - - + + + +
-consumerGroup
- -string - -		 -(Optional) -

ConsumerGroupID is the consumer group ID.

-		FieldDescription
-SourceSpec
+secretKeyRef
-knative.dev/pkg/apis/duck/v1.SourceSpec + +Kubernetes core/v1.SecretKeySelector + 		-

-(Members of SourceSpec are embedded into this type.) -

-

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.

+

The Secret key to select from.
-

KafkaSourceStatus +

SecretValueFromSource

(Appears on: -KafkaSource) +KafkaSASLSpec, +KafkaTLSSpec)

-

KafkaSourceStatus defines the observed state of KafkaSource.

+

SecretValueFromSource represents the source of a secret value

@@ -4560,22 +4567,15 @@ and modifications of the event sent to the sink.

@@ -4583,5 +4583,5 @@ Source.

Generated with gen-crd-api-reference-docs -on git commit 9cefcda1. +on git commit 9683a047.

diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index 7a05180205..c0bfeab9c0 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,10 +1,10 @@

Packages:

-

flows.knative.dev/v1beta1

+

messaging.knative.dev/v1beta1

Package v1beta1 is the v1beta1 version of the API.

Resource Types: - -

Parallel + +

Channel

-

Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.

+

Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.

-SourceStatus
+secretKeyRef
-knative.dev/pkg/apis/duck/v1.SourceStatus + +Kubernetes core/v1.SecretKeySelector + 		-

-(Members of SourceStatus are embedded into this type.) -

-

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.

+

The Secret key to select from.
@@ -59,6 +67,23 @@ series through Channels and Subscriptions.

+ + + + + + + +
+apiVersion
+string		 + +messaging.knative.dev/v1beta1 + +
+kind
+string +		Channel
metadata
@@ -76,31 +101,18 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -ParallelSpec + +ChannelSpec 		-

Spec defines the desired state of the Parallel.

+

Spec defines the desired state of the Channel.



- - - -
-branches
- - -[]ParallelBranch - - -		 -

Branches is the list of Filter/Subscribers pairs.

-
channelTemplate
@@ -109,22 +121,24 @@ ChannelTemplateSpec 		-(Optional) -

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

+

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. +This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.
-reply
+ChannelableSpec
-knative.dev/pkg/apis/duck/v1.Destination + +ChannelableSpec + 		-(Optional) -

Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply

+

+(Members of ChannelableSpec are embedded into this type.) +

+

Channel conforms to ChannelableSpec
@@ -134,26 +148,23 @@ when the case does not have a Reply

 status
- -ParallelStatus + +ChannelStatus 		(Optional) -

Status represents the current state of the Parallel. This data may be out of +

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

ParallelBranch +

InMemoryChannel

-(Appears on: -ParallelSpec) -

-

+

InMemoryChannel is a resource representing an in memory channel

@@ -165,66 +176,91 @@ date.

+ + + + + + + + - +

Spec defines the desired state of the Channel.

+
+
+
-filter
+apiVersion
+string		 + +messaging.knative.dev/v1beta1 + +
+kind
+string +		InMemoryChannel
+metadata
-knative.dev/pkg/apis/duck/v1.Destination + +Kubernetes meta/v1.ObjectMeta + 		(Optional) -

Filter is the expression guarding the branch

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-subscriber
+spec
-knative.dev/pkg/apis/duck/v1.Destination + +InMemoryChannelSpec + 		-

Subscriber receiving the event when the filter passes

-
+ +
-reply
+ChannelableSpec
-knative.dev/pkg/apis/duck/v1.Destination + +ChannelableSpec + 		-(Optional) -

Reply is a Reference to where the result of Subscriber of this case gets sent to. -If not specified, sent the result to the Parallel Reply

+

+(Members of ChannelableSpec are embedded into this type.) +

+

Channel conforms to Duck type Channelable.

+
-delivery
+status
- -DeliverySpec + +InMemoryChannelStatus (Optional) -

Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. -Needed for Roundtripping v1alpha1 <-> v1beta1.

+

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

-

ParallelBranchStatus +

Subscription

-(Appears on: -ParallelStatus) -

-

-

ParallelBranchStatus represents the current state of a Parallel branch

+

Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.

@@ -236,62 +272,48 @@ Needed for Roundtripping v1alpha1 <-> v1beta1.

+ + + + - - -
-filterSubscriptionStatus
- - -ParallelSubscriptionStatus - - +apiVersion
+string		 + +messaging.knative.dev/v1beta1 +
-

FilterSubscriptionStatus corresponds to the filter subscription status.

+kind
+string 		Subscription
-filterChannelStatus
+metadata
- -ParallelChannelStatus + +Kubernetes meta/v1.ObjectMeta 		-

FilterChannelStatus corresponds to the filter channel status.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-subscriberSubscriptionStatus
+spec
- -ParallelSubscriptionStatus + +SubscriptionSpec 		-

SubscriptionStatus corresponds to the subscriber subscription status.

-
-

ParallelChannelStatus -

-

-(Appears on: -ParallelBranchStatus, -ParallelStatus) -

-

-

+
+
- - - - - - - - -
FieldDescription
channel
@@ -302,89 +324,96 @@ Kubernetes core/v1.ObjectReference 		-

Channel is the reference to the underlying channel.

+

Reference to a channel that will be used to create the subscription +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference must meet the +contract to the ChannelableSpec duck type. If the resource does not +meet this contract it will be reflected in the Subscription’s status.

+

This field is immutable. We have no good answer on what happens to +the events that are currently in the channel being consumed from +and what the semantics there should be. For now, you can always +delete the Subscription and recreate it to point to a different +channel, giving the user more control over what semantics should +be used (drain the channel first, possibly have events dropped, +etc.)
-ready
+subscriber
-knative.dev/pkg/apis.Condition +knative.dev/pkg/apis/duck/v1.Destination 		-

ReadyCondition indicates whether the Channel is ready or not.

+(Optional) +

Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a Destination as specified by the Reply.
-

ParallelSpec -

-

-(Appears on: -Parallel) -

-

-

- - - - - - - - + +
FieldDescription
-branches
+reply
- -[]ParallelBranch - +knative.dev/pkg/apis/duck/v1.Destination 		-

Branches is the list of Filter/Subscribers pairs.

+(Optional) +

Reply specifies (optionally) how to handle events returned from +the Subscriber target.
-channelTemplate
+delivery
- -ChannelTemplateSpec + +DeliverySpec 		(Optional) -

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

+

Delivery configuration

+
-reply
+status
-knative.dev/pkg/apis/duck/v1.Destination + +SubscriptionStatus + -(Optional) -

Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply

-

ParallelStatus +

ChannelDefaulter +

+

+

ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.

+

+

ChannelSpec

(Appears on: -Parallel) +Channel)

-

ParallelStatus represents the current state of a Parallel.

+

ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. +It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.

@@ -396,70 +425,89 @@ when the case does not have a Reply

+ +
-Status
+channelTemplate
-knative.dev/pkg/apis/duck/v1.Status + +ChannelTemplateSpec + 		-

-(Members of Status are embedded into this type.) -

-

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.

+

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. +This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.
-ingressChannelStatus
+ChannelableSpec
- -ParallelChannelStatus + +ChannelableSpec 		-

IngressChannelStatus corresponds to the ingress channel status.

+

+(Members of ChannelableSpec are embedded into this type.) +

+

Channel conforms to ChannelableSpec
+

ChannelStatus +

+

+(Appears on: +Channel) +

+

+

ChannelStatus represents the current state of a Channel.

+

+ + + + + + + +
FieldDescription
-branchStatuses
+ChannelableStatus
- -[]ParallelBranchStatus + +ChannelableStatus 		-

BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order.

+

+(Members of ChannelableStatus are embedded into this type.) +

+

Channel conforms to ChannelableStatus
-AddressStatus
+channel
-knative.dev/pkg/apis/duck/v1.AddressStatus +knative.dev/pkg/apis/duck/v1.KReference 		-

-(Members of AddressStatus are embedded into this type.) -

-

AddressStatus is the starting point to this Parallel. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name}

+

Channel is an KReference to the Channel CRD backing this Channel.
-

ParallelSubscriptionStatus +

ChannelTemplateSpec

(Appears on: -ParallelBranchStatus) +ChannelSpec, +ParallelSpec, +SequenceSpec)

@@ -473,35 +521,28 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

-subscription
- - -Kubernetes core/v1.ObjectReference - - - - -

Subscription is the reference to the underlying Subscription.

- - - - -ready
+spec
-knative.dev/pkg/apis.Condition +k8s.io/apimachinery/pkg/runtime.RawExtension -

ReadyCondition indicates whether the Subscription is ready or not.

+(Optional) +

Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section.

+
+
+ +
-

Sequence +

ChannelTemplateSpecInternal

-

Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.

+

ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.

@@ -530,84 +571,66 @@ Refer to the Kubernetes API documentation for the fields of the +
spec
- -SequenceSpec - +k8s.io/apimachinery/pkg/runtime.RawExtension 		-

Spec defines the desired state of the Sequence.

+(Optional) +

Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section.



- - - - - - - - - - -
-steps
- - -[]SequenceStep - - -		 -

Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options

-
-channelTemplate
- - -ChannelTemplateSpec - - -		 -(Optional) -

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

-
-reply
- -knative.dev/pkg/apis/duck/v1.Destination - -		 -(Optional) -

Reply is a Reference to where the result of the last Subscriber gets sent to.

+
- +

InMemoryChannelSpec +

+

+(Appears on: +InMemoryChannel) +

+

+

InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.

+

+ + + + + + +
FieldDescription
-status
+ChannelableSpec
- -SequenceStatus + +ChannelableSpec 		-(Optional) -

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

+

+(Members of ChannelableSpec are embedded into this type.) +

+

Channel conforms to Duck type Channelable.
-

SequenceChannelStatus +

InMemoryChannelStatus

(Appears on: -SequenceStatus) +InMemoryChannel)

+

ChannelStatus represents the current state of a Channel.

@@ -619,37 +642,41 @@ date.

- - - -
-channel
+ChannelableStatus
- -Kubernetes core/v1.ObjectReference + +ChannelableStatus 		-

Channel is the reference to the underlying channel.

-
-ready
- -knative.dev/pkg/apis.Condition - -		 -

ReadyCondition indicates whether the Channel is ready or not.

+

+(Members of ChannelableStatus are embedded into this type.) +

+

Channel conforms to Duck type Channelable.
-

SequenceSpec +

SubscriptionSpec

(Appears on: -Sequence) +Subscription)

+

SubscriptionSpec specifies the Channel for incoming events, a Subscriber target +for processing those events and where to put the result of the processing. Only +From (where the events are coming from) is always required. You can optionally +only Process the events (results in no output events) by leaving out the Result. +You can also perform an identity transformation on the incoming events by leaving +out the Subscriber and only specifying Result.

+

The following are all valid specifications: +channel –[subscriber]–> reply +Sink, no outgoing events: +channel – subscriber +no-op function (identity transformation): +channel –> reply

@@ -661,31 +688,43 @@ knative.dev/pkg/apis.Condition @@ -697,19 +736,34 @@ knative.dev/pkg/apis/duck/v1.Destination + + + +
-steps
+channel
- -[]SequenceStep + +Kubernetes core/v1.ObjectReference 		-

Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options

+

Reference to a channel that will be used to create the subscription +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference must meet the +contract to the ChannelableSpec duck type. If the resource does not +meet this contract it will be reflected in the Subscription’s status.

+

This field is immutable. We have no good answer on what happens to +the events that are currently in the channel being consumed from +and what the semantics there should be. For now, you can always +delete the Subscription and recreate it to point to a different +channel, giving the user more control over what semantics should +be used (drain the channel first, possibly have events dropped, +etc.)
-channelTemplate
+subscriber
- -ChannelTemplateSpec - +knative.dev/pkg/apis/duck/v1.Destination 		(Optional) -

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

+

Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a Destination as specified by the Reply.
(Optional) -

Reply is a Reference to where the result of the last Subscriber gets sent to.

+

Reply specifies (optionally) how to handle events returned from +the Subscriber target.

+
+delivery
+ + +DeliverySpec + + +		 +(Optional) +

Delivery configuration
-

SequenceStatus +

SubscriptionStatus

(Appears on: -Sequence) +Subscription)

-

SequenceStatus represents the current state of a Sequence.

+

SubscriptionStatus (computed) for a subscription

@@ -737,57 +791,28 @@ knative.dev/pkg/apis/duck/v1.Status - - - - - - - -
-subscriptionStatuses
- - -[]SequenceSubscriptionStatus - - -		 -

SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order.

-
-channelStatuses
+physicalSubscription
- -[]SequenceChannelStatus + +SubscriptionStatusPhysicalSubscription 		-

ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order.

-
-AddressStatus
- -knative.dev/pkg/apis/duck/v1.AddressStatus - -		 -

-(Members of AddressStatus are embedded into this type.) -

-

AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name}

+

PhysicalSubscription is the fully resolved values that this Subscription represents.
-

SequenceStep +

SubscriptionStatusPhysicalSubscription

(Appears on: -SequenceSpec) +SubscriptionStatus)

+

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

@@ -799,94 +824,54 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

- - - - - -
-Destination
- -knative.dev/pkg/apis/duck/v1.Destination - -		 -

-(Members of Destination are embedded into this type.) -

-

Subscriber receiving the step event

-
-delivery
+subscriberUri
- -DeliverySpec - +knative.dev/pkg/apis.URL 		-(Optional) -

Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc.

+

SubscriberURI is the fully resolved URI for spec.subscriber.
-

SequenceSubscriptionStatus -

-

-(Appears on: -SequenceStatus) -

-

-

- - - - - - - -
FieldDescription
-subscription
+replyUri
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis.URL 		-

Subscription is the reference to the underlying Subscription.

+

ReplyURI is the fully resolved URI for the spec.reply.
-ready
+deadLetterSinkUri
-knative.dev/pkg/apis.Condition +knative.dev/pkg/apis.URL 		-

ReadyCondition indicates whether the Subscription is ready or not.

+

ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.
-

messaging.knative.dev/v1beta1

+

sources.knative.dev/v1alpha1

-

Package v1beta1 is the v1beta1 version of the API.

+

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

Resource Types: -

Channel +

ApiServerSource

-

Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.

+

ApiServerSource is the Schema for the apiserversources API

@@ -902,7 +887,7 @@ Resource Types: string @@ -911,7 +896,7 @@ messaging.knative.dev/v1beta1 kind
string - + @@ -932,139 +916,93 @@ Refer to the Kubernetes API documentation for the fields of the - -
-messaging.knative.dev/v1beta1 +sources.knative.dev/v1alpha1
ChannelApiServerSource
@@ -923,7 +908,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ChannelSpec + +ApiServerSourceSpec 		-

Spec defines the desired state of the Channel.



- -
-channelTemplate
+resources
- -ChannelTemplateSpec + +[]ApiServerResource 		-

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

+

Resources is the list of resources to watch
-ChannelableSpec
+serviceAccountName
- -ChannelableSpec - +string 		-

-(Members of ChannelableSpec are embedded into this type.) -

-

Channel conforms to ChannelableSpec

-
+(Optional) +

ServiceAccountName is the name of the ServiceAccount to use to run this +source.
-status
+sink
- -ChannelStatus - +knative.dev/pkg/apis/duck/v1beta1.Destination 		(Optional) -

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

+

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

InMemoryChannel -

-

-

InMemoryChannel is a resource representing an in memory channel

-

- - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -messaging.knative.dev/v1beta1 - -
-kind
-string -		InMemoryChannel
-metadata
+ceOverrides
- -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis/duck/v1.CloudEventOverrides 		(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.
-spec
+owner
- -InMemoryChannelSpec + +APIVersionKind 		-

Spec defines the desired state of the Channel.

-
-
- +(Optional) +

ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

+ +
-ChannelableSpec
+mode
- -ChannelableSpec - +string 		-

-(Members of ChannelableSpec are embedded into this type.) -

-

Channel conforms to Duck type Channelable.

+

Mode is the mode the receive adapter controller runs under: Ref or Resource. +Ref sends only the reference to the resource. +Resource send the full resource.
@@ -1074,24 +1012,25 @@ ChannelableSpec 		status
- -InMemoryChannelStatus + +ApiServerSourceStatus 		-(Optional) -

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

Subscription +

SinkBinding

-

Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.

+

SinkBinding describes a Binding that is also a Source. +The sink (from the Source duck) is resolved to a URL and +then projected into the subject by augmenting the runtime +contract of the referenced containers to have a K_SINK +environment variable holding the endpoint to which to send +cloud events.

@@ -1107,7 +1046,7 @@ corresponds to the subscriptions.channels.knative.dev CRD.

string @@ -1116,7 +1055,7 @@ messaging.knative.dev/v1beta1 kind
string - + @@ -1147,70 +1086,28 @@ SubscriptionSpec
-messaging.knative.dev/v1beta1 +sources.knative.dev/v1alpha1
SubscriptionSinkBinding
@@ -1136,8 +1075,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -SubscriptionSpec + +SinkBindingSpec
- - - - - - - -
-channel
- - -Kubernetes core/v1.ObjectReference - - -		 -

Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status.

-

This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.)

-
-subscriber
- -knative.dev/pkg/apis/duck/v1.Destination - -		 -(Optional) -

Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply.

-
-reply
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.SourceSpec 		-(Optional) -

Reply specifies (optionally) how to handle events returned from -the Subscriber target.

+

+(Members of SourceSpec are embedded into this type.) +
-delivery
+BindingSpec
- -DeliverySpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec 		-(Optional) -

Delivery configuration

+

+(Members of BindingSpec are embedded into this type.) +
@@ -1220,8 +1117,8 @@ DeliverySpec status
- -SubscriptionStatus + +SinkBindingStatus @@ -1230,21 +1127,14 @@ SubscriptionStatus -

ChannelDefaulter -

-

-

ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.

-

-

ChannelSpec +

ApiServerResource

(Appears on: -Channel) +ApiServerSourceSpec)

-

ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. -It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.

+

ApiServerResource defines the resource to watch

@@ -1256,91 +1146,80 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba - -
-channelTemplate
+apiVersion
- -ChannelTemplateSpec - +string 		-

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

+

API version of the resource to watch.
-ChannelableSpec
+kind
- -ChannelableSpec - +string 		-

-(Members of ChannelableSpec are embedded into this type.) -

-

Channel conforms to ChannelableSpec

+

Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-

ChannelStatus -

-

-(Appears on: -Channel) -

-

-

ChannelStatus represents the current state of a Channel.

-

- - - - + + - -
FieldDescription +labelSelector
+ + +Kubernetes meta/v1.LabelSelector + + +		 +

LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

+
-ChannelableStatus
+controllerSelector
- -ChannelableStatus + +Kubernetes meta/v1.OwnerReference 		-

-(Members of ChannelableStatus are embedded into this type.) -

-

Channel conforms to ChannelableStatus

+

ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. +Only apiVersion and kind are used. Both are optional. +Deprecated: Per-resource owner refs will no longer be supported in +v1alpha2, please use Spec.Owner as a GKV.
-channel
+controller
-knative.dev/pkg/apis/duck/v1.KReference +bool 		-

Channel is an KReference to the Channel CRD backing this Channel.

+

If true, send an event referencing the object controlling the resource +Deprecated: Per-resource controller flag will no longer be supported in +v1alpha2, please use Spec.Owner as a GKV.
-

ChannelTemplateSpec +

ApiServerSourceSpec

(Appears on: -ChannelSpec, -ParallelSpec, -SequenceSpec) +ApiServerSource)

+

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -1352,116 +1231,94 @@ knative.dev/pkg/apis/duck/v1.KReference - -
-spec
+resources
-k8s.io/apimachinery/pkg/runtime.RawExtension + +[]ApiServerResource + 		-(Optional) -

Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section.

-
-
- -
+

Resources is the list of resources to watch
-

ChannelTemplateSpecInternal -

-

-

ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.

-

- - - - + + - - - -
FieldDescription +serviceAccountName
+ +string + +		 +(Optional) +

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

+
-metadata
+sink
- -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis/duck/v1beta1.Destination 		(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

Sink is a reference to an object that will resolve to a domain name to use as the sink.
-spec
+ceOverrides
-k8s.io/apimachinery/pkg/runtime.RawExtension +knative.dev/pkg/apis/duck/v1.CloudEventOverrides 		(Optional) -

Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section.

-
-
- -
+

CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.
-

InMemoryChannelSpec -

-

-(Appears on: -InMemoryChannel) -

-

-

InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.

-

- - - - + + - -
FieldDescription +owner
+ + +APIVersionKind + + +		 +(Optional) +

ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

+
-ChannelableSpec
+mode
- -ChannelableSpec - +string 		-

-(Members of ChannelableSpec are embedded into this type.) -

-

Channel conforms to Duck type Channelable.

+

Mode is the mode the receive adapter controller runs under: Ref or Resource. +Ref sends only the reference to the resource. +Resource send the full resource.
-

InMemoryChannelStatus +

ApiServerSourceStatus

(Appears on: -InMemoryChannel) +ApiServerSource)

-

ChannelStatus represents the current state of a Channel.

+

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -1473,41 +1330,34 @@ ChannelableSpec
-ChannelableStatus
+SourceStatus
- -ChannelableStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus

-(Members of ChannelableStatus are embedded into this type.) +(Members of SourceStatus are embedded into this type.)

-

Channel conforms to Duck type Channelable.

+

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.
-

SubscriptionSpec +

SinkBindingSpec

(Appears on: -Subscription) +SinkBinding)

-

SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result.

-

The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply

+

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

@@ -1519,82 +1369,40 @@ channel –> reply

- - - - - - - -
-channel
- - -Kubernetes core/v1.ObjectReference - - -		 -

Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status.

-

This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.)

-
-subscriber
- -knative.dev/pkg/apis/duck/v1.Destination - -		 -(Optional) -

Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply.

-
-reply
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.SourceSpec 		-(Optional) -

Reply specifies (optionally) how to handle events returned from -the Subscriber target.

+

+(Members of SourceSpec are embedded into this type.) +
-delivery
+BindingSpec
- -DeliverySpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec 		-(Optional) -

Delivery configuration

+

+(Members of BindingSpec are embedded into this type.) +
-

SubscriptionStatus +

SinkBindingStatus

(Appears on: -Subscription) +SinkBinding)

-

SubscriptionStatus (computed) for a subscription

+

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

@@ -1606,44 +1414,38 @@ DeliverySpec - - - -
-Status
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.SourceStatus

-(Members of Status are embedded into this type.) +(Members of SourceStatus are embedded into this type.)

-

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.

-
-physicalSubscription
- - -SubscriptionStatusPhysicalSubscription - - -		 -

PhysicalSubscription is the fully resolved values that this Subscription represents.
-

SubscriptionStatusPhysicalSubscription -

+
+

sources.knative.dev/v1alpha2

-(Appears on: -SubscriptionStatus) +

Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group

+Resource Types: + +

ApiServerSource +

-

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

+

ApiServerSource is the Schema for the apiserversources API

@@ -1655,71 +1457,8 @@ Subscription.

- - - - - - - - - - - -
-subscriberUri
- -knative.dev/pkg/apis.URL - -		 -

SubscriberURI is the fully resolved URI for spec.subscriber.

-
-replyUri
- -knative.dev/pkg/apis.URL - -		 -

ReplyURI is the fully resolved URI for the spec.reply.

-
-deadLetterSinkUri
- -knative.dev/pkg/apis.URL - -		 -

ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.

-
-
-

sources.knative.dev/v1alpha2

-

-

Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group

-

-Resource Types: - -

ApiServerSource -

-

-

ApiServerSource is the Schema for the apiserversources API

-

- - - - - - - - - - +apiVersion
+string + + + + + +
FieldDescription
-apiVersion
-string		 sources.knative.dev/v1alpha2 @@ -1857,7 +1596,871 @@ ApiServerSourceStatus

ContainerSource

-

ContainerSource is the Schema for the containersources API

+

ContainerSource is the Schema for the containersources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.knative.dev/v1alpha2 + +
+kind
+string +		ContainerSource
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ContainerSourceSpec + + +		 +
+
+ + + + + + + + + +
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.

+
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +		 +

Template describes the pods that will be created

+
+
+status
+ + +ContainerSourceStatus + + +		 +
+

PingSource +

+

+

PingSource is the Schema for the PingSources API.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.knative.dev/v1alpha2 + +
+kind
+string +		PingSource
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +PingSourceSpec + + +		 +
+
+ + + + + + + + + + + + + +
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.

+
+schedule
+ +string + +		 +(Optional) +

Schedule is the cronjob schedule. Defaults to * * * * *.

+
+jsonData
+ +string + +		 +(Optional) +

JsonData is json encoded data used as the body of the event posted to +the sink. Default is empty. If set, datacontenttype will also be set +to “application/json”.

+
+
+status
+ + +PingSourceStatus + + +		 +
+

SinkBinding +

+

+

SinkBinding describes a Binding that is also a Source. +The sink (from the Source duck) is resolved to a URL and +then projected into the subject by augmenting the runtime +contract of the referenced containers to have a K_SINK +environment variable holding the endpoint to which to send +cloud events.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.knative.dev/v1alpha2 + +
+kind
+string +		SinkBinding
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +SinkBindingSpec + + +		 +
+
+ + + + + + + + + +
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.

+
+BindingSpec
+ +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +		 +

+(Members of BindingSpec are embedded into this type.) +

+

inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations.

+
+
+status
+ + +SinkBindingStatus + + +		 +
+

APIVersionKind +

+

+(Appears on: +ApiServerSourceSpec, +ApiServerSourceSpec) +

+

+

APIVersionKind is an APIVersion and Kind tuple.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+ +string + +		 +

APIVersion - the API version of the resource to watch.

+
+kind
+ +string + +		 +

Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+
+

APIVersionKindSelector +

+

+(Appears on: +ApiServerSourceSpec) +

+

+

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+ +string + +		 +

APIVersion - the API version of the resource to watch.

+
+kind
+ +string + +		 +

Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+
+selector
+ + +Kubernetes meta/v1.LabelSelector + + +		 +(Optional) +

LabelSelector filters this source to objects to those resources pass the +label selector. +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

+
+

ApiServerSourceSpec +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceSpec defines the desired state of ApiServerSource

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.

+
+resources
+ + +[]APIVersionKindSelector + + +		 +

Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter.

+
+owner
+ + +APIVersionKind + + +		 +(Optional) +

ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

+
+mode
+ +string + +		 +(Optional) +

EventMode controls the format of the event. +Reference sends a dataref event type for the resource under watch. +Resource send the full resource lifecycle event. +Defaults to Reference

+
+serviceAccountName
+ +string + +		 +(Optional) +

ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set.

+
+

ApiServerSourceStatus +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

+

+ + + + + + + + + + + + + +
FieldDescription
+SourceStatus
+ +knative.dev/pkg/apis/duck/v1.SourceStatus + +		 +

+(Members of SourceStatus are embedded into this type.) +

+

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.

+
+

ContainerSourceSpec +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceSpec defines the desired state of ContainerSource

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.

+
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +		 +

Template describes the pods that will be created

+
+

ContainerSourceStatus +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceStatus defines the observed state of ContainerSource

+

+ + + + + + + + + + + + + +
FieldDescription
+SourceStatus
+ +knative.dev/pkg/apis/duck/v1.SourceStatus + +		 +

+(Members of SourceStatus are embedded into this type.) +

+

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.

+
+

PingSourceSpec +

+

+(Appears on: +PingSource) +

+

+

PingSourceSpec defines the desired state of the PingSource.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.

+
+schedule
+ +string + +		 +(Optional) +

Schedule is the cronjob schedule. Defaults to * * * * *.

+
+jsonData
+ +string + +		 +(Optional) +

JsonData is json encoded data used as the body of the event posted to +the sink. Default is empty. If set, datacontenttype will also be set +to “application/json”.

+
+

PingSourceStatus +

+

+(Appears on: +PingSource) +

+

+

PingSourceStatus defines the observed state of PingSource.

+

+ + + + + + + + + + + + + +
FieldDescription
+SourceStatus
+ +knative.dev/pkg/apis/duck/v1.SourceStatus + +		 +

+(Members of SourceStatus are embedded into this type.) +

+

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.

+
+

SinkBindingSpec +

+

+(Appears on: +SinkBinding) +

+

+

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.

+
+BindingSpec
+ +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +		 +

+(Members of BindingSpec are embedded into this type.) +

+

inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations.

+
+

SinkBindingStatus +

+

+(Appears on: +SinkBinding) +

+

+

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

+

+ + + + + + + + + + + + + +
FieldDescription
+SourceStatus
+ +knative.dev/pkg/apis/duck/v1.SourceStatus + +		 +

+(Members of SourceStatus are embedded into this type.) +

+

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.

+
+
+

configs.internal.knative.dev/v1alpha1

+

+

Package v1alpha1 is the v1alpha1 version of the API.

+

+Resource Types: + +

ConfigMapPropagation +

+

+

ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace

@@ -1873,7 +2476,7 @@ ApiServerSourceStatus string @@ -1882,7 +2485,7 @@ sources.knative.dev/v1alpha2 kind
string - + @@ -1902,44 +2506,39 @@ Refer to the Kubernetes API documentation for the fields of the
-sources.knative.dev/v1alpha2 +configs.internal.knative.dev/v1alpha1
ContainerSourceConfigMapPropagation
@@ -1894,6 +2497,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ContainerSourceSpec + +ConfigMapPropagationSpec 		+

Spec defines the desired state of the ConfigMapPropagation



-SourceSpec
+originalNamespace
-knative.dev/pkg/apis/duck/v1.SourceSpec +string 		-

-(Members of SourceSpec are embedded into this type.) -

-

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.

+

OriginalNamespace is the namespace where the original configMaps are in
-template
+selector
- -Kubernetes core/v1.PodTemplateSpec + +Kubernetes meta/v1.LabelSelector 		-

Template describes the pods that will be created

+(Optional) +

Selector only selects original configMaps with corresponding labels
@@ -1949,20 +2548,26 @@ Kubernetes core/v1.PodTemplateSpec 		status
- -ContainerSourceStatus + +ConfigMapPropagationStatus 		+(Optional) +

Status represents the current state of the EventType. +This data may be out of date.
-

PingSource +

ConfigMapPropagationSpec

-

PingSource is the Schema for the PingSources API.

+(Appears on: +ConfigMapPropagation) +

+

@@ -1974,118 +2579,187 @@ ContainerSourceStatus +originalNamespace
+ +string + + - + + + +
-apiVersion
-string		 - -sources.knative.dev/v1alpha2 - +

OriginalNamespace is the namespace where the original configMaps are in
-kind
-string +selector
+ + +Kubernetes meta/v1.LabelSelector + + 		PingSource +(Optional) +

Selector only selects original configMaps with corresponding labels

+
+

ConfigMapPropagationStatus +

+

+(Appears on: +ConfigMapPropagation) +

+

+

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

+

+ + + + + + + + + +
FieldDescription
-metadata
+Status
- -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis/duck/v1.Status 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

+(Members of Status are embedded into this type.) +

+

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.
-spec
+copyConfigmaps
- -PingSourceSpec + +[]ConfigMapPropagationStatusCopyConfigMap 		-
-
+(Optional) +

CopyConfigMaps is the status for each copied configmap.

+
+

ConfigMapPropagationStatusCopyConfigMap +

+

+(Appears on: +ConfigMapPropagationStatus) +

+

+

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

+

+ + + + + + + -
FieldDescription
-SourceSpec
+name
-knative.dev/pkg/apis/duck/v1.SourceSpec +string 		-

-(Members of SourceSpec are embedded into this type.) -

-

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.

+

Name is copy configmap’s name
-schedule
+source
string 		-(Optional) -

Schedule is the cronjob schedule. Defaults to * * * * *.

+

Source is “originalNamespace/originalConfigMapName”
-jsonData
+operation
string 		-(Optional) -

JsonData is json encoded data used as the body of the event posted to -the sink. Default is empty. If set, datacontenttype will also be set -to “application/json”.

+

Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop
+
+ready
+ +string + +		 +

Ready represents the operation is ready or not
-status
+reason
- -PingSourceStatus - +string + +		 +

Reason indicates reasons if the operation is not ready

+
+resourceVersionFromSource
+ +string 		+

ResourceVersion is the resourceVersion of original configmap
-

SinkBinding +
+

duck.knative.dev/v1

+

+

Package v1 is the v1 version of the API.

+

+Resource Types: + +

BackoffPolicyType +(string alias)

+

+(Appears on: +DeliverySpec) +

+

+

BackoffPolicyType is the type for backoff policies

+

+

Channelable

-

SinkBinding describes a Binding that is also a Source. -The sink (from the Source duck) is resolved to a URL and -then projected into the subject by augmenting the runtime -contract of the referenced containers to have a K_SINK -environment variable holding the endpoint to which to send -cloud events.

+

Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

@@ -2097,23 +2771,6 @@ cloud events.

- - - - - - - - @@ -2190,15 +2843,16 @@ SinkBindingStatus
-apiVersion
-string		 - -sources.knative.dev/v1alpha2 - -
-kind
-string -		SinkBinding
metadata
@@ -2130,47 +2787,43 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -SinkBindingSpec + +ChannelableSpec 		+

Spec is the part where the Channelable fulfills the Subscribable contract.



-SourceSpec
+SubscribableSpec
-knative.dev/pkg/apis/duck/v1.SourceSpec + +SubscribableSpec +

-(Members of SourceSpec are embedded into this type.) +(Members of SubscribableSpec are embedded into this type.)

-

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.
-BindingSpec
+delivery
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +DeliverySpec + 		-

-(Members of BindingSpec are embedded into this type.) -

-

inherits duck/v1alpha1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations.

+(Optional) +

DeliverySpec contains options controlling the event delivery
@@ -2180,8 +2833,8 @@ should be augmented by Binding implementations.

 status
- -SinkBindingStatus + +ChannelableStatus
-

APIVersionKind +

ChannelableSpec

(Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) +ChannelSpec, +Channelable, +InMemoryChannelSpec)

-

APIVersionKind is an APIVersion and Kind tuple.

+

ChannelableSpec contains Spec of the Channelable object

@@ -2210,37 +2864,45 @@ SinkBindingStatus
-apiVersion
+SubscribableSpec
-string + +SubscribableSpec + 		-

APIVersion - the API version of the resource to watch.

+

+(Members of SubscribableSpec are embedded into this type.) +
-kind
+delivery
-string + +DeliverySpec + 		-

Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+(Optional) +

DeliverySpec contains options controlling the event delivery
-

APIVersionKindSelector +

ChannelableStatus

(Appears on: -ApiServerSourceSpec) +ChannelStatus, +Channelable, +InMemoryChannelStatus)

-

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

+

ChannelableStatus contains the Status of a Channelable object.

@@ -2252,53 +2914,81 @@ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

+

+(Members of AddressStatus are embedded into this type.) +

+

AddressStatus is the part where the Channelable fulfills the Addressable contract.

+ + + +
-selector
+SubscribableStatus
- -Kubernetes meta/v1.LabelSelector + +SubscribableStatus 		+

+(Members of SubscribableStatus are embedded into this type.) +

+

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

+
+deadLetterChannel
+ +knative.dev/pkg/apis/duck/v1.KReference + +		 (Optional) -

LabelSelector filters this source to objects to those resources pass the -label selector. -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

+

DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel +Failed messages are delivered here.
-

ApiServerSourceSpec +

DeliverySpec

(Appears on: -ApiServerSource) +BrokerSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriberSpec, +SubscriptionSpec)

-

ApiServerSourceSpec defines the desired state of ApiServerSource

+

DeliverySpec contains the delivery options for event senders, +such as channelable and source.

@@ -2310,91 +3000,97 @@ More info: -[]APIVersionKindSelector - +int32 + +
-

Resource are the resources this source will track and send related -lifecycle events from the Kubernetes ApiServer, with an optional label -selector to help filter.

+(Optional) +

Retry is the minimum number of retries the sender should attempt when +sending an event before moving it to the dead letter sink.
-owner
+backoffPolicy
- -APIVersionKind + +BackoffPolicyType 		(Optional) -

ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

+

BackoffPolicy is the retry backoff policy (linear, exponential).
-mode
+backoffDelay
string 		(Optional) -

EventMode controls the format of the event. -Reference sends a dataref event type for the resource under watch. -Resource send the full resource lifecycle event. -Defaults to Reference

+

BackoffDelay is the delay before retrying. +More information on Duration format: +- https://www.iso.org/iso-8601-date-and-time-format.html +- https://en.wikipedia.org/wiki/ISO_8601

+

For linear policy, backoff delay is the time interval between retries. +For exponential policy , backoff delay is backoffDelay*2^.
+

DeliveryStatus +

+

+

DeliveryStatus contains the Status of an object supporting delivery options.

+

+ + + + + + + +
FieldDescription
-serviceAccountName
+deadLetterChannel
-string +knative.dev/pkg/apis/duck/v1.KReference 		(Optional) -

ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set.

+

DeadLetterChannel is a KReference that is the reference to the native, platform specific channel +where failed events are sent to.
-

ApiServerSourceStatus +

Subscribable

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceStatus defines the observed state of ApiServerSource

+

Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

@@ -2406,34 +3102,75 @@ source. Defaults to default if not set.

+ + + + + + + +
-SourceStatus
+metadata
-knative.dev/pkg/apis/duck/v1.SourceStatus + +Kubernetes meta/v1.ObjectMeta + 		-

-(Members of SourceStatus are embedded into this type.) -

-

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.

+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +SubscribableSpec + + +		 +

SubscribableSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.

+
+
+ + + + + +
+subscribers
+ + +[]SubscriberSpec + + +		 +

This is the list of subscriptions for this subscribable.

+
+
+status
+ + +SubscribableStatus + + +		 +

SubscribableStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract.
-

ContainerSourceSpec +

SubscribableSpec

(Appears on: -ContainerSource) +ChannelableCombinedSpec, +ChannelableSpec, +Subscribable)

-

ContainerSourceSpec defines the desired state of ContainerSource

+

SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.

@@ -2445,45 +3182,30 @@ Source.

- - - -
-SourceSpec
- -knative.dev/pkg/apis/duck/v1.SourceSpec - -		 -

-(Members of SourceSpec are embedded into this type.) -

-

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.

-
-template
+subscribers
- -Kubernetes core/v1.PodTemplateSpec + +[]SubscriberSpec 		-

Template describes the pods that will be created

+

This is the list of subscriptions for this subscribable.
-

ContainerSourceStatus +

SubscribableStatus

(Appears on: -ContainerSource) +ChannelableCombinedStatus, +ChannelableStatus, +Subscribable)

-

ContainerSourceStatus defines the observed state of ContainerSource

+

SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.

@@ -2495,34 +3217,28 @@ Kubernetes core/v1.PodTemplateSpec
-SourceStatus
+subscribers
-knative.dev/pkg/apis/duck/v1.SourceStatus + +[]SubscriberStatus + 		-

-(Members of SourceStatus are embedded into this type.) -

-

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.

+

This is the list of subscription’s statuses for this channel.
-

PingSourceSpec +

SubscriberSpec

(Appears on: -PingSource) +SubscribableSpec)

-

PingSourceSpec defines the desired state of the PingSource.

+

SubscriberSpec defines a single subscriber to a Subscribable.

+

At least one of SubscriberURI and ReplyURI must be present

@@ -2534,97 +3250,77 @@ Source.

- -
-SourceSpec
+uid
-knative.dev/pkg/apis/duck/v1.SourceSpec +k8s.io/apimachinery/pkg/types.UID 		-

-(Members of SourceSpec are embedded into this type.) -

-

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.

+(Optional) +

UID is used to understand the origin of the subscriber.
-schedule
+generation
-string +int64 		(Optional) -

Schedule is the cronjob schedule. Defaults to * * * * *.

+

Generation of the origin of the subscriber with uid:UID.
-jsonData
+subscriberUri
-string +knative.dev/pkg/apis.URL 		(Optional) -

JsonData is json encoded data used as the body of the event posted to -the sink. Default is empty. If set, datacontenttype will also be set -to “application/json”.

+

SubscriberURI is the endpoint for the subscriber
-

PingSourceStatus -

-

-(Appears on: -PingSource) -

-

-

PingSourceStatus defines the observed state of PingSource.

-

- - - - + + - -
FieldDescription +replyUri
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +

ReplyURI is the endpoint for the reply

+
-SourceStatus
+delivery
-knative.dev/pkg/apis/duck/v1.SourceStatus + +DeliverySpec + 		-

-(Members of SourceStatus are embedded into this type.) -

-

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.

+(Optional) +

DeliverySpec contains options controlling the event delivery
-

SinkBindingSpec +

SubscriberStatus

(Appears on: -SinkBinding) +SubscribableStatus, +SubscribableStatus)

-

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

+

SubscriberStatus defines the status of a single subscriber to a Channel.

@@ -2636,118 +3332,86 @@ Source.

- -
-SourceSpec
+uid
-knative.dev/pkg/apis/duck/v1.SourceSpec +k8s.io/apimachinery/pkg/types.UID 		-

-(Members of SourceSpec are embedded into this type.) -

-

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.

+(Optional) +

UID is used to understand the origin of the subscriber.
-BindingSpec
+observedGeneration
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +int64 		-

-(Members of BindingSpec are embedded into this type.) -

-

inherits duck/v1alpha1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations.

+(Optional) +

Generation of the origin of the subscriber with uid:UID.
-

SinkBindingStatus -

-

-(Appears on: -SinkBinding) -

-

-

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

-

- - - - + + - -
FieldDescription +ready
+ + +Kubernetes core/v1.ConditionStatus + + +		 +

Status of the subscriber.

+
-SourceStatus
+message
-knative.dev/pkg/apis/duck/v1.SourceStatus +string 		-

-(Members of SourceStatus are embedded into this type.) -

-

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.

+(Optional) +

A human readable message indicating details of Ready status.
-

configs.internal.knative.dev/v1alpha1

+

duck.knative.dev/v1beta1

-

Package v1alpha1 is the v1alpha1 version of the API.

+

Package v1beta1 is the v1beta1 version of the API.

Resource Types: - -

ConfigMapPropagation + +

BackoffPolicyType +(string alias)

+

+(Appears on: +DeliverySpec) +

+

+

BackoffPolicyType is the type for backoff policies

+

+

Channelable

-

ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace

+

Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

- - - - - - - - - - - - +
FieldDescription
-apiVersion
-string		 - -configs.internal.knative.dev/v1alpha1 - -
+ - - + + + + @@ -2767,39 +3430,43 @@ Refer to the Kubernetes API documentation for the fields of the
-kind
-string -		ConfigMapPropagationFieldDescription
metadata
@@ -2758,7 +3422,6 @@ Kubernetes meta/v1.ObjectMeta 		-(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ConfigMapPropagationSpec + +ChannelableSpec 		-

Spec defines the desired state of the ConfigMapPropagation

+

Spec is the part where the Channelable fulfills the Subscribable contract.



-originalNamespace
+SubscribableSpec
-string + +SubscribableSpec + 		-

OriginalNamespace is the namespace where the original configMaps are in

+

+(Members of SubscribableSpec are embedded into this type.) +
-selector
+delivery
- -Kubernetes meta/v1.LabelSelector + +DeliverySpec 		(Optional) -

Selector only selects original configMaps with corresponding labels

+

DeliverySpec contains options controlling the event delivery
@@ -2809,26 +3476,26 @@ Kubernetes meta/v1.LabelSelector 		status
- -ConfigMapPropagationStatus + +ChannelableStatus 		-(Optional) -

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

ConfigMapPropagationSpec +

ChannelableSpec

(Appears on: -ConfigMapPropagation) +ChannelSpec, +Channelable, +InMemoryChannelSpec)

+

ChannelableSpec contains Spec of the Channelable object

@@ -2840,39 +3507,45 @@ This data may be out of date.

-originalNamespace
+SubscribableSpec
-string + +SubscribableSpec + 		-

OriginalNamespace is the namespace where the original configMaps are in

+

+(Members of SubscribableSpec are embedded into this type.) +
-selector
+delivery
- -Kubernetes meta/v1.LabelSelector + +DeliverySpec 		(Optional) -

Selector only selects original configMaps with corresponding labels

+

DeliverySpec contains options controlling the event delivery
-

ConfigMapPropagationStatus +

ChannelableStatus

(Appears on: -ConfigMapPropagation) +ChannelStatus, +Channelable, +InMemoryChannelStatus)

-

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

+

ChannelableStatus contains the Status of a Channelable object.

@@ -2900,28 +3573,66 @@ knative.dev/pkg/apis/duck/v1.Status + + + + + + + +
-copyConfigmaps
+AddressStatus
- -[]ConfigMapPropagationStatusCopyConfigMap +knative.dev/pkg/apis/duck/v1.AddressStatus + +		 +

+(Members of AddressStatus are embedded into this type.) +

+

AddressStatus is the part where the Channelable fulfills the Addressable contract.

+
+SubscribableStatus
+ + +SubscribableStatus 		+

+(Members of SubscribableStatus are embedded into this type.) +

+

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

+
+deadLetterChannel
+ +knative.dev/pkg/apis/duck/v1.KReference + +		 (Optional) -

CopyConfigMaps is the status for each copied configmap.

+

DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel +Failed messages are delivered here.
-

ConfigMapPropagationStatusCopyConfigMap +

DeliverySpec

(Appears on: -ConfigMapPropagationStatus) +BrokerSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriberSpec, +SubscriptionSpec)

-

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

+

DeliverySpec contains the delivery options for event senders, +such as channelable and source.

@@ -2933,94 +3644,97 @@ knative.dev/pkg/apis/duck/v1.Status + +
-name
+deadLetterSink
-string +knative.dev/pkg/apis/duck/v1.Destination 		-

Name is copy configmap’s name

+(Optional) +

DeadLetterSink is the sink receiving event that could not be sent to +a destination.
-source
+retry
-string +int32 		-

Source is “originalNamespace/originalConfigMapName”

+(Optional) +

Retry is the minimum number of retries the sender should attempt when +sending an event before moving it to the dead letter sink.
-operation
+backoffPolicy
-string + +BackoffPolicyType + 		-

Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop

+(Optional) +

BackoffPolicy is the retry backoff policy (linear, exponential).
-ready
+backoffDelay
string 		-

Ready represents the operation is ready or not

+(Optional) +

BackoffDelay is the delay before retrying. +More information on Duration format: +- https://www.iso.org/iso-8601-date-and-time-format.html +- https://en.wikipedia.org/wiki/ISO_8601

+

For linear policy, backoff delay is the time interval between retries. +For exponential policy , backoff delay is backoffDelay*2^.
+

DeliveryStatus +

+

+

DeliveryStatus contains the Status of an object supporting delivery options.

+

+ + - - + + + +
-reason
- -string - -		 -

Reason indicates reasons if the operation is not ready

-		FieldDescription
-resourceVersionFromSource
+deadLetterChannel
-string +knative.dev/pkg/apis/duck/v1.KReference 		-

ResourceVersion is the resourceVersion of original configmap

+(Optional) +

DeadLetterChannel is a KReference that is the reference to the native, platform specific channel +where failed events are sent to.
-
-

duck.knative.dev/v1

-

-

Package v1 is the v1 version of the API.

-

-Resource Types: - -

BackoffPolicyType -(string alias)

-

-(Appears on: -DeliverySpec) -

-

-

BackoffPolicyType is the type for backoff policies

-

-

Channelable +

Subscribable

-

Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers +

Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

+SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

@@ -3048,72 +3762,94 @@ Refer to the Kubernetes API documentation for the fields of the +
spec
- -ChannelableSpec + +SubscribableSpec 		-

Spec is the part where the Channelable fulfills the Subscribable contract.

+

SubscribableSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.



+ +
-SubscribableSpec
+subscribers
- -SubscribableSpec + +[]SubscriberSpec 		-

-(Members of SubscribableSpec are embedded into this type.) -

+

This is the list of subscriptions for this subscribable.

+
-delivery
+status
- -DeliverySpec + +SubscribableStatus 		-(Optional) -

DeliverySpec contains options controlling the event delivery

+

SubscribableStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract.
- +

SubscribableSpec +

+

+(Appears on: +ChannelableCombinedSpec, +ChannelableSpec, +Subscribable) +

+

+

SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.

+

+ + + + + + +
FieldDescription
-status
+subscribers
- -ChannelableStatus + +[]SubscriberSpec 		+

This is the list of subscriptions for this subscribable.
-

ChannelableSpec +

SubscribableStatus

(Appears on: -ChannelSpec, -Channelable, -InMemoryChannelSpec) +ChannelableCombinedStatus, +ChannelableStatus, +Subscribable)

-

ChannelableSpec contains Spec of the Channelable object

+

SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.

@@ -3125,45 +3861,28 @@ ChannelableStatus - - - -
-SubscribableSpec
- - -SubscribableSpec - - -		 -

-(Members of SubscribableSpec are embedded into this type.) -

-
-delivery
+subscribers
- -DeliverySpec + +[]SubscriberStatus 		-(Optional) -

DeliverySpec contains options controlling the event delivery

+

This is the list of subscription’s statuses for this channel.
-

ChannelableStatus +

SubscriberSpec

(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) +SubscribableSpec)

-

ChannelableStatus contains the Status of a Channelable object.

+

SubscriberSpec defines a single subscriber to a Subscribable.

+

At least one of SubscriberURI and ReplyURI must be present

@@ -3175,79 +3894,77 @@ DeliverySpec + + + +
-Status
+uid
-knative.dev/pkg/apis/duck/v1.Status +k8s.io/apimachinery/pkg/types.UID 		-

-(Members of Status are embedded into this type.) -

-

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.

+(Optional) +

UID is used to understand the origin of the subscriber.
-AddressStatus
+generation
-knative.dev/pkg/apis/duck/v1.AddressStatus +int64 		-

-(Members of AddressStatus are embedded into this type.) -

-

AddressStatus is the part where the Channelable fulfills the Addressable contract.

+(Optional) +

Generation of the origin of the subscriber with uid:UID.
-SubscribableStatus
+subscriberUri
- -SubscribableStatus - +knative.dev/pkg/apis.URL 		-

-(Members of SubscribableStatus are embedded into this type.) -

-

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

+(Optional) +

SubscriberURI is the endpoint for the subscriber
-deadLetterChannel
+replyUri
-knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis.URL 		(Optional) -

DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel -Failed messages are delivered here.

+

ReplyURI is the endpoint for the reply

+
+delivery
+ + +DeliverySpec + + +		 +(Optional) +

DeliverySpec contains options controlling the event delivery
-

DeliverySpec +

SubscriberStatus

(Appears on: -BrokerSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriptionSpec) +SubscribableStatus, +SubscribableStatus)

-

DeliverySpec contains the delivery options for event senders, -such as channelable and source.

+

SubscriberStatus defines the status of a single subscriber to a Channel.

@@ -3259,65 +3976,74 @@ such as channelable and source.

-deadLetterSink
+uid
-knative.dev/pkg/apis/duck/v1.Destination +k8s.io/apimachinery/pkg/types.UID 		(Optional) -

DeadLetterSink is the sink receiving event that could not be sent to -a destination.

+

UID is used to understand the origin of the subscriber.
-retry
+observedGeneration
-int32 +int64 		(Optional) -

Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink.

+

Generation of the origin of the subscriber with uid:UID.
-backoffPolicy
+ready
- -BackoffPolicyType + +Kubernetes core/v1.ConditionStatus 		-(Optional) -

BackoffPolicy is the retry backoff policy (linear, exponential).

+

Status of the subscriber.
-backoffDelay
+message
string 		(Optional) -

BackoffDelay is the delay before retrying. -More information on Duration format: https://www.ietf.org/rfc/rfc3339.txt

-

For linear policy, backoff delay is the time interval between retries. -For exponential policy , backoff delay is backoffDelay*2^.

+

A human readable message indicating details of Ready status.
-

DeliveryStatus +
+

eventing.knative.dev/v1

+

+

Package v1 is the v1 version of the API.

+

+Resource Types: + +

Broker

-

DeliveryStatus contains the Status of an object supporting delivery options.

+

Broker 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.

@@ -3329,34 +4055,21 @@ For exponential policy , backoff delay is backoffDelay*2^.

 +apiVersion
+string - -
-deadLetterChannel
- -knative.dev/pkg/apis/duck/v1.KReference - -		 -(Optional) -

DeadLetterChannel is a KReference that is the reference to the native, platform specific channel -where failed events are sent to.

+ +eventing.knative.dev/v1 +
-

Subscribable -

-

-

Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

-

- - - - + + - - @@ -3375,92 +4089,70 @@ Refer to the Kubernetes API documentation for the fields of the -
FieldDescription +kind
+string +		Broker
metadata
@@ -3367,6 +4080,7 @@ Kubernetes meta/v1.ObjectMeta 		+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -SubscribableSpec + +BrokerSpec 		-

SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract.

+

Spec defines the desired state of the Broker.



- -
-subscribers
+config
- -[]SubscriberSpec - +knative.dev/pkg/apis/duck/v1.KReference 		-

This is the list of subscriptions for this subscribable.

-
+(Optional) +

Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.
-status
+delivery
- -SubscribableStatus + +DeliverySpec 		-

SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract.

+(Optional) +

Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.
-

SubscribableSpec -

-

-(Appears on: -ChannelableSpec, -Subscribable) -

-

-

SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.

-

- - - - - + - -
FieldDescription
-subscribers
+status
- -[]SubscriberSpec + +BrokerStatus 		-

This is the list of subscriptions for this subscribable.

+(Optional) +

Status represents the current state of the Broker. This data may be out of +date.
-

SubscribableStatus +

Trigger

-(Appears on: -ChannelableStatus, -Subscribable) -

-

-

SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.

+

Trigger represents a request to have events delivered to a subscriber from a +Broker’s event pool.

@@ -3472,109 +4164,115 @@ section of the resource.

+apiVersion
+string - -
-subscribers
- - -[]SubscriberStatus - - -		 -

This is the list of subscription’s statuses for this channel.

+ +eventing.knative.dev/v1 +
-

SubscriberSpec -

-

-(Appears on: -SubscribableSpec) -

-

-

SubscriberSpec defines a single subscriber to a Subscribable.

-

At least one of SubscriberURI and ReplyURI must be present

-

- - - - + + - -
FieldDescription +kind
+string +		Trigger
-uid
+metadata
-k8s.io/apimachinery/pkg/types.UID + +Kubernetes meta/v1.ObjectMeta + 		(Optional) -

UID is used to understand the origin of the subscriber.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-generation
+spec
-int64 + +TriggerSpec + 		-(Optional) -

Generation of the origin of the subscriber with uid:UID.

+

Spec defines the desired state of the Trigger.

+
+
+ + + + + +
+broker
+ +string + +		 +

Broker is the broker that this trigger receives events from.
-subscriberUri
+filter
-knative.dev/pkg/apis.URL + +TriggerFilter + 		(Optional) -

SubscriberURI is the endpoint for the subscriber

+

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.
-replyUri
+subscriber
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination 		-(Optional) -

ReplyURI is the endpoint for the reply

+

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.

+
-delivery
+status
- -DeliverySpec + +TriggerStatus 		(Optional) -

DeliverySpec contains options controlling the event delivery

+

Status represents the current state of the Trigger. This data may be out of +date.
-

SubscriberStatus +

BrokerSpec

(Appears on: -SubscribableStatus) +Broker)

-

SubscriberStatus defines the status of a single subscriber to a Channel.

@@ -3586,74 +4284,89 @@ DeliverySpec + +
-uid
+config
-k8s.io/apimachinery/pkg/types.UID +knative.dev/pkg/apis/duck/v1.KReference 		(Optional) -

UID is used to understand the origin of the subscriber.

+

Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.
-observedGeneration
+delivery
-int64 + +DeliverySpec + 		(Optional) -

Generation of the origin of the subscriber with uid:UID.

+

Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.
+

BrokerStatus +

+

+(Appears on: +Broker) +

+

+

BrokerStatus represents the current state of a Broker.

+

+ + + + + + + +
FieldDescription
-ready
+Status
- -Kubernetes core/v1.ConditionStatus - +knative.dev/pkg/apis/duck/v1.Status 		-

Status of the subscriber.

+

+(Members of Status are embedded into this type.) +

+

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.
-message
+address
-string +knative.dev/pkg/apis/duck/v1.Addressable 		-(Optional) -

A human readable message indicating details of Ready status.

+

Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh.
-
-

eventing.knative.dev/v1

+

TriggerFilter +

-

Package v1 is the v1 version of the API.

+(Appears on: +TriggerSpec)

-Resource Types: - -

Broker -

-

Broker 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. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.

@@ -3665,104 +4378,99 @@ Addressable endpoint.

- - - - - - - - - - - +
-apiVersion
-string		 - -eventing.knative.dev/v1 - -
-kind
-string -		Broker
-metadata
+attributes
- -Kubernetes meta/v1.ObjectMeta + +TriggerFilterAttributes 		(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values.

+

Nested context attributes are not supported as keys. Only string values are supported.
-spec
- - -BrokerSpec - - -		 -

Spec defines the desired state of the Broker.

-
-
+
+

TriggerFilterAttributes +(map[string]string alias)

+

+(Appears on: +TriggerFilter) +

+

+

TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.

+

+

TriggerSpec +

+

+(Appears on: +Trigger) +

+

+

+ + + + + + + - -
FieldDescription
-config
+broker
-knative.dev/pkg/apis/duck/v1.KReference +string 		-(Optional) -

Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap.

+

Broker is the broker that this trigger receives events from.
-delivery
+filter
- -DeliverySpec + +TriggerFilter 		(Optional) -

Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

-
+

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

-status
+subscriber
- -BrokerStatus - +knative.dev/pkg/apis/duck/v1.Destination -(Optional) -

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

+

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.

-

Trigger +

TriggerStatus

-

Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.

+(Appears on: +Trigger) +

+

+

TriggerStatus represents the current state of a Trigger.

@@ -3774,21 +4482,54 @@ Broker’s event pool.

+Status
+ +knative.dev/pkg/apis/duck/v1.Status + + - + + + +
-apiVersion
-string		 - -eventing.knative.dev/v1 - +

+(Members of Status are embedded into this type.) +

+

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.
-kind
-string +subscriberUri
+ +knative.dev/pkg/apis.URL + 		Trigger +

SubscriberURI is the resolved URI of the receiver for this Trigger.

+
+
+

flows.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

Parallel +

+

+

Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.

+

+ + + + + + +
FieldDescription
metadata
@@ -3808,53 +4549,55 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -TriggerSpec + +ParallelSpec 		-

Spec defines the desired state of the Trigger.

+

Spec defines the desired state of the Parallel.



-broker
+branches
-string + +[]ParallelBranch + 		-

Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

+

Branches is the list of Filter/Subscribers pairs.
-filter
+channelTemplate
- -TriggerFilter + +ChannelTemplateSpec 		(Optional) -

Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).
-subscriber
+reply
knative.dev/pkg/apis/duck/v1.Destination 		-

Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.

+(Optional) +

Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply
@@ -3864,24 +4607,24 @@ is required.

 status
- -TriggerStatus + +ParallelStatus 		(Optional) -

Status represents the current state of the Trigger. This data may be out of +

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

BrokerSpec +

ParallelBranch

(Appears on: -Broker) +ParallelSpec)

@@ -3895,43 +4638,66 @@ date.

-config
+filter
-knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis/duck/v1.Destination (Optional) -

Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap.

+

Filter is the expression guarding the branch

+ + + + +subscriber
+ +knative.dev/pkg/apis/duck/v1.Destination + + + +

Subscriber receiving the event when the filter passes

+ + + + +reply
+ +knative.dev/pkg/apis/duck/v1.Destination + + + +(Optional) +

Reply is a Reference to where the result of Subscriber of this case gets sent to. +If not specified, sent the result to the Parallel Reply

delivery
- + DeliverySpec (Optional) -

Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

+

Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. +Needed for Roundtripping v1alpha1 <-> v1beta1.

-

BrokerStatus +

ParallelBranchStatus

(Appears on: -Broker) +ParallelStatus)

-

BrokerStatus represents the current state of a Broker.

+

ParallelBranchStatus represents the current state of a Parallel branch

@@ -3943,39 +4709,51 @@ This includes things like retries, DLQ, etc.

+ + + +
-Status
+filterSubscriptionStatus
-knative.dev/pkg/apis/duck/v1.Status + +ParallelSubscriptionStatus + 		-

-(Members of Status are embedded into this type.) -

-

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.

+

FilterSubscriptionStatus corresponds to the filter subscription status.
-address
+filterChannelStatus
-knative.dev/pkg/apis/duck/v1.Addressable + +ParallelChannelStatus + 		-

Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh.

+

FilterChannelStatus corresponds to the filter channel status.

+
+subscriberSubscriptionStatus
+ + +ParallelSubscriptionStatus + + +		 +

SubscriptionStatus corresponds to the subscriber subscription status.
-

TriggerFilter +

ParallelChannelStatus

(Appears on: -TriggerSpec) +ParallelBranchStatus, +ParallelStatus)

@@ -3989,40 +4767,35 @@ delivered into the Broker mesh.

-attributes
+channel
- -TriggerFilterAttributes + +Kubernetes core/v1.ObjectReference -(Optional) -

Attributes filters events by exact match on event context attributes. -Each key in the map is compared with the equivalent key in the event -context. An event passes the filter if all values are equal to the -specified values.

-

Nested context attributes are not supported as keys. Only string values are supported.

+

Channel is the reference to the underlying channel.

- - -

TriggerFilterAttributes -(map[string]string alias)

-

-(Appears on: -TriggerFilter) -

-

-

TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.

-

-

TriggerSpec + + +ready
+ +knative.dev/pkg/apis.Condition + + + +

ReadyCondition indicates whether the Channel is ready or not.

+ + + + +

ParallelSpec

(Appears on: -Trigger) +Parallel)

@@ -4036,53 +4809,55 @@ to indicate all strings match.

-broker
+branches
-string + +[]ParallelBranch + -

Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

+

Branches is the list of Filter/Subscribers pairs.

-filter
+channelTemplate
- -TriggerFilter + +ChannelTemplateSpec (Optional) -

Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).

-subscriber
+reply
knative.dev/pkg/apis/duck/v1.Destination -

Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.

+(Optional) +

Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply

-

TriggerStatus +

ParallelStatus

(Appears on: -Trigger) +Parallel)

-

TriggerStatus represents the current state of a Trigger.

+

ParallelStatus represents the current state of a Parallel.

@@ -4104,151 +4879,102 @@ knative.dev/pkg/apis/duck/v1.Status (Members of Status are embedded into this type.)

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

- - -
-subscriberUri
+ingressChannelStatus
-knative.dev/pkg/apis.URL + +ParallelChannelStatus + 		-

SubscriberURI is the resolved URI of the receiver for this Trigger.

-
-
-

eventing.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

Broker -

-

-

Broker 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. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.

-

- - - - - - - - - - - - - - - + + +
FieldDescription
-apiVersion
-string		 - -eventing.knative.dev/v1beta1 - -
-kind
-string +

IngressChannelStatus corresponds to the ingress channel status.

Broker
-metadata
+branchStatuses
- -Kubernetes meta/v1.ObjectMeta + +[]ParallelBranchStatus 		-(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order.
-spec
+AddressStatus
- -BrokerSpec - +knative.dev/pkg/apis/duck/v1.AddressStatus 		-

Spec defines the desired state of the Broker.

-
-
+

+(Members of AddressStatus are embedded into this type.) +

+

AddressStatus is the starting point to this Parallel. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name}

+
+

ParallelSubscriptionStatus +

+

+(Appears on: +ParallelBranchStatus) +

+

+

+ - - + + + + - -
-config
- -knative.dev/pkg/apis/duck/v1.KReference - -		 -(Optional) -

Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap.

-		FieldDescription
-delivery
+subscription
- -DeliverySpec + +Kubernetes core/v1.ObjectReference 		-(Optional) -

Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

-
+

Subscription is the reference to the underlying Subscription.

-status
+ready
- -BrokerStatus - +knative.dev/pkg/apis.Condition -(Optional) -

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

+

ReadyCondition indicates whether the Subscription is ready or not.

-

EventType +

Sequence

+

Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.

@@ -4260,23 +4986,6 @@ date.

- - - - - - - - + +
-apiVersion
-string		 - -eventing.knative.dev/v1beta1 - -
-kind
-string -		EventType
metadata
@@ -4294,117 +5003,126 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -EventTypeSpec + +SequenceSpec 		-

Spec defines the desired state of the EventType.

+

Spec defines the desired state of the Sequence.



- - -
-type
+steps
-string + +[]SequenceStep + 		-

Type represents the CloudEvents type. It is authoritative.

+

Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options
-source
+channelTemplate
-knative.dev/pkg/apis.URL + +ChannelTemplateSpec + 		(Optional) -

Source is a URI, it represents the CloudEvents source.

+

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).
-schema
+reply
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination 		(Optional) -

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. -It may be a JSON schema, a protobuf schema, etc. It is optional.

+

Reply is a Reference to where the result of the last Subscriber gets sent to.
-schemaData
- -string - -		 -(Optional) -

SchemaData allows the CloudEvents schema to be stored directly in the -EventType. Content is dependent on the encoding. Optional attribute. -The contents are not validated or manipulated by the system.

+
-broker
+status
-string + +SequenceStatus + 		(Optional) -

TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType.

+

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

SequenceChannelStatus +

+

+(Appears on: +SequenceStatus) +

+

+

+ + + + + + + + - -
FieldDescription
-description
+channel
-string + +Kubernetes core/v1.ObjectReference + 		-(Optional) -

Description is an optional field used to describe the EventType, in any meaningful way.

-
+

Channel is the reference to the underlying channel.

-status
+ready
- -EventTypeStatus - +knative.dev/pkg/apis.Condition -(Optional) -

Status represents the current state of the EventType. -This data may be out of date. -TODO might be removed https://github.com/knative/eventing/issues/2750

+

ReadyCondition indicates whether the Channel is ready or not.

-

Trigger +

SequenceSpec

-

Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.

+(Appears on: +Sequence) +

+

@@ -4416,114 +5134,131 @@ Broker’s event pool.

- - - - + + +
-apiVersion
-string		 - -eventing.knative.dev/v1beta1 - +steps
+ + +[]SequenceStep + +
-kind
-string +

Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options

Trigger
-metadata
+channelTemplate
- -Kubernetes meta/v1.ObjectMeta + +ChannelTemplateSpec 		(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).
-spec
+reply
- -TriggerSpec - +knative.dev/pkg/apis/duck/v1.Destination 		-

Spec defines the desired state of the Trigger.

-
-
+(Optional) +

Reply is a Reference to where the result of the last Subscriber gets sent to.

+
+

SequenceStatus +

+

+(Appears on: +Sequence) +

+

+

SequenceStatus represents the current state of a Sequence.

+

+ + + + + + + - -
FieldDescription
-broker
+Status
-string +knative.dev/pkg/apis/duck/v1.Status 		-

Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

+

+(Members of Status are embedded into this type.) +

+

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.
-filter
+subscriptionStatuses
- -TriggerFilter + +[]SequenceSubscriptionStatus 		-(Optional) -

Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+

SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order.
-subscriber
+channelStatuses
-knative.dev/pkg/apis/duck/v1.Destination + +[]SequenceChannelStatus + 		-

Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.

-
+

ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order.

-status
+AddressStatus
- -TriggerStatus - +knative.dev/pkg/apis/duck/v1.AddressStatus -(Optional) -

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

+

+(Members of AddressStatus are embedded into this type.) +

+

AddressStatus is the starting point to this Sequence. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name}

-

BrokerSpec +

SequenceStep

(Appears on: -Broker) +SequenceSpec)

@@ -4537,16 +5272,16 @@ date.

-config
+Destination
-knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis/duck/v1.Destination -(Optional) -

Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap.

+

+(Members of Destination are embedded into this type.) +

+

Subscriber receiving the step event

@@ -4560,20 +5295,19 @@ DeliverySpec (Optional) -

Delivery is the delivery specification for Events within the Broker mesh. +

Delivery is the delivery specification for events to the subscriber This includes things like retries, DLQ, etc.

-

BrokerStatus +

SequenceSubscriptionStatus

(Appears on: -Broker) +SequenceStatus)

-

BrokerStatus represents the current state of a Broker.

@@ -4585,41 +5319,43 @@ This includes things like retries, DLQ, etc.

-Status
+subscription
-knative.dev/pkg/apis/duck/v1.Status + +Kubernetes core/v1.ObjectReference + 		-

-(Members of Status are embedded into this type.) -

-

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.

+

Subscription is the reference to the underlying Subscription.
-address
+ready
-knative.dev/pkg/apis/duck/v1.Addressable +knative.dev/pkg/apis.Condition 		-

Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh.

+

ReadyCondition indicates whether the Subscription is ready or not.
-

EventTypeSpec -

+
+

duck.knative.dev/v1alpha1

-(Appears on: -EventType) +

Package v1alpha1 is the v1alpha1 version of the API.

+Resource Types: + +

Channelable +

+

Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

@@ -4631,89 +5367,86 @@ delivered into the Broker mesh.

- - - - - +

Spec is the part where the Channelable fulfills the Subscribable contract.

+
+
+
-type
- -string - -		 -

Type represents the CloudEvents type. It is authoritative.

-
-source
+metadata
-knative.dev/pkg/apis.URL + +Kubernetes meta/v1.ObjectMeta + 		-(Optional) -

Source is a URI, it represents the CloudEvents source.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-schema
+spec
-knative.dev/pkg/apis.URL + +ChannelableSpec + 		-(Optional) -

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. -It may be a JSON schema, a protobuf schema, etc. It is optional.

-
+ +
-schemaData
+SubscribableTypeSpec
-string + +SubscribableTypeSpec + 		-(Optional) -

SchemaData allows the CloudEvents schema to be stored directly in the -EventType. Content is dependent on the encoding. Optional attribute. -The contents are not validated or manipulated by the system.

+

+(Members of SubscribableTypeSpec are embedded into this type.) +
-broker
+delivery
-string + +DeliverySpec + 		(Optional) -

TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType.

+

DeliverySpec contains options controlling the event delivery

+
-description
+status
-string + +ChannelableStatus + -(Optional) -

Description is an optional field used to describe the EventType, in any meaningful way.

-

EventTypeStatus +

ChannelableCombined

-(Appears on: -EventType) -

-

-

EventTypeStatus represents the current state of a EventType.

+

ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of +v1alpha1, v1beta1 and v1 duck types. This is not to be used by resource writers and is +only used by Subscription Controller to synthesize patches and read the Status +of the Channelable Resources. +This is not a real resource.

@@ -4725,184 +5458,135 @@ string - -
-Status
+metadata
-knative.dev/pkg/apis/duck/v1.Status + +Kubernetes meta/v1.ObjectMeta + 		-

-(Members of Status are embedded into this type.) -

-

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.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-

TriggerFilter -

-

-(Appears on: -TriggerSpec) -

-

-

- - - - - - - -
FieldDescription
-attributes
+spec
- -TriggerFilterAttributes + +ChannelableCombinedSpec 		-(Optional) -

Attributes filters events by exact match on event context attributes. -Each key in the map is compared with the equivalent key in the event -context. An event passes the filter if all values are equal to the -specified values.

-

Nested context attributes are not supported as keys. Only string values are supported.

+

Spec is the part where the Channelable fulfills the Subscribable contract.

+
+
+ + + - - -
+SubscribableTypeSpec
+ + +SubscribableTypeSpec + +
-

TriggerFilterAttributes -(map[string]string alias)

-

-(Appears on: -TriggerFilter) -

-

-

TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.

-

-

TriggerSpec -

-

-(Appears on: -Trigger) -

+

+(Members of SubscribableTypeSpec are embedded into this type.)

- - - - - +

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

+ - - - - -
FieldDescription
-broker
+SubscribableSpec
-string + +SubscribableSpec + 		-

Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

+

+(Members of SubscribableSpec are embedded into this type.) +

+

SubscribableSpec is for the v1beta1 spec compatibility.
-filter
+delivery
- -TriggerFilter + +DeliverySpec 		(Optional) -

Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+

DeliverySpec contains options controlling the event delivery +for the v1beta1 spec compatibility.
-subscriber
+SubscribableSpecv1
-knative.dev/pkg/apis/duck/v1.Destination + +SubscribableSpec + 		-

Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.

-
-

TriggerStatus -

-

-(Appears on: -Trigger) -

-

TriggerStatus represents the current state of a Trigger.

+(Members of SubscribableSpecv1 are embedded into this type.)

- - - - - +

SubscribableSpecv1 is for the v1 spec compatibility.

+ - - + +
FieldDescription
-Status
+deliveryv1
-knative.dev/pkg/apis/duck/v1.Status + +DeliverySpec + 		-

-(Members of Status are embedded into this type.) -

-

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.

+(Optional) +

DeliverySpecv1 contains options controlling the event delivery +for the v1 spec compatibility.

+
-subscriberUri
+status
-knative.dev/pkg/apis.URL + +ChannelableCombinedStatus + 		-

SubscriberURI is the resolved URI of the receiver for this Trigger.
-
-

flows.knative.dev/v1

+

ChannelableCombinedSpec +

-

Package v1 is the v1 version of the API.

+(Appears on: +ChannelableCombined)

-Resource Types: - -

Parallel -

-

Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.

+

ChannelableSpec contains Spec of the Channelable object

@@ -4914,101 +5598,92 @@ series through Channels and Subscriptions.

-
-metadata
+SubscribableTypeSpec
- -Kubernetes meta/v1.ObjectMeta + +SubscribableTypeSpec 		-(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

+(Members of SubscribableTypeSpec are embedded into this type.) +

+

SubscribableTypeSpec is for the v1alpha1 spec compatibility.
-spec
- - -ParallelSpec - - -		 -

Spec defines the desired state of the Parallel.

-
-
- - - - -
-branches
+SubscribableSpec
- -[]ParallelBranch + +SubscribableSpec 		-

Branches is the list of Filter/Subscribers pairs.

+

+(Members of SubscribableSpec are embedded into this type.) +

+

SubscribableSpec is for the v1beta1 spec compatibility.
-channelTemplate
+delivery
- -ChannelTemplateSpec + +DeliverySpec 		(Optional) -

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

+

DeliverySpec contains options controlling the event delivery +for the v1beta1 spec compatibility.
-reply
+SubscribableSpecv1
-knative.dev/pkg/apis/duck/v1.Destination + +SubscribableSpec + 		-(Optional) -

Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply

-
+

+(Members of SubscribableSpecv1 are embedded into this type.) +

+

SubscribableSpecv1 is for the v1 spec compatibility.
-status
+deliveryv1
- -ParallelStatus + +DeliverySpec 		(Optional) -

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

+

DeliverySpecv1 contains options controlling the event delivery +for the v1 spec compatibility.
-

ParallelBranch +

ChannelableCombinedStatus

(Appears on: -ParallelSpec) +ChannelableCombined)

+

ChannelableStatus contains the Status of a Channelable object.

@@ -5020,123 +5695,106 @@ date.

- - - - - - -
-filter
- -knative.dev/pkg/apis/duck/v1.Destination - -		 -(Optional) -

Filter is the expression guarding the branch

-
-subscriber
+Status
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.Status 		-

Subscriber receiving the event when the filter passes

+

+(Members of Status are embedded into this type.) +

+

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.
-reply
+AddressStatus
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus 		-(Optional) -

Reply is a Reference to where the result of Subscriber of this case gets sent to. -If not specified, sent the result to the Parallel Reply

+

+(Members of AddressStatus are embedded into this type.) +

+

AddressStatus is the part where the Channelable fulfills the Addressable contract.
-delivery
+SubscribableTypeStatus
- -DeliverySpec + +SubscribableTypeStatus 		-(Optional) -

Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc.

-
-

ParallelBranchStatus -

-

-(Appears on: -ParallelStatus) -

-

ParallelBranchStatus represents the current state of a Parallel branch

+(Members of SubscribableTypeStatus are embedded into this type.)

- - - - - +

SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

+ - -
FieldDescription
-filterSubscriptionStatus
+SubscribableStatus
- -ParallelSubscriptionStatus + +SubscribableStatus 		-

FilterSubscriptionStatus corresponds to the filter subscription status.

+

+(Members of SubscribableStatus are embedded into this type.) +

+

SubscribableStatus is the v1beta1 part of the Subscribers status.
-filterChannelStatus
+SubscribableStatusv1
- -ParallelChannelStatus + +SubscribableStatus 		-

FilterChannelStatus corresponds to the filter channel status.

+

+(Members of SubscribableStatusv1 are embedded into this type.) +

+

SubscribableStatusv1 is the v1 part of the Subscribers status.
-subscriberSubscriptionStatus
+errorChannel
- -ParallelSubscriptionStatus + +Kubernetes core/v1.ObjectReference 		-

SubscriptionStatus corresponds to the subscriber subscription status.

+(Optional) +

ErrorChannel is set by the channel when it supports native error handling via a channel
-

ParallelChannelStatus +

ChannelableSpec

(Appears on: -ParallelBranchStatus, -ParallelStatus) +Channelable)

+

ChannelableSpec contains Spec of the Channelable object

@@ -5148,37 +5806,43 @@ ParallelSubscriptionStatus
-channel
+SubscribableTypeSpec
- -Kubernetes core/v1.ObjectReference + +SubscribableTypeSpec 		-

Channel is the reference to the underlying channel.

+

+(Members of SubscribableTypeSpec are embedded into this type.) +
-ready
+delivery
-knative.dev/pkg/apis.Condition + +DeliverySpec + 		-

ReadyCondition indicates whether the Channel is ready or not.

+(Optional) +

DeliverySpec contains options controlling the event delivery
-

ParallelSpec +

ChannelableStatus

(Appears on: -Parallel) +Channelable)

+

ChannelableStatus contains the Status of a Channelable object.

@@ -5190,55 +5854,71 @@ knative.dev/pkg/apis.Condition + + + +
-branches
+Status
- -[]ParallelBranch - +knative.dev/pkg/apis/duck/v1.Status 		-

Branches is the list of Filter/Subscribers pairs.

+

+(Members of Status are embedded into this type.) +

+

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.
-channelTemplate
+AddressStatus
- -ChannelTemplateSpec +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus + +		 +

+(Members of AddressStatus are embedded into this type.) +

+

AddressStatus is the part where the Channelable fulfills the Addressable contract.

+
+SubscribableTypeStatus
+ + +SubscribableTypeStatus 		-(Optional) -

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

+

+(Members of SubscribableTypeStatus are embedded into this type.) +

+

Subscribers is populated with the statuses of each of the Channelable’s subscribers.
-reply
+errorChannel
-knative.dev/pkg/apis/duck/v1.Destination + +Kubernetes core/v1.ObjectReference + 		(Optional) -

Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply

+

ErrorChannel is set by the channel when it supports native error handling via a channel
-

ParallelStatus +

Resource

-(Appears on: -Parallel) -

-

-

ParallelStatus represents the current state of a Parallel.

+

Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch +arbitrary other resources (such as any Source or Addressable). This is not a real resource.

@@ -5250,72 +5930,62 @@ when the case does not have a Reply

- - - - + +
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-

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.

-
-ingressChannelStatus
+metadata
- -ParallelChannelStatus + +Kubernetes meta/v1.ObjectMeta 		-

IngressChannelStatus corresponds to the ingress channel status.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
+

Subscribable +

+

+(Appears on: +SubscribableTypeSpec) +

+

+

Subscribable is the schema for the subscribable portion of the spec +section of the resource.

+

+ + - - + + + +
-branchStatuses
- - -[]ParallelBranchStatus - - -		 -

BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order.

-		FieldDescription
-AddressStatus
+subscribers
-knative.dev/pkg/apis/duck/v1.AddressStatus + +[]SubscriberSpec + 		-

-(Members of AddressStatus are embedded into this type.) -

-

AddressStatus is the starting point to this Parallel. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name}

+

This is the list of subscriptions for this subscribable.
-

ParallelSubscriptionStatus +

SubscribableStatus

(Appears on: -ParallelBranchStatus) +SubscribableTypeStatus)

+

SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.

@@ -5327,35 +5997,38 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

-subscription
+subscribers
- -Kubernetes core/v1.ObjectReference + +[]SubscriberStatus 		-

Subscription is the reference to the underlying Subscription.

+

This is the list of subscription’s statuses for this channel.
-ready
+subscribersv1
-knative.dev/pkg/apis.Condition + +[]SubscriberStatus + 		-

ReadyCondition indicates whether the Subscription is ready or not.

+

This is the list of subscription’s statuses for this channel.
-

Sequence +

SubscribableType

-

Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.

+

SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

@@ -5375,7 +6048,6 @@ Kubernetes meta/v1.ObjectMeta @@ -5384,55 +6056,27 @@ Refer to the Kubernetes API documentation for the fields of the
-(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -SequenceSpec + +SubscribableTypeSpec 		-

Spec defines the desired state of the Sequence.

+

SubscribableTypeSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.



- - - - - - - -
-steps
- - -[]SequenceStep - - -		 -

Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options

-
-channelTemplate
+subscribable
- -ChannelTemplateSpec + +Subscribable 		-(Optional) -

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

-
-reply
- -knative.dev/pkg/apis/duck/v1.Destination - -		 -(Optional) -

Reply is a Reference to where the result of the last Subscriber gets sent to.
@@ -5442,26 +6086,28 @@ knative.dev/pkg/apis/duck/v1.Destination 		status
- -SequenceStatus + +SubscribableTypeStatus 		-(Optional) -

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

+

SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract.
-

SequenceChannelStatus +

SubscribableTypeSpec

(Appears on: -SequenceStatus) +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType)

+

SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.

@@ -5473,37 +6119,63 @@ date.

+ +
-channel
+subscribable
- -Kubernetes core/v1.ObjectReference + +Subscribable 		-

Channel is the reference to the underlying channel.
+

SubscribableTypeStatus +

+

+(Appears on: +ChannelableCombinedStatus, +ChannelableStatus, +SubscribableType) +

+

+

SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

+

+ + + + + + + +
FieldDescription
-ready
+subscribableStatus
-knative.dev/pkg/apis.Condition + +SubscribableStatus + 		-

ReadyCondition indicates whether the Channel is ready or not.
-

SequenceSpec +

SubscriberSpec

(Appears on: -Sequence) +Subscribable)

+

SubscriberSpec defines a single subscriber to a Subscribable. +Ref is a reference to the Subscription this SubscriberSpec was created for +SubscriberURI is the endpoint for the subscriber +ReplyURI is the endpoint for the reply +At least one of SubscriberURI and ReplyURI must be present

@@ -5515,55 +6187,110 @@ knative.dev/pkg/apis.Condition + + + + + + + + + + + + + + + +
-steps
+uid
- -[]SequenceStep - +k8s.io/apimachinery/pkg/types.UID 		-

Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options

+(Optional) +

UID is used to understand the origin of the subscriber.
-channelTemplate
+generation
- -ChannelTemplateSpec +int64 + +		 +(Optional) +

Generation of the origin of the subscriber with uid:UID.

+
+subscriberURI
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +
+replyURI
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +
+deadLetterSink
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +
+delivery
+ + +DeliverySpec 		(Optional) -

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).
-reply
+deliveryv1
-knative.dev/pkg/apis/duck/v1.Destination + +DeliverySpec + 		(Optional) -

Reply is a Reference to where the result of the last Subscriber gets sent to.
-

SequenceStatus -

+
+

eventing.knative.dev/v1beta1

-(Appears on: -Sequence) +

Package v1beta1 is the v1beta1 version of the API.

+Resource Types: + +

Broker +

-

SequenceStatus represents the current state of a Sequence.

+

Broker 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. Receivers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.

@@ -5571,77 +6298,107 @@ knative.dev/pkg/apis/duck/v1.Destination - - + + + + + + + + + +
Field Description
+apiVersion
+string		 + +eventing.knative.dev/v1beta1 + +
+kind
+string +		Broker
-Status
+metadata
-knative.dev/pkg/apis/duck/v1.Status + +Kubernetes meta/v1.ObjectMeta + 		-

-(Members of Status are embedded into this type.) -

-

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.

+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
-subscriptionStatuses
+spec
- -[]SequenceSubscriptionStatus + +BrokerSpec 		-

SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order.

+

Spec defines the desired state of the Broker.

+
+
+ + + + + +
+config
+ +knative.dev/pkg/apis/duck/v1.KReference + +		 +(Optional) +

Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.
-channelStatuses
+delivery
- -[]SequenceChannelStatus + +DeliverySpec 		-

ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order.

+(Optional) +

Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.

+
-AddressStatus
+status
-knative.dev/pkg/apis/duck/v1.AddressStatus + +BrokerStatus + 		-

-(Members of AddressStatus are embedded into this type.) -

-

AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name}

+(Optional) +

Status represents the current state of the Broker. This data may be out of +date.
-

SequenceStep +

EventType

-(Appears on: -SequenceSpec) -

-

+

EventType represents a type of event that can be consumed from a Broker.

@@ -5653,154 +6410,123 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

+ + + + - -
-Destination
- -knative.dev/pkg/apis/duck/v1.Destination - +apiVersion
+string		 + +eventing.knative.dev/v1beta1 +
-

-(Members of Destination are embedded into this type.) -

-

Subscriber receiving the step event

+kind
+string 		EventType
-delivery
+metadata
- -DeliverySpec + +Kubernetes meta/v1.ObjectMeta 		(Optional) -

Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-

SequenceSubscriptionStatus -

-

-(Appears on: -SequenceStatus) -

-

-

- - - - - - - - - +

Spec defines the desired state of the EventType.

+
+
+
FieldDescription
-subscription
+spec
- -Kubernetes core/v1.ObjectReference + +EventTypeSpec 		-

Subscription is the reference to the underlying Subscription.

-
- -
-ready
+type
-knative.dev/pkg/apis.Condition +string 		-

ReadyCondition indicates whether the Subscription is ready or not.

+

Type represents the CloudEvents type. It is authoritative.
-
-

duck.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

Channelable -

-

-

Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

-

- - - - + + - -
FieldDescription +source
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +

Source is a URI, it represents the CloudEvents source.

+
-metadata
+schema
- -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis.URL 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +(Optional) +

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.
-spec
+schemaData
- -ChannelableSpec - +string 		-

Spec is the part where the Channelable fulfills the Subscribable contract.

-
-
- +(Optional) +

SchemaData allows the CloudEvents schema to be stored directly in the +EventType. Content is dependent on the encoding. Optional attribute. +The contents are not validated or manipulated by the system.

+ +
-SubscribableTypeSpec
+broker
- -SubscribableTypeSpec - +string 		-

-(Members of SubscribableTypeSpec are embedded into this type.) -

+(Optional) +

TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.
-delivery
+description
- -DeliverySpec - +string 		(Optional) -

DeliverySpec contains options controlling the event delivery

+

Description is an optional field used to describe the EventType, in any meaningful way.
@@ -5810,24 +6536,25 @@ DeliverySpec 		status
- -ChannelableStatus + +EventTypeStatus 		+(Optional) +

Status represents the current state of the EventType. +This data may be out of date. +TODO might be removed https://github.com/knative/eventing/issues/2750
-

ChannelableCombined +

Trigger

-

ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of both -v1alpha1 and v1beta1 duck types. This is not to be used by resource writers and is -only used by Subscription Controller to synthesize patches and read the Status -of the Channelable Resources. -This is not a real resource.

+

Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.

@@ -5839,6 +6566,23 @@ This is not a real resource.

+ + + + + + + + @@ -5855,60 +6600,53 @@ Refer to the Kubernetes API documentation for the fields of the
+apiVersion
+string		 + +eventing.knative.dev/v1beta1 + +
+kind
+string +		Trigger
metadata
@@ -5847,6 +6591,7 @@ Kubernetes meta/v1.ObjectMeta 		+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ChannelableCombinedSpec + +TriggerSpec 		-

Spec is the part where the Channelable fulfills the Subscribable contract.

+

Spec defines the desired state of the Trigger.



-SubscribableTypeSpec
+broker
- -SubscribableTypeSpec - +string 		-

-(Members of SubscribableTypeSpec are embedded into this type.) -

-

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

+

Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.
-SubscribableSpec
+filter
- -SubscribableSpec + +TriggerFilter 		-

-(Members of SubscribableSpec are embedded into this type.) -

-

SubscribableSpec is for the v1beta1 spec compatibility.

+(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.
-delivery
+subscriber
- -DeliverySpec - +knative.dev/pkg/apis/duck/v1.Destination 		-(Optional) -

DeliverySpec contains options controlling the event delivery

+

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.
@@ -5918,24 +6656,26 @@ DeliverySpec 		status
- -ChannelableCombinedStatus + +TriggerStatus 		+(Optional) +

Status represents the current state of the Trigger. This data may be out of +date.
-

ChannelableCombinedSpec +

BrokerSpec

(Appears on: -ChannelableCombined) +Broker)

-

ChannelableSpec contains Spec of the Channelable object

@@ -5947,34 +6687,16 @@ ChannelableCombinedStatus - - - - @@ -5988,19 +6710,20 @@ DeliverySpec
-SubscribableTypeSpec
- - -SubscribableTypeSpec - - -		 -

-(Members of SubscribableTypeSpec are embedded into this type.) -

-

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

-
-SubscribableSpec
+config
- -SubscribableSpec - +knative.dev/pkg/apis/duck/v1.KReference 		-

-(Members of SubscribableSpec are embedded into this type.) -

-

SubscribableSpec is for the v1beta1 spec compatibility.

+(Optional) +

Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.
(Optional) -

DeliverySpec contains options controlling the event delivery

+

Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.
-

ChannelableCombinedStatus +

BrokerStatus

(Appears on: -ChannelableCombined) +Broker)

-

ChannelableStatus contains the Status of a Channelable object.

+

BrokerStatus represents the current state of a Broker.

@@ -6028,122 +6751,119 @@ knative.dev/pkg/apis/duck/v1.Status + + +
-AddressStatus
+address
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus +knative.dev/pkg/apis/duck/v1.Addressable 		+

Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh.

+
+

EventTypeSpec +

-(Members of AddressStatus are embedded into this type.) +(Appears on: +EventType)

-

AddressStatus is the part where the Channelable fulfills the Addressable contract.

- +

+

+ + + + + + + - -
FieldDescription
-SubscribableTypeStatus
+type
- -SubscribableTypeStatus - +string 		-

-(Members of SubscribableTypeStatus are embedded into this type.) -

-

SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

+

Type represents the CloudEvents type. It is authoritative.
-SubscribableStatus
+source
- -SubscribableStatus - +knative.dev/pkg/apis.URL 		-

-(Members of SubscribableStatus are embedded into this type.) -

-

SubscribableStatus is the v1beta1 part of the Subscribers status.

+(Optional) +

Source is a URI, it represents the CloudEvents source.
-errorChannel
+schema
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis.URL 		(Optional) -

ErrorChannel is set by the channel when it supports native error handling via a channel

+

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.
-

ChannelableSpec -

-

-(Appears on: -Channelable) -

-

-

ChannelableSpec contains Spec of the Channelable object

-

- - - - + + - -
FieldDescription +schemaData
+ +string + +		 +(Optional) +

SchemaData allows the CloudEvents schema to be stored directly in the +EventType. Content is dependent on the encoding. Optional attribute. +The contents are not validated or manipulated by the system.

+
-SubscribableTypeSpec
+broker
- -SubscribableTypeSpec - +string 		-

-(Members of SubscribableTypeSpec are embedded into this type.) -

+(Optional) +

TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.
-delivery
+description
- -DeliverySpec - +string 		(Optional) -

DeliverySpec contains options controlling the event delivery

+

Description is an optional field used to describe the EventType, in any meaningful way.
-

ChannelableStatus +

EventTypeStatus

(Appears on: -Channelable) +EventType)

-

ChannelableStatus contains the Status of a Channelable object.

+

EventTypeStatus represents the current state of a EventType.

@@ -6156,70 +6876,28 @@ DeliverySpec - - - - - - - - - - - -
Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-

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 AddressStatus are embedded into this type.) -

-

AddressStatus is the part where the Channelable fulfills the Addressable contract.

-
-SubscribableTypeStatus
- - -SubscribableTypeStatus - - -		 -

-(Members of SubscribableTypeStatus are embedded into this type.) -

-

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

-
-errorChannel
- - -Kubernetes core/v1.ObjectReference - + +knative.dev/pkg/apis/duck/v1.Status 		-(Optional) -

ErrorChannel is set by the channel when it supports native error handling via a channel

+

+(Members of Status are embedded into this type.) +

+

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.
-

Resource +

TriggerFilter

-

Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch -arbitrary other resources (such as any Source or Addressable). This is not a real resource.

+(Appears on: +TriggerSpec) +

+

@@ -6231,29 +6909,42 @@ arbitrary other resources (such as any Source or Addressable). This is not a rea
-metadata
+attributes
- -Kubernetes meta/v1.ObjectMeta + +TriggerFilterAttributes 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +(Optional) +

Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values.

+

Nested context attributes are not supported as keys. Only string values are supported.
-

Subscribable +

TriggerFilterAttributes +(map[string]string alias)

+

+(Appears on: +TriggerFilter) +

+

+

TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.

+

+

TriggerSpec

(Appears on: -SubscribableTypeSpec) +Trigger)

-

Subscribable is the schema for the subscribable portion of the spec -section of the resource.

@@ -6265,28 +6956,53 @@ section of the resource.

+ + + + + + + +
-subscribers
+broker
- -[]SubscriberSpec +string + +		 +

Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

+
+filter
+ + +TriggerFilter 		-

This is the list of subscriptions for this subscribable.

+(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+
+subscriber
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.
-

SubscribableStatus +

TriggerStatus

(Appears on: -SubscribableTypeStatus) +Trigger)

-

SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.

+

TriggerStatus represents the current state of a Trigger.

@@ -6298,25 +7014,45 @@ section of the resource.

+ + + +
-subscribers
+Status
- -[]SubscriberStatus - +knative.dev/pkg/apis/duck/v1.Status 		-

This is the list of subscription’s statuses for this channel.

+

+(Members of Status are embedded into this type.) +

+

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.

+
+subscriberUri
+ +knative.dev/pkg/apis.URL + +		 +

SubscriberURI is the resolved URI of the receiver for this Trigger.
-

SubscribableType +
+

flows.knative.dev/v1

+

+

Package v1 is the v1 version of the API.

+

+Resource Types: + +

Parallel

-

SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

+

Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.

@@ -6336,6 +7072,7 @@ Kubernetes meta/v1.ObjectMeta @@ -6344,126 +7081,84 @@ Refer to the Kubernetes API documentation for the fields of the - -
+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -SubscribableTypeSpec + +ParallelSpec 		-

SubscribableTypeSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract.

+

Spec defines the desired state of the Parallel.



- -
-subscribable
+branches
- -Subscribable + +[]ParallelBranch 		-
+

Branches is the list of Filter/Subscribers pairs.
-status
+channelTemplate
- -SubscribableTypeStatus + +ChannelTemplateSpec 		-

SubscribableTypeStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract.

+(Optional) +

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).
-

SubscribableTypeSpec -

-

-(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) -

-

-

SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.

-

- - - - - - - - -
FieldDescription
-subscribable
+reply
- -Subscribable - +knative.dev/pkg/apis/duck/v1.Destination 		+(Optional) +

Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply
-

SubscribableTypeStatus -

-

-(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -SubscribableType) -

-

-

SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

-

- - - - - + - -
FieldDescription
-subscribableStatus
+status
- -SubscribableStatus + +ParallelStatus 		+(Optional) +

Status represents the current state of the Parallel. This data may be out of +date.
-

SubscriberSpec +

ParallelBranch

(Appears on: -Subscribable) +ParallelSpec)

-

SubscriberSpec defines a single subscriber to a Subscribable. -Ref is a reference to the Subscription this SubscriberSpec was created for -SubscriberURI is the endpoint for the subscriber -ReplyURI is the endpoint for the reply -At least one of SubscriberURI and ReplyURI must be present

@@ -6475,98 +7170,65 @@ At least one of SubscriberURI and ReplyURI must be present

- - - - - - - -
-uid
- -k8s.io/apimachinery/pkg/types.UID - -		 -(Optional) -

UID is used to understand the origin of the subscriber.

-
-generation
- -int64 - -		 -(Optional) -

Generation of the origin of the subscriber with uid:UID.

-
-subscriberURI
+filter
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination 		(Optional) +

Filter is the expression guarding the branch
-replyURI
+subscriber
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination 		-(Optional) +

Subscriber receiving the event when the filter passes
-deadLetterSink
+reply
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination 		(Optional) +

Reply is a Reference to where the result of Subscriber of this case gets sent to. +If not specified, sent the result to the Parallel Reply
delivery
- + DeliverySpec 		(Optional) +

Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc.
-
-

duck.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

BackoffPolicyType -(string alias)

+

ParallelBranchStatus +

(Appears on: -DeliverySpec) -

-

-

BackoffPolicyType is the type for backoff policies

+ParallelStatus)

-

Channelable -

-

Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

+

ParallelBranchStatus represents the current state of a Parallel branch

@@ -6578,88 +7240,53 @@ Channelable ObjectReferences and access their subscription and address data. Th - - - - -
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ChannelableSpec - - -		 -

Spec is the part where the Channelable fulfills the Subscribable contract.

-
-
- - - - -
-SubscribableSpec
+filterSubscriptionStatus
- -SubscribableSpec + +ParallelSubscriptionStatus 		-

-(Members of SubscribableSpec are embedded into this type.) -

+

FilterSubscriptionStatus corresponds to the filter subscription status.
-delivery
+filterChannelStatus
- -DeliverySpec + +ParallelChannelStatus 		-(Optional) -

DeliverySpec contains options controlling the event delivery

-
+

FilterChannelStatus corresponds to the filter channel status.
-status
+subscriberSubscriptionStatus
- -ChannelableStatus + +ParallelSubscriptionStatus 		+

SubscriptionStatus corresponds to the subscriber subscription status.
-

ChannelableSpec +

ParallelChannelStatus

(Appears on: -ChannelSpec, -Channelable, -InMemoryChannelSpec) +ParallelBranchStatus, +ParallelStatus)

-

ChannelableSpec contains Spec of the Channelable object

@@ -6671,45 +7298,37 @@ ChannelableStatus
-SubscribableSpec
+channel
- -SubscribableSpec + +Kubernetes core/v1.ObjectReference 		-

-(Members of SubscribableSpec are embedded into this type.) -

+

Channel is the reference to the underlying channel.
-delivery
+ready
- -DeliverySpec - +knative.dev/pkg/apis.Condition 		-(Optional) -

DeliverySpec contains options controlling the event delivery

+

ReadyCondition indicates whether the Channel is ready or not.
-

ChannelableStatus +

ParallelSpec

(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) +Parallel)

-

ChannelableStatus contains the Status of a Channelable object.

@@ -6721,82 +7340,55 @@ DeliverySpec - - - -
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-

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
+branches
-knative.dev/pkg/apis/duck/v1.AddressStatus + +[]ParallelBranch + 		-

-(Members of AddressStatus are embedded into this type.) -

-

AddressStatus is the part where the Channelable fulfills the Addressable contract.

+

Branches is the list of Filter/Subscribers pairs.
-SubscribableStatus
+channelTemplate
- -SubscribableStatus + +ChannelTemplateSpec 		-

-(Members of SubscribableStatus are embedded into this type.) -

-

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

+(Optional) +

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).
-deadLetterChannel
+reply
-knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis/duck/v1.Destination 		(Optional) -

DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel -Failed messages are delivered here.

+

Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply
-

DeliverySpec +

ParallelStatus

(Appears on: -BrokerSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriberSpec, -SubscriptionSpec) +Parallel)

-

DeliverySpec contains the delivery options for event senders, -such as channelable and source.

+

ParallelStatus represents the current state of a Parallel.

@@ -6808,65 +7400,72 @@ such as channelable and source.

-deadLetterSink
+Status
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.Status 		-(Optional) -

DeadLetterSink is the sink receiving event that could not be sent to -a destination.

+

+(Members of Status are embedded into this type.) +

+

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.
-retry
+ingressChannelStatus
-int32 + +ParallelChannelStatus + 		-(Optional) -

Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink.

+

IngressChannelStatus corresponds to the ingress channel status.
-backoffPolicy
+branchStatuses
- -BackoffPolicyType + +[]ParallelBranchStatus 		-(Optional) -

BackoffPolicy is the retry backoff policy (linear, exponential).

+

BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order.
-backoffDelay
+AddressStatus
-string +knative.dev/pkg/apis/duck/v1.AddressStatus 		-(Optional) -

BackoffDelay is the delay before retrying. -More information on Duration format: https://www.ietf.org/rfc/rfc3339.txt

-

For linear policy, backoff delay is the time interval between retries. -For exponential policy , backoff delay is backoffDelay*2^.

+

+(Members of AddressStatus are embedded into this type.) +

+

AddressStatus is the starting point to this Parallel. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name}
-

DeliveryStatus +

ParallelSubscriptionStatus

-

DeliveryStatus contains the Status of an object supporting delivery options.

+(Appears on: +ParallelBranchStatus) +

+

@@ -6874,29 +7473,39 @@ For exponential policy , backoff delay is backoffDelay*2^.

 - - + + + + + +
Field Description
+subscription
+ + +Kubernetes core/v1.ObjectReference + + +		 +

Subscription is the reference to the underlying Subscription.

+
-deadLetterChannel
+ready
-knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis.Condition 		-(Optional) -

DeadLetterChannel is a KReference that is the reference to the native, platform specific channel -where failed events are sent to.

+

ReadyCondition indicates whether the Subscription is ready or not.
-

Subscribable +

Sequence

-

Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

+

Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.

@@ -6916,6 +7525,7 @@ Kubernetes meta/v1.ObjectMeta @@ -6924,28 +7534,55 @@ Refer to the Kubernetes API documentation for the fields of the
+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -SubscribableSpec + +SequenceSpec 		-

SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract.

+

Spec defines the desired state of the Sequence.



+ + + + + + + +
-subscribers
+steps
- -[]SubscriberSpec + +[]SequenceStep 		-

This is the list of subscriptions for this subscribable.

+

Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options

+
+channelTemplate
+ + +ChannelTemplateSpec + + +		 +(Optional) +

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).

+
+reply
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +(Optional) +

Reply is a Reference to where the result of the last Subscriber gets sent to.
@@ -6955,28 +7592,26 @@ configured as to be compatible with Subscribable contract.

 status
- -SubscribableStatus + +SequenceStatus 		-

SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract.

+(Optional) +

Status represents the current state of the Sequence. This data may be out of +date.
-

SubscribableSpec +

SequenceChannelStatus

(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -Subscribable) +SequenceStatus)

-

SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.

@@ -6988,30 +7623,37 @@ configured as to be compatible with Subscribable contract.

+ + + +
-subscribers
+channel
- -[]SubscriberSpec + +Kubernetes core/v1.ObjectReference 		-

This is the list of subscriptions for this subscribable.

+

Channel is the reference to the underlying channel.

+
+ready
+ +knative.dev/pkg/apis.Condition + +		 +

ReadyCondition indicates whether the Channel is ready or not.
-

SubscribableStatus +

SequenceSpec

(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -Subscribable) +Sequence)

-

SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.

@@ -7023,28 +7665,55 @@ section of the resource.

+ + + + + + + +
-subscribers
+steps
- -[]SubscriberStatus + +[]SequenceStep 		-

This is the list of subscription’s statuses for this channel.

+

Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options

+
+channelTemplate
+ + +ChannelTemplateSpec + + +		 +(Optional) +

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).

+
+reply
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +(Optional) +

Reply is a Reference to where the result of the last Subscriber gets sent to.
-

SubscriberSpec +

SequenceStatus

(Appears on: -SubscribableSpec) +Sequence)

-

SubscriberSpec defines a single subscriber to a Subscribable.

-

At least one of SubscriberURI and ReplyURI must be present

+

SequenceStatus represents the current state of a Sequence.

@@ -7056,77 +7725,73 @@ section of the resource.

- - - -
-uid
- -k8s.io/apimachinery/pkg/types.UID - -		 -(Optional) -

UID is used to understand the origin of the subscriber.

-
-generation
+Status
-int64 +knative.dev/pkg/apis/duck/v1.Status 		-(Optional) -

Generation of the origin of the subscriber with uid:UID.

+

+(Members of Status are embedded into this type.) +

+

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.
-subscriberUri
+subscriptionStatuses
-knative.dev/pkg/apis.URL + +[]SequenceSubscriptionStatus + 		-(Optional) -

SubscriberURI is the endpoint for the subscriber

+

SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order.
-replyUri
+channelStatuses
-knative.dev/pkg/apis.URL + +[]SequenceChannelStatus + 		-(Optional) -

ReplyURI is the endpoint for the reply

+

ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order.
-delivery
+AddressStatus
- -DeliverySpec - +knative.dev/pkg/apis/duck/v1.AddressStatus 		-(Optional) -

DeliverySpec contains options controlling the event delivery

+

+(Members of AddressStatus are embedded into this type.) +

+

AddressStatus is the starting point to this Sequence. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name}
-

SubscriberStatus +

SequenceStep

(Appears on: -SubscribableStatus, -SubscribableStatus) +SequenceSpec)

-

SubscriberStatus defines the status of a single subscriber to a Channel.

@@ -7138,51 +7803,73 @@ DeliverySpec + +
-uid
+Destination
-k8s.io/apimachinery/pkg/types.UID +knative.dev/pkg/apis/duck/v1.Destination 		-(Optional) -

UID is used to understand the origin of the subscriber.

+

+(Members of Destination are embedded into this type.) +

+

Subscriber receiving the step event
-observedGeneration
+delivery
-int64 + +DeliverySpec + 		(Optional) -

Generation of the origin of the subscriber with uid:UID.

+

Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc.
+

SequenceSubscriptionStatus +

+

+(Appears on: +SequenceStatus) +

+

+

+ + + + + + + + @@ -8006,19 +8693,21 @@ knative.dev/pkg/apis.URL
FieldDescription
-ready
+subscription
- -Kubernetes core/v1.ConditionStatus + +Kubernetes core/v1.ObjectReference 		-

Status of the subscriber.

+

Subscription is the reference to the underlying Subscription.
-message
+ready
-string +knative.dev/pkg/apis.Condition 		-(Optional) -

A human readable message indicating details of Ready status.

+

ReadyCondition indicates whether the Subscription is ready or not.
-

sources.knative.dev/v1alpha1

+

sources.knative.dev/v1beta1

-

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

+

Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.

Resource Types: -

ApiServerSource +

ApiServerSource

ApiServerSource is the Schema for the apiserversources API

@@ -8037,7 +8726,7 @@ Resource Types: string -sources.knative.dev/v1alpha1 +sources.knative.dev/v1beta1 @@ -8066,7 +8755,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + ApiServerSourceSpec @@ -8077,82 +8766,79 @@ ApiServerSourceSpec - - - -
-resources
- - -[]ApiServerResource - - -		 -

Resources is the list of resources to watch

-
-serviceAccountName
+SourceSpec
-string +knative.dev/pkg/apis/duck/v1.SourceSpec 		-(Optional) -

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

+

+(Members of SourceSpec are embedded into this type.) +

+

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.
-sink
+resources
-knative.dev/pkg/apis/duck/v1beta1.Destination + +[]APIVersionKindSelector + 		-(Optional) -

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

+

Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter.
-ceOverrides
+owner
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +APIVersionKind + 		(Optional) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

+

ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.
-owner
+mode
- -APIVersionKind - +string 		(Optional) -

ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

+

EventMode controls the format of the event. +Reference sends a dataref event type for the resource under watch. +Resource send the full resource lifecycle event. +Defaults to Reference
-mode
+serviceAccountName
string 		-

Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

+(Optional) +

ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set.
@@ -8162,7 +8848,7 @@ string status
- + ApiServerSourceStatus @@ -8172,10 +8858,10 @@ ApiServerSourceStatus -

PingSource +

ContainerSource

-

PingSource is the Schema for the PingSources API.

+

ContainerSource is the Schema for the containersources API

@@ -8191,7 +8877,7 @@ ApiServerSourceStatus string @@ -8200,7 +8886,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -8231,75 +8917,165 @@ PingSourceSpec
-sources.knative.dev/v1alpha1 +sources.knative.dev/v1beta1
PingSourceContainerSource
@@ -8220,8 +8906,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -PingSourceSpec + +ContainerSourceSpec
+ + + + + +
-schedule
+SourceSpec
-string +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

+(Members of SourceSpec are embedded into this type.) +

+

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.

+
+template
+ + +Kubernetes core/v1.PodTemplateSpec + 		-

Schedule is the cronjob schedule.

+

Template describes the pods that will be created

+
-data
+status
+ +ContainerSourceStatus + + + + + + + + +

PingSource +

+

+

PingSource is the Schema for the PingSources API.

+

+ + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.knative.dev/v1beta1 + +
+kind
string +		PingSource
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + 		-

Data is the data posted to the target function.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-sink
+spec
-knative.dev/pkg/apis/duck/v1.Destination + +PingSourceSpec + + +		 +
+
+ + +
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec 		-

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

+

+(Members of SourceSpec are embedded into this type.) +

+

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.
-ceOverrides
+schedule
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides +string 		(Optional) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

+

Schedule is the cronjob schedule. Defaults to * * * * *.
-serviceAccountName
+timezone
string 		-

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. -Deprecated: v1beta1 drops this field.

+

Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-resources
+jsonData
- -PingResourceSpec - +string 		-

Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

+(Optional) +

JsonData is json encoded data used as the body of the event posted to +the sink. Default is empty. If set, datacontenttype will also be set +to “application/json”.
@@ -8309,7 +9085,7 @@ Deprecated: v1beta1 drops this field.

 status
- + PingSourceStatus @@ -8319,7 +9095,7 @@ PingSourceStatus
-

SinkBinding +

SinkBinding

SinkBinding describes a Binding that is also a Source. @@ -8343,7 +9119,7 @@ cloud events.

string -sources.knative.dev/v1alpha1 +sources.knative.dev/v1beta1 @@ -8372,7 +9148,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + SinkBindingSpec @@ -8392,19 +9168,27 @@ knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

+

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.

BindingSpec
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +knative.dev/pkg/apis/duck/v1beta1.BindingSpec

(Members of BindingSpec are embedded into this type.)

+

inherits duck/v1beta1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations.

@@ -8414,24 +9198,66 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec status
- -SinkBindingStatus - + +SinkBindingStatus + + + + + + + + +

APIVersionKind +

+

+(Appears on: +ApiServerSourceSpec) +

+

+

APIVersionKind is an APIVersion and Kind tuple.

+

+ + + + + + + + + + + + + +
FieldDescription
+apiVersion
+ +string + +		 +

APIVersion - the API version of the resource to watch.

+
+kind
+ +string 		+

Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-

ApiServerResource +

APIVersionKindSelector

(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)

-

ApiServerResource defines the resource to watch

+

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

@@ -8449,7 +9275,7 @@ string @@ -8466,7 +9292,7 @@ More info: Kubernetes meta/v1.LabelSelector @@ -8474,46 +9300,19 @@ Kubernetes meta/v1.LabelSelector - - - - - - - -
-

API version of the resource to watch.

+

APIVersion - the API version of the resource to watch.
-

LabelSelector restricts this source to objects with the selected labels +(Optional) +

LabelSelector filters this source to objects to those resources pass the +label selector. More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
-controllerSelector
- - -Kubernetes meta/v1.OwnerReference - - -		 -

ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. -Deprecated: Per-resource owner refs will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

-
-controller
- -bool - -		 -

If true, send an event referencing the object controlling the resource -Deprecated: Per-resource controller flag will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

-
-

ApiServerSourceSpec +

ApiServerSourceSpec

(Appears on: -ApiServerSource) +ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -8528,91 +9327,88 @@ v1alpha2, please use Spec.Owner as a GKV.

-resources
- - -[]ApiServerResource - - - - -

Resources is the list of resources to watch

- - - - -serviceAccountName
+SourceSpec
-string +knative.dev/pkg/apis/duck/v1.SourceSpec -(Optional) -

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

+

+(Members of SourceSpec are embedded into this type.) +

+

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.

-sink
+resources
-knative.dev/pkg/apis/duck/v1beta1.Destination + +[]APIVersionKindSelector + -(Optional) -

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

+

Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter.

-ceOverrides
+owner
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +APIVersionKind + (Optional) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

+

ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

-owner
+mode
- -APIVersionKind - +string (Optional) -

ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

+

EventMode controls the format of the event. +Reference sends a dataref event type for the resource under watch. +Resource send the full resource lifecycle event. +Defaults to Reference

-mode
+serviceAccountName
string -

Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

+(Optional) +

ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set.

-

ApiServerSourceStatus +

ApiServerSourceStatus

(Appears on: -ApiServerSource) +ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -8647,13 +9443,14 @@ Source.

-

PingLimitsSpec +

ContainerSourceSpec

(Appears on: -PingResourceSpec) +ContainerSource)

+

ContainerSourceSpec defines the desired state of ContainerSource

@@ -8665,71 +9462,45 @@ Source.

- - - - - - -
-cpu
- -string - -		 -
-memory
+SourceSpec
-string +knative.dev/pkg/apis/duck/v1.SourceSpec 		-
-

PingRequestsSpec -

-

-(Appears on: -PingResourceSpec) -

+(Members of SourceSpec are embedded into this type.)

- - - - - - - - - - -
FieldDescription
-cpu
- -string - -		 +

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.
-memory
+template
-string + +Kubernetes core/v1.PodTemplateSpec + 		+

Template describes the pods that will be created
-

PingResourceSpec +

ContainerSourceStatus

(Appears on: -PingSourceSpec) +ContainerSource)

+

ContainerSourceStatus defines the observed state of ContainerSource

@@ -8741,35 +9512,31 @@ string - - - -
-requests
- - -PingRequestsSpec - - -		 -
-limits
+SourceStatus
- -PingLimitsSpec - +knative.dev/pkg/apis/duck/v1.SourceStatus 		+

+(Members of SourceStatus are embedded into this type.) +

+

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.
-

PingSourceSpec +

PingSourceSpec

(Appears on: -PingSource) +PingSource)

PingSourceSpec defines the desired state of the PingSource.

@@ -8784,84 +9551,69 @@ PingLimitsSpec -schedule
+SourceSpec
-string +knative.dev/pkg/apis/duck/v1.SourceSpec -

Schedule is the cronjob schedule.

+

+(Members of SourceSpec are embedded into this type.) +

+

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.

-data
+schedule
string -

Data is the data posted to the target function.

- - - - -sink
- -knative.dev/pkg/apis/duck/v1.Destination - - - -

Sink is a reference to an object that will resolve to a uri 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.

+

Schedule is the cronjob schedule. Defaults to * * * * *.

-serviceAccountName
+timezone
string -

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. -Deprecated: v1beta1 drops this field.

+

Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

-resources
+jsonData
- -PingResourceSpec - +string -

Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

+(Optional) +

JsonData is json encoded data used as the body of the event posted to +the sink. Default is empty. If set, datacontenttype will also be set +to “application/json”.

-

PingSourceStatus +

PingSourceStatus

(Appears on: -PingSource) +PingSource)

PingSourceStatus defines the observed state of PingSource.

@@ -8896,11 +9648,11 @@ Source.

-

SinkBindingSpec +

SinkBindingSpec

(Appears on: -SinkBinding) +SinkBinding)

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

@@ -8924,28 +9676,36 @@ knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

+

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.

BindingSpec
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +knative.dev/pkg/apis/duck/v1beta1.BindingSpec

(Members of BindingSpec are embedded into this type.)

+

inherits duck/v1beta1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations.

-

SinkBindingStatus +

SinkBindingStatus

(Appears on: -SinkBinding) +SinkBinding)

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

@@ -8969,6 +9729,13 @@ knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)

+

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.

@@ -8976,5 +9743,5 @@ knative.dev/pkg/apis/duck/v1.SourceStatus

Generated with gen-crd-api-reference-docs -on git commit e018fe79. +on git commit 9f3fb3ff.

diff --git a/docs/reference/serving.md b/docs/reference/serving.md index aeb6ace010..b91396bdfd 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1,7 +1,7 @@

Packages:

-

autoscaling.internal.knative.dev/v1alpha1

+

serving.knative.dev/v1beta1

Resource Types: -

PodAutoscaler +

Configuration

-

PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative -components instantiate autoscalers. This definition is an abstraction that may be backed -by multiple definitions. For more information, see the Knative Pluggability presentation: -https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit

+

Configuration represents the “floating HEAD” of a linear history of Revisions. +Users create new Revisions by updating the Configuration’s spec. +The “latest created” revision’s name is available under status, as is the +“latest ready” revision’s name. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration

@@ -42,7 +46,7 @@ by multiple definitions. For more information, see the Knative Pluggability pre string @@ -51,7 +55,7 @@ autoscaling.internal.knative.dev/v1alpha1 kind
string - +
-autoscaling.internal.knative.dev/v1alpha1 +serving.knative.dev/v1beta1
PodAutoscalerConfiguration
@@ -72,85 +76,28 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -PodAutoscalerSpec + +ConfigurationSpec 		(Optional) -

Spec holds the desired state of the PodAutoscaler (from the client).



- - - - - - - - - - - - - - - -
-generation
- -int64 - -		 -(Optional) -

DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server

-

This property will be dropped in future Knative releases and should -not be used - use metadata.generation

-

Tracking issue: https://github.com/knative/serving/issues/643

-
-containerConcurrency
- -int64 - -		 -(Optional) -

ContainerConcurrency specifies the maximum allowed -in-flight (concurrent) requests per container of the Revision. -Defaults to 0 which means unlimited concurrency.

-
-scaleTargetRef
- - -Kubernetes core/v1.ObjectReference - - -		 -

ScaleTargetRef defines the /scale-able resource that this PodAutoscaler -is responsible for quickly right-sizing.

-
-reachability
+template
- -ReachabilityType + +RevisionTemplateSpec 		(Optional) -

Reachable specifies whether or not the ScaleTargetRef can be reached (ie. has a route). -Defaults to ReachabilityUnknown

-
-protocolType
- -knative.dev/networking/pkg/apis/networking.ProtocolType - -		 -

The application-layer protocol. Matches ProtocolType inferred from the revision spec.

+

Template holds the latest specification for the Revision to be stamped out.
@@ -160,22 +107,24 @@ knative.dev/networking/pkg/apis/networking.ProtocolType 		status
- -PodAutoscalerStatus + +ConfigurationStatus 		(Optional) -

Status communicates the observed state of the PodAutoscaler (from the controller).
-

Metric +

Revision

-

Metric represents a resource to configure the metric collector with.

+

Revision is an immutable snapshot of code and configuration. A revision +references a container image. Revisions are created by updates to a +Configuration.

+

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision

@@ -187,6 +136,23 @@ PodAutoscalerStatus + + + + + + + +
+apiVersion
+string		 + +serving.knative.dev/v1beta1 + +
+kind
+string +		Revision
metadata
@@ -204,48 +170,58 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -MetricSpec + +RevisionSpec 		(Optional) -

Spec holds the desired state of the Metric (from the client).



-stableWindow
+PodSpec
-time.Duration + +Kubernetes core/v1.PodSpec + 		-

StableWindow is the aggregation window for metrics in a stable state.

+

+(Members of PodSpec are embedded into this type.) +
-panicWindow
+containerConcurrency
-time.Duration +int64 		-

PanicWindow is the aggregation window for metrics where quick reactions are needed.

+(Optional) +

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) +requests per container of the Revision. Defaults to 0 which means +concurrency to the application is not limited, and the system decides the +target concurrency for the autoscaler.
-scrapeTarget
+timeoutSeconds
-string +int64 		-

ScrapeTarget is the K8s service that publishes the metric endpoint.

+(Optional) +

TimeoutSeconds holds the max duration the instance is allowed for +responding to a request. If unspecified, a system default will +be provided.
@@ -255,26 +231,26 @@ string 		status
- -MetricStatus + +RevisionStatus 		(Optional) -

Status communicates the observed state of the Metric (from the controller).
-

MetricSpec +

Route

-(Appears on: -Metric) -

-

-

MetricSpec contains all values a metric collector needs to operate.

+

Route is responsible for configuring ingress over a collection of Revisions. +Some of the Revisions a Route distributes traffic over may be specified by +referencing the Configuration responsible for creating them; in these cases +the Route is additionally responsible for monitoring the Configuration for +“latest ready revision” changes, and smoothly rolling out latest revisions. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

@@ -286,79 +262,98 @@ MetricStatus + + + + +
-stableWindow
- -time.Duration - +apiVersion
+string		 + +serving.knative.dev/v1beta1 +
-

StableWindow is the aggregation window for metrics in a stable state.

+kind
+string 		Route
-panicWindow
+metadata
-time.Duration + +Kubernetes meta/v1.ObjectMeta + 		-

PanicWindow is the aggregation window for metrics where quick reactions are needed.

+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
-scrapeTarget
+spec
-string + +RouteSpec + + +		 +(Optional) +

Spec holds the desired state of the Route (from the client).

+
+
+ + + -
+traffic
+ + +[]TrafficTarget + 		-

ScrapeTarget is the K8s service that publishes the metric endpoint.

+(Optional) +

Traffic specifies how to distribute traffic over a collection of +revisions and configurations.
-

MetricStatus -

-

-(Appears on: -Metric) -

-

-

MetricStatus reflects the status of metric collection for this specific entity.

-

- - - - - + - -
FieldDescription
-Status
+status
-knative.dev/pkg/apis/duck/v1.Status + +RouteStatus + 		-

-(Members of Status are embedded into this type.) -

+(Optional) +

Status communicates the observed state of the Route (from the controller).
-

PodAutoscalerSpec +

Service

-(Appears on: -PodAutoscaler) -

-

-

PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).

+

Service acts as a top-level container that manages a Route and Configuration +which implement a network service. Service exists to provide a singular +abstraction which can be access controlled, reasoned about, and which +encapsulates software lifecycle decisions such as rollout policy and +team resource ownership. Service acts only as an orchestrator of the +underlying Routes and Configurations (much as a kubernetes Deployment +orchestrates ReplicaSets), and its usage is optional but recommended.

+

The Service’s controller will track the statuses of its owned Configuration +and Route, reflecting their statuses and conditions as its own.

+

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service

@@ -370,230 +365,83 @@ knative.dev/pkg/apis/duck/v1.Status +apiVersion
+string - + - +
+
+
-generation
- -int64 - -		 -(Optional) -

DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server

-

This property will be dropped in future Knative releases and should -not be used - use metadata.generation

-

Tracking issue: https://github.com/knative/serving/issues/643

+ +serving.knative.dev/v1beta1 +
-containerConcurrency
- -int64 - -		 -(Optional) -

ContainerConcurrency specifies the maximum allowed -in-flight (concurrent) requests per container of the Revision. -Defaults to 0 which means unlimited concurrency.

+kind
+string 		Service
-scaleTargetRef
+metadata
- -Kubernetes core/v1.ObjectReference + +Kubernetes meta/v1.ObjectMeta 		-

ScaleTargetRef defines the /scale-able resource that this PodAutoscaler -is responsible for quickly right-sizing.

+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
-reachability
+spec
- -ReachabilityType + +ServiceSpec 		(Optional) -

Reachable specifies whether or not the ScaleTargetRef can be reached (ie. has a route). -Defaults to ReachabilityUnknown

-
- - - -
-protocolType
+ConfigurationSpec
-knative.dev/networking/pkg/apis/networking.ProtocolType - -		 -

The application-layer protocol. Matches ProtocolType inferred from the revision spec.

-
-

PodAutoscalerStatus -

-

-(Appears on: -PodAutoscaler) -

-

-

PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).

-

- - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status + +ConfigurationSpec +

-(Members of Status are embedded into this type.) +(Members of ConfigurationSpec are embedded into this type.)

+

ServiceSpec inlines an unrestricted ConfigurationSpec.
-serviceName
- -string - -		 -

ServiceName is the K8s Service name that serves the revision, scaled by this PA. -The service is created and owned by the ServerlessService object owned by this PA.

-
-metricsServiceName
- -string - -		 -

MetricsServiceName is the K8s Service name that provides revision metrics. -The service is managed by the PA object.

-
-desiredScale
- -int32 - -		 -

DesiredScale shows the current desired number of replicas for the revision.

-
-actualScale
+RouteSpec
-int32 + +RouteSpec + 		-

ActualScale shows the actual number of replicas for the revision.

-
-

PodScalable -

-

PodScalable is a duck type that the resources referenced by the -PodAutoscaler’s ScaleTargetRef must implement. They must also -implement the /scale sub-resource for use with /scale based -implementations (e.g. HPA), but this further constrains the shape -the referenced resources may take.

+(Members of RouteSpec are embedded into this type.)

- - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -PodScalableSpec - - -		 -
-
- - - - - - - - - - - -
-replicas
- -int32 - -		 -
-selector
- - -Kubernetes meta/v1.LabelSelector - - -		 -
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 +

ServiceSpec inlines RouteSpec and restricts/defaults its fields +via webhook. In particular, this spec can only reference this +Service’s configuration and revisions (which also influences +defaults).
@@ -603,110 +451,17 @@ Kubernetes core/v1.PodTemplateSpec 		status
- -PodScalableStatus - - -		 -
-

PodScalableSpec -

-

-(Appears on: -PodScalable) -

-

-

PodScalableSpec is the specification for the desired state of a -PodScalable (or at least our shared portion).

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-replicas
- -int32 - -		 -
-selector
- - -Kubernetes meta/v1.LabelSelector - - -		 -
-template
- - -Kubernetes core/v1.PodTemplateSpec + +ServiceStatus 		+(Optional)
-

PodScalableStatus -

-

-(Appears on: -PodScalable) -

-

-

PodScalableStatus is the observed state of a PodScalable (or at -least our shared portion).

-

- - - - - - - - - - - - - -
FieldDescription
-replicas
- -int32 - -		 -
-

ReachabilityType -(string alias)

-

-(Appears on: -PodAutoscalerSpec) -

-

-

ReachabilityType is the enumeration type for the different states of reachability -to the ScaleTarget of a PodAutoscaler

-

serving.knative.dev/v1

@@ -1165,7 +920,7 @@ ServiceStatus

(Appears on: Configuration, -Configuration, +Configuration, ServiceSpec)

@@ -1199,8 +954,8 @@ RevisionTemplateSpec

(Appears on: -Configuration, -Configuration) +Configuration, +Configuration)

ConfigurationStatus communicates the observed state of the Configuration (from the controller).

@@ -1334,8 +1089,8 @@ string

(Appears on: -Revision, Revision, +Revision, RevisionSpec, RevisionTemplateSpec)

@@ -1400,8 +1155,8 @@ be provided.

(Appears on: -Revision, -Revision) +Revision, +Revision)

RevisionStatus communicates the observed state of the Revision (from the controller).

@@ -1595,8 +1350,8 @@ be provided.

(Appears on: -Route, Route, +Route, ServiceSpec)

@@ -1631,8 +1386,8 @@ revisions and configurations.

(Appears on: -Route, -Route) +Route, +Route)

RouteStatus communicates the observed state of the Route (from the controller).

@@ -1739,12 +1494,17 @@ LatestReadyRevisionName that we last observed.
+

RoutingState +(string alias)

+

+

RoutingState represents states of a revision with regards to serving a route.

+

ServiceSpec

(Appears on: -Service, -Service) +Service, +Service)

ServiceSpec represents the configuration for the Service object. @@ -1804,8 +1564,8 @@ defaults).

(Appears on: -Service, -Service) +Service, +Service)

ServiceStatus represents the Status stanza of the Service resource.

@@ -3758,460 +3518,7 @@ Ultimately all non-v1 fields will be deprecated.

-

serving.knative.dev/v1beta1

-

-

-Resource Types: - -

Configuration -

-

-

Configuration represents the “floating HEAD” of a linear history of Revisions. -Users create new Revisions by updating the Configuration’s spec. -The “latest created” revision’s name is available under status, as is the -“latest ready” revision’s name. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1beta1 - -
-kind
-string -		Configuration
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ConfigurationSpec - - -		 -(Optional) -
-
- - - - - -
-template
- - -RevisionTemplateSpec - - -		 -(Optional) -

Template holds the latest specification for the Revision to be stamped out.

-
-
-status
- - -ConfigurationStatus - - -		 -(Optional) -
-

Revision -

-

-

Revision is an immutable snapshot of code and configuration. A revision -references a container image. Revisions are created by updates to a -Configuration.

-

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1beta1 - -
-kind
-string -		Revision
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -RevisionSpec - - -		 -(Optional) -
-
- - - - - - - - - - - - - -
-PodSpec
- - -Kubernetes core/v1.PodSpec - - -		 -

-(Members of PodSpec are embedded into this type.) -

-
-containerConcurrency
- -int64 - -		 -(Optional) -

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) -requests per container of the Revision. Defaults to 0 which means -concurrency to the application is not limited, and the system decides the -target concurrency for the autoscaler.

-
-timeoutSeconds
- -int64 - -		 -(Optional) -

TimeoutSeconds holds the max duration the instance is allowed for -responding to a request. If unspecified, a system default will -be provided.

-
-
-status
- - -RevisionStatus - - -		 -(Optional) -
-

Route -

-

-

Route is responsible for configuring ingress over a collection of Revisions. -Some of the Revisions a Route distributes traffic over may be specified by -referencing the Configuration responsible for creating them; in these cases -the Route is additionally responsible for monitoring the Configuration for -“latest ready revision” changes, and smoothly rolling out latest revisions. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1beta1 - -
-kind
-string -		Route
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -RouteSpec - - -		 -(Optional) -

Spec holds the desired state of the Route (from the client).

-
-
- - - - - -
-traffic
- - -[]TrafficTarget - - -		 -(Optional) -

Traffic specifies how to distribute traffic over a collection of -revisions and configurations.

-
-
-status
- - -RouteStatus - - -		 -(Optional) -

Status communicates the observed state of the Route (from the controller).

-
-

Service -

-

-

Service acts as a top-level container that manages a Route and Configuration -which implement a network service. Service exists to provide a singular -abstraction which can be access controlled, reasoned about, and which -encapsulates software lifecycle decisions such as rollout policy and -team resource ownership. Service acts only as an orchestrator of the -underlying Routes and Configurations (much as a kubernetes Deployment -orchestrates ReplicaSets), and its usage is optional but recommended.

-

The Service’s controller will track the statuses of its owned Configuration -and Route, reflecting their statuses and conditions as its own.

-

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1beta1 - -
-kind
-string -		Service
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ServiceSpec - - -		 -(Optional) -
-
- - - - - - - - - -
-ConfigurationSpec
- - -ConfigurationSpec - - -		 -

-(Members of ConfigurationSpec are embedded into this type.) -

-

ServiceSpec inlines an unrestricted ConfigurationSpec.

-
-RouteSpec
- - -RouteSpec - - -		 -

-(Members of RouteSpec are embedded into this type.) -

-

ServiceSpec inlines RouteSpec and restricts/defaults its fields -via webhook. In particular, this spec can only reference this -Service’s configuration and revisions (which also influences -defaults).

-
-
-status
- - -ServiceStatus - - -		 -(Optional) -
-

Generated with gen-crd-api-reference-docs -on git commit d74ecbeb1. +on git commit 427b2bf86.

From a0dac206595d958974f189c1e1bb535ab4d75047 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 19 Aug 2020 17:03:10 -0700 Subject: [PATCH 2/9] Update docs/reference/serving.md Co-authored-by: Matt Moore --- docs/reference/serving.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/serving.md b/docs/reference/serving.md index b91396bdfd..6d80d8922d 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -954,7 +954,7 @@ RevisionTemplateSpec

(Appears on: -Configuration, +Configuration, Configuration)

From 24e5c038fda24d6be02647275fa6ac136926c4c5 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 19 Aug 2020 17:04:02 -0700 Subject: [PATCH 3/9] Update docs/reference/serving.md Co-authored-by: Matt Moore --- docs/reference/serving.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 6d80d8922d..5c1d01664c 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -920,7 +920,7 @@ ServiceStatus

(Appears on: Configuration, -Configuration, +Configuration, ServiceSpec)

From 9896a26087d1af829a3d1a60e76bf45c8368921f Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 19 Aug 2020 17:04:41 -0700 Subject: [PATCH 4/9] Update docs/reference/serving.md Co-authored-by: Matt Moore --- docs/reference/serving.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 5c1d01664c..ed5b9da2cf 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1090,7 +1090,7 @@ string

(Appears on: Revision, -Revision, +Revision, RevisionSpec, RevisionTemplateSpec)

From c85cdda56bbdf7f4dbd0f3f8b316de48281766f5 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 19 Aug 2020 17:05:31 -0700 Subject: [PATCH 5/9] Update docs/reference/serving.md Co-authored-by: Matt Moore --- docs/reference/serving.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/serving.md b/docs/reference/serving.md index ed5b9da2cf..aa977c883f 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1155,7 +1155,7 @@ be provided.

(Appears on: -Revision, +Revision, Revision)

From f3b9d80ebaa00943c5355dae1d7a6ffd3b7f348c Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 19 Aug 2020 17:06:12 -0700 Subject: [PATCH 6/9] Update docs/reference/serving.md Co-authored-by: Matt Moore --- docs/reference/serving.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/serving.md b/docs/reference/serving.md index aa977c883f..2febd77e5e 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1351,7 +1351,7 @@ be provided.

(Appears on: Route, -Route, +Route, ServiceSpec)

From 2da87bd18a792ead592fa3e41e7b5873c88002cc Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 19 Aug 2020 17:06:43 -0700 Subject: [PATCH 7/9] Update docs/reference/serving.md Co-authored-by: Matt Moore --- docs/reference/serving.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 2febd77e5e..dc765a759c 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1386,7 +1386,7 @@ revisions and configurations.

(Appears on: -Route, +Route, Route)

From 98629845d4e54f35671def2ee46fa23d5c293983 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 19 Aug 2020 17:07:06 -0700 Subject: [PATCH 8/9] Update docs/reference/serving.md Co-authored-by: Matt Moore --- docs/reference/serving.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/serving.md b/docs/reference/serving.md index dc765a759c..1cc7b55f73 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1503,7 +1503,7 @@ LatestReadyRevisionName that we last observed.

(Appears on: -Service, +Service, Service)

From bdf138b6debba905863221c5d366fb2640f828ca Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 19 Aug 2020 17:07:23 -0700 Subject: [PATCH 9/9] Update docs/reference/serving.md Co-authored-by: Matt Moore --- docs/reference/serving.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 1cc7b55f73..e93953bf98 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1564,7 +1564,7 @@ defaults).

(Appears on: -Service, +Service, Service)