From b3522617a766eff8b91bad8161877fb9b37b184d Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Mon, 16 Nov 2020 15:17:38 -0800 Subject: [PATCH 1/9] remove eventing-contrib --- docs/reference/api/README.md | 4 - .../api/eventing/eventing-contrib-api.md | 10 - .../api/eventing/eventing-contrib.md | 2046 ----------------- hack/gen-api-reference-docs.sh | 20 +- 4 files changed, 10 insertions(+), 2070 deletions(-) delete mode 100644 docs/reference/api/eventing/eventing-contrib-api.md delete mode 100644 docs/reference/api/eventing/eventing-contrib.md diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index eea887d18c..aed60b7248 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -9,7 +9,6 @@ The API source files are located at: - [Serving API](./serving.md) - [Eventing API](./eventing/eventing.md) -- [Eventing-contrib resources API](./eventing/eventing-contrib.md) ## Updating API Reference docs (for Knative maintainers) @@ -57,7 +56,6 @@ To generate a version of the API: - [Serving](https://github.com/knative/serving/releases/) - [Eventing](https://github.com/knative/eventing/releases/) - - [Eventing-contrib resources](https://github.com/knative/eventing-contrib/releases/) 1. To run the `gen-api-reference-docs.sh` command from the `hack` directory, you specify the commits or tags for each of the corresponding Knative component @@ -68,7 +66,6 @@ To generate a version of the API: KNATIVE_SERVING_COMMIT=[commit_or_tag] \ KNATIVE_EVENTING_COMMIT=[commit_or_tag] \ - KNATIVE_EVENTING_CONTRIB_COMMIT=[commit_or_tag] \ ./gen-api-reference-docs.sh ``` @@ -107,6 +104,5 @@ v0.18.0 API source files: ``` KNATIVE_SERVING_COMMIT=v0.18.0 \ KNATIVE_EVENTING_COMMIT=v0.18.0 \ -KNATIVE_EVENTING_CONTRIB_COMMIT=v0.18.0 \ ./gen-api-reference-docs.sh ``` diff --git a/docs/reference/api/eventing/eventing-contrib-api.md b/docs/reference/api/eventing/eventing-contrib-api.md deleted file mode 100644 index a2b959d03a..0000000000 --- a/docs/reference/api/eventing/eventing-contrib-api.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Eventing-contrib Resources" -linkTitle: "Eventing-contrib API" -weight: 50 -type: "docs" -aliases: - - /docs/reference/eventing/eventing-contrib-api ---- - -{{< readfile file="eventing-contrib.md" >}} diff --git a/docs/reference/api/eventing/eventing-contrib.md b/docs/reference/api/eventing/eventing-contrib.md deleted file mode 100644 index 9c483372d3..0000000000 --- a/docs/reference/api/eventing/eventing-contrib.md +++ /dev/null @@ -1,2046 +0,0 @@ -

Packages:

- -

sources.knative.dev/v1beta1

-

-

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

-

-Resource Types: - -

KafkaLimitsSpec -

-

-(Appears on: -KafkaResourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-cpu
- -string - -
-
-memory
- -string - -
-
-

KafkaRequestsSpec -

-

-(Appears on: -KafkaResourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-cpu
- -string - -
-
-memory
- -string - -
-
-

KafkaResourceSpec -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-requests
- - -KafkaRequestsSpec - - -
-
-limits
- - -KafkaLimitsSpec - - -
-
-

KafkaSource -

-

-

KafkaSource is the Schema for the kafkasources API.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -KafkaSourceSpec - - -
-
-
- - - - - - - - - - - - - - - - - -
-KafkaAuthSpec
- - -KafkaAuthSpec - - -
-

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

-
-topics
- -[]string - -
-

Topic topics to consume messages from

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

ConsumerGroupID is the consumer group ID.

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

-(Members of 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.

-
-
-status
- - -KafkaSourceStatus - - -
-
-

KafkaSourceSpec -

-

-(Appears on: -KafkaSource) -

-

-

KafkaSourceSpec defines the desired state of the KafkaSource.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-KafkaAuthSpec
- - -KafkaAuthSpec - - -
-

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

-
-topics
- -[]string - -
-

Topic topics to consume messages from

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

ConsumerGroupID is the consumer group ID.

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

-(Members of 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.

-
-

KafkaSourceStatus -

-

-(Appears on: -KafkaSource) -

-

-

KafkaSourceStatus defines the observed state of KafkaSource.

-

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

-
-
-

messaging.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

KafkaChannel -

-

-

KafkaChannel is a resource representing a Kafka Channel.

-

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

Spec defines the desired state of the Channel.

-
-
- - - - - - - - - - - - - -
-numPartitions
- -int32 - -
-

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

-
-replicationFactor
- -int16 - -
-

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

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

KafkaChannel conforms to Duck type Subscribable.

-
-
-status
- - -KafkaChannelStatus - - -
-(Optional) -

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

-
-

KafkaChannelSpec -

-

-(Appears on: -KafkaChannel) -

-

-

KafkaChannelSpec defines the specification for a KafkaChannel.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-numPartitions
- -int32 - -
-

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

-
-replicationFactor
- -int16 - -
-

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

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

KafkaChannel conforms to Duck type Subscribable.

-
-

KafkaChannelStatus -

-

-(Appears on: -KafkaChannel) -

-

-

KafkaChannelStatus represents the current state of a KafkaChannel.

-

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

-

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

-

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

-
-SubscribableTypeStatus
- -knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus - -
-

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

-

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

-
-
-

messaging.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

KafkaChannel -

-

-

KafkaChannel is a resource representing a Kafka Channel.

-

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

Spec defines the desired state of the Channel.

-
-
- - - - - - - - - - - - - -
-numPartitions
- -int32 - -
-

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

-
-replicationFactor
- -int16 - -
-

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

-
-ChannelableSpec
- -knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec - -
-

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

-

Channel conforms to Duck type Channelable.

-
-
-status
- - -KafkaChannelStatus - - -
-(Optional) -

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

-
-

KafkaChannelSpec -

-

-(Appears on: -KafkaChannel) -

-

-

KafkaChannelSpec defines the specification for a KafkaChannel.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-numPartitions
- -int32 - -
-

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

-
-replicationFactor
- -int16 - -
-

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

-
-ChannelableSpec
- -knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec - -
-

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

-

Channel conforms to Duck type Channelable.

-
-

KafkaChannelStatus -

-

-(Appears on: -KafkaChannel) -

-

-

KafkaChannelStatus represents the current state of a KafkaChannel.

-

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

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

-

Channel conforms to Duck type Channelable.

-
-
-

bindings.knative.dev/v1alpha1

-

-

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

-

-Resource Types: - -

KafkaAuthSpec -

-

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

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-bootstrapServers
- -[]string - -
-

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

-
-net
- - -KafkaNetSpec - - -
-
-

KafkaBinding -

-

-

KafkaBinding is the Schema for the kafkasources API.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -KafkaBindingSpec - - -
-
-
- - - - - - - - - -
-BindingSpec
- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -
-

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

-
-KafkaAuthSpec
- - -KafkaAuthSpec - - -
-

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

-
-
-status
- - -KafkaBindingStatus - - -
-
-

KafkaBindingSpec -

-

-(Appears on: -KafkaBinding) -

-

-

KafkaBindingSpec defines the desired state of the KafkaBinding.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-BindingSpec
- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -
-

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

-
-KafkaAuthSpec
- - -KafkaAuthSpec - - -
-

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

-
-

KafkaBindingStatus -

-

-(Appears on: -KafkaBinding) -

-

-

KafkaBindingStatus defines the observed state of KafkaBinding.

-

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

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

-
-

KafkaNetSpec -

-

-(Appears on: -KafkaAuthSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-sasl
- - -KafkaSASLSpec - - -
-
-tls
- - -KafkaTLSSpec - - -
-
-

KafkaSASLSpec -

-

-(Appears on: -KafkaNetSpec) -

-

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-enable
- -bool - -
-
-user
- - -SecretValueFromSource - - -
-(Optional) -

User is the Kubernetes secret containing the SASL username.

-
-password
- - -SecretValueFromSource - - -
-(Optional) -

Password is the Kubernetes secret containing the SASL password.

-
-

KafkaTLSSpec -

-

-(Appears on: -KafkaNetSpec) -

-

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-enable
- -bool - -
-
-cert
- - -SecretValueFromSource - - -
-(Optional) -

Cert is the Kubernetes secret containing the client certificate.

-
-key
- - -SecretValueFromSource - - -
-(Optional) -

Key is the Kubernetes secret containing the client key.

-
-caCert
- - -SecretValueFromSource - - -
-(Optional) -

CACert is the Kubernetes secret containing the server CA cert.

-
-

SecretValueFromSource -

-

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

-

-

SecretValueFromSource represents the source of a secret value

-

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

The Secret key to select from.

-
-
-

bindings.knative.dev/v1beta1

-

-

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

-

-Resource Types: - -

KafkaAuthSpec -

-

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

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-bootstrapServers
- -[]string - -
-

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

-
-net
- - -KafkaNetSpec - - -
-
-

KafkaBinding -

-

-

KafkaBinding is the Schema for the kafkasources API.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -KafkaBindingSpec - - -
-
-
- - - - - - - - - -
-BindingSpec
- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -
-

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

-
-KafkaAuthSpec
- - -KafkaAuthSpec - - -
-

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

-
-
-status
- - -KafkaBindingStatus - - -
-
-

KafkaBindingSpec -

-

-(Appears on: -KafkaBinding) -

-

-

KafkaBindingSpec defines the desired state of the KafkaBinding.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-BindingSpec
- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -
-

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

-
-KafkaAuthSpec
- - -KafkaAuthSpec - - -
-

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

-
-

KafkaBindingStatus -

-

-(Appears on: -KafkaBinding) -

-

-

KafkaBindingStatus defines the observed state of KafkaBinding.

-

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

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

-
-

KafkaNetSpec -

-

-(Appears on: -KafkaAuthSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-sasl
- - -KafkaSASLSpec - - -
-
-tls
- - -KafkaTLSSpec - - -
-
-

KafkaSASLSpec -

-

-(Appears on: -KafkaNetSpec) -

-

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-enable
- -bool - -
-
-user
- - -SecretValueFromSource - - -
-(Optional) -

User is the Kubernetes secret containing the SASL username.

-
-password
- - -SecretValueFromSource - - -
-(Optional) -

Password is the Kubernetes secret containing the SASL password.

-
-

KafkaTLSSpec -

-

-(Appears on: -KafkaNetSpec) -

-

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-enable
- -bool - -
-
-cert
- - -SecretValueFromSource - - -
-(Optional) -

Cert is the Kubernetes secret containing the client certificate.

-
-key
- - -SecretValueFromSource - - -
-(Optional) -

Key is the Kubernetes secret containing the client key.

-
-caCert
- - -SecretValueFromSource - - -
-(Optional) -

CACert is the Kubernetes secret containing the server CA cert.

-
-

SecretValueFromSource -

-

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

-

-

SecretValueFromSource represents the source of a secret value

-

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

The Secret key to select from.

-
-
-

sources.knative.dev/v1alpha1

-

-

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

-

-Resource Types: - -

KafkaLimitsSpec -

-

-(Appears on: -KafkaResourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-cpu
- -string - -
-
-memory
- -string - -
-
-

KafkaRequestsSpec -

-

-(Appears on: -KafkaResourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-cpu
- -string - -
-
-memory
- -string - -
-
-

KafkaResourceSpec -

-

-(Appears on: -KafkaSourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-requests
- - -KafkaRequestsSpec - - -
-
-limits
- - -KafkaLimitsSpec - - -
-
-

KafkaSource -

-

-

KafkaSource is the Schema for the kafkasources API.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -KafkaSourceSpec - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-KafkaAuthSpec
- - -KafkaAuthSpec - - -
-

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

-
-topics
- -[]string - -
-

Topic topics to consume messages from

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

ConsumerGroupID is the consumer group ID.

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

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

-
-serviceAccountName
- -string - -
-

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

-
-resources
- - -KafkaResourceSpec - - -
-

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

-
-
-status
- - -KafkaSourceStatus - - -
-
-

KafkaSourceSpec -

-

-(Appears on: -KafkaSource) -

-

-

KafkaSourceSpec defines the desired state of the KafkaSource.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-KafkaAuthSpec
- - -KafkaAuthSpec - - -
-

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

-
-topics
- -[]string - -
-

Topic topics to consume messages from

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

ConsumerGroupID is the consumer group ID.

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

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

-
-serviceAccountName
- -string - -
-

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

-
-resources
- - -KafkaResourceSpec - - -
-

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

-
-

KafkaSourceStatus -

-

-(Appears on: -KafkaSource) -

-

-

KafkaSourceStatus defines the observed state of KafkaSource.

-

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

-
-
-

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

diff --git a/hack/gen-api-reference-docs.sh b/hack/gen-api-reference-docs.sh index 8b78c07ffe..6f368d32e5 100755 --- a/hack/gen-api-reference-docs.sh +++ b/hack/gen-api-reference-docs.sh @@ -35,10 +35,10 @@ KNATIVE_EVENTING_IMPORT_PATH="knative.dev/eventing" KNATIVE_EVENTING_COMMIT="${KNATIVE_EVENTING_COMMIT:?specify the \$KNATIVE_EVENTING_COMMIT variable}" KNATIVE_EVENTING_OUT_FILE="eventing/eventing.md" -KNATIVE_EVENTING_CONTRIB_REPO="github.com/knative/eventing-contrib" -KNATIVE_EVENTING_CONTRIB_IMPORT_PATH="knative.dev/eventing-contrib" -KNATIVE_EVENTING_CONTRIB_COMMIT="${KNATIVE_EVENTING_CONTRIB_COMMIT:?specify the \$KNATIVE_EVENTING_CONTRIB_COMMIT variable}" -KNATIVE_EVENTING_CONTRIB_OUT_FILE="eventing/eventing-contrib.md" +# KNATIVE_EVENTING_CONTRIB_REPO="github.com/knative/eventing-contrib" +# KNATIVE_EVENTING_CONTRIB_IMPORT_PATH="knative.dev/eventing-contrib" +# KNATIVE_EVENTING_CONTRIB_COMMIT="${KNATIVE_EVENTING_CONTRIB_COMMIT:?specify the \$KNATIVE_EVENTING_CONTRIB_COMMIT variable}" +# KNATIVE_EVENTING_CONTRIB_OUT_FILE="eventing/eventing-contrib.md" cleanup_refdocs_root= cleanup_repo_clone_root= @@ -166,12 +166,12 @@ main() { gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ "${out_dir}/${KNATIVE_EVENTING_OUT_FILE}" "${knative_eventing_root}" "./pkg/apis" - local knative_eventing_contrib_root - knative_eventing_contrib_root="${clone_root}/src/${KNATIVE_EVENTING_CONTRIB_IMPORT_PATH}" - clone_at_commit "https://${KNATIVE_EVENTING_CONTRIB_REPO}.git" "${KNATIVE_EVENTING_CONTRIB_COMMIT}" \ - "${knative_eventing_contrib_root}" - gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ - "${out_dir}/${KNATIVE_EVENTING_CONTRIB_OUT_FILE}" "${knative_eventing_contrib_root}" "." + # local knative_eventing_contrib_root + # knative_eventing_contrib_root="${clone_root}/src/${KNATIVE_EVENTING_CONTRIB_IMPORT_PATH}" + # clone_at_commit "https://${KNATIVE_EVENTING_CONTRIB_REPO}.git" "${KNATIVE_EVENTING_CONTRIB_COMMIT}" \ + # "${knative_eventing_contrib_root}" + # gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ + # "${out_dir}/${KNATIVE_EVENTING_CONTRIB_OUT_FILE}" "${knative_eventing_contrib_root}" "." log "SUCCESS: Generated docs written to ${out_dir}/." log "Opening the ${out_dir}/ directory. You can now copy these API files" From a7210656317d8ab8f3f0264b7ff40d2c7f133980 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Mon, 16 Nov 2020 16:31:21 -0800 Subject: [PATCH 2/9] update gen-crd-api-reference-docs version to fix API build errors --- hack/gen-api-reference-docs.sh | 2 +- hack/reference-docs-gen-config.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/hack/gen-api-reference-docs.sh b/hack/gen-api-reference-docs.sh index 6f368d32e5..372ea6100f 100755 --- a/hack/gen-api-reference-docs.sh +++ b/hack/gen-api-reference-docs.sh @@ -23,7 +23,7 @@ SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" REFDOCS_PKG="github.com/ahmetb/gen-crd-api-reference-docs" REFDOCS_REPO="https://${REFDOCS_PKG}.git" -REFDOCS_VER="v0.1.5" +REFDOCS_VER="v0.2.0" KNATIVE_SERVING_REPO="github.com/knative/serving" KNATIVE_SERVING_IMPORT_PATH="knative.dev/serving" diff --git a/hack/reference-docs-gen-config.json b/hack/reference-docs-gen-config.json index dcd5eb9de9..b4df81a3c1 100644 --- a/hack/reference-docs-gen-config.json +++ b/hack/reference-docs-gen-config.json @@ -13,7 +13,7 @@ }, { "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", - "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" + "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" }, { "typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/", From d7564d0d6380fe003c8262b9f14f854b1713580b Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Mon, 16 Nov 2020 16:32:11 -0800 Subject: [PATCH 3/9] API docs build for 0.19 --- docs/reference/api/eventing/_index.md | 10 - docs/reference/api/eventing/eventing.md | 7119 +++++++++++++---------- docs/reference/api/serving.md | 918 ++- 3 files changed, 4869 insertions(+), 3178 deletions(-) delete mode 100644 docs/reference/api/eventing/_index.md diff --git a/docs/reference/api/eventing/_index.md b/docs/reference/api/eventing/_index.md deleted file mode 100644 index e1add05a56..0000000000 --- a/docs/reference/api/eventing/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Knative Eventing Component" -linkTitle: "Eventing API" -weight: 20 -type: "docs" -aliases: - - /docs/reference/eventing/eventing ---- - -{{< readfile file="eventing.md" >}} diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index 7447acb085..a17dee5c0a 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -1,61 +1,64 @@

Packages:

-

duck.knative.dev/v1

+

duck.knative.dev/v1beta1

-

Package v1 is the v1 version of the API.

+

Package v1beta1 is the v1beta1 version of the API.

Resource Types:
    -

    BackoffPolicyType +

    BackoffPolicyType (string alias)

    (Appears on: -DeliverySpec) +DeliverySpec)

    BackoffPolicyType is the type for backoff policies

    -

    Channelable +

    Channelable

    Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers @@ -74,7 +77,7 @@ Channelable ObjectReferences and access their subscription and address data. Th metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -88,7 +91,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
    - + ChannelableSpec @@ -102,7 +105,7 @@ ChannelableSpec SubscribableSpec
    - + SubscribableSpec @@ -117,7 +120,7 @@ SubscribableSpec delivery
    - + DeliverySpec @@ -134,7 +137,7 @@ DeliverySpec status
    - + ChannelableStatus @@ -144,13 +147,13 @@ ChannelableStatus -

    ChannelableSpec +

    ChannelableSpec

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

    ChannelableSpec contains Spec of the Channelable object

    @@ -167,7 +170,7 @@ ChannelableStatus SubscribableSpec
    - + SubscribableSpec @@ -182,7 +185,7 @@ SubscribableSpec delivery
    - + DeliverySpec @@ -194,13 +197,13 @@ DeliverySpec -

    ChannelableStatus +

    ChannelableStatus

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

    ChannelableStatus contains the Status of a Channelable object.

    @@ -247,7 +250,7 @@ knative.dev/pkg/apis/duck/v1.AddressStatus SubscribableStatus
    - + SubscribableStatus @@ -274,16 +277,19 @@ Failed messages are delivered here.

    -

    DeliverySpec +

    DeliverySpec

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

    DeliverySpec contains the delivery options for event senders, @@ -327,7 +333,7 @@ sending an event before moving it to the dead letter sink.

    backoffPolicy
    - + BackoffPolicyType @@ -350,13 +356,13 @@ string 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^.

    +

    For linear policy, backoff delay is backoffDelay*. +For exponential policy, backoff delay is backoffDelay*2^.

    -

    DeliveryStatus +

    DeliveryStatus

    DeliveryStatus contains the Status of an object supporting delivery options.

    @@ -384,7 +390,7 @@ where failed events are sent to.

    -

    Subscribable +

    Subscribable

    Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers @@ -403,7 +409,7 @@ SubscribableType ObjectReferences and access the Subscription data. This is not metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -417,7 +423,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
    - + SubscribableSpec @@ -432,7 +438,7 @@ configured as to be compatible with Subscribable contract.

    subscribers
    - + []SubscriberSpec @@ -448,7 +454,7 @@ configured as to be compatible with Subscribable contract.

    status
    - + SubscribableStatus @@ -460,12 +466,13 @@ configured as to be compatible with Subscribable contract.

    -

    SubscribableSpec +

    SubscribableSpec

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

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

    @@ -482,7 +489,7 @@ configured as to be compatible with Subscribable contract.

    subscribers
    - + []SubscriberSpec @@ -493,12 +500,13 @@ configured as to be compatible with Subscribable contract.

    -

    SubscribableStatus +

    SubscribableStatus

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

    SubscribableStatus is the schema for the subscribable’s status portion of the status @@ -516,7 +524,7 @@ section of the resource.

    subscribers
    - + []SubscriberStatus @@ -527,11 +535,11 @@ section of the resource.

    -

    SubscriberSpec +

    SubscriberSpec

    (Appears on: -SubscribableSpec) +SubscribableSpec)

    SubscriberSpec defines a single subscriber to a Subscribable.

    @@ -597,7 +605,7 @@ knative.dev/pkg/apis.URL delivery
    - + DeliverySpec @@ -609,11 +617,12 @@ DeliverySpec -

    SubscriberStatus +

    SubscriberStatus

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

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

    @@ -654,7 +663,7 @@ int64 ready
    - + Kubernetes core/v1.ConditionStatus @@ -678,27 +687,24 @@ string
    -

    duck.knative.dev/v1beta1

    +

    eventing.knative.dev/v1

    -

    Package v1beta1 is the v1beta1 version of the API.

    +

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

      Broker

      -

      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.

      +

      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.

      @@ -710,14 +716,32 @@ Channelable ObjectReferences and access their subscription and address data. Th + + + + + + + + @@ -726,43 +750,43 @@ Refer to the Kubernetes API documentation for the fields of the
      +apiVersion
      +string
      + +eventing.knative.dev/v1 + +
      +kind
      +string +
      Broker
      metadata
      - + Kubernetes meta/v1.ObjectMeta
      +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
      - -ChannelableSpec + +BrokerSpec
      -

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

      +

      Spec defines the desired state of the Broker.



      -SubscribableSpec
      +config
      - -SubscribableSpec - +knative.dev/pkg/apis/duck/v1.KReference
      -

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

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

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

      @@ -772,26 +796,24 @@ DeliverySpec
      status
      - -ChannelableStatus + +BrokerStatus
      +(Optional) +

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

      -

      ChannelableSpec +

      Trigger

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

      -

      -

      ChannelableSpec contains Spec of the Channelable object

      +

      Trigger represents a request to have events delivered to a subscriber from a +Broker’s event pool.

      @@ -803,132 +825,115 @@ ChannelableStatus + + + + - -
      -SubscribableSpec
      - - -SubscribableSpec - - +apiVersion
      +string
      + +eventing.knative.dev/v1 +
      -

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

      +kind
      +string
      Trigger
      -delivery
      +metadata
      - -DeliverySpec + +Kubernetes meta/v1.ObjectMeta
      (Optional) -

      DeliverySpec contains options controlling the event delivery

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

      ChannelableStatus -

      -

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

      -

      -

      ChannelableStatus contains the Status of a Channelable object.

      -

      - - - - - - - - - +

      Spec defines the desired state of the Trigger.

      +
      +
      +
      FieldDescription
      -Status
      +spec
      -knative.dev/pkg/apis/duck/v1.Status + +TriggerSpec +
      -

      -(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
      +broker
      -knative.dev/pkg/apis/duck/v1.AddressStatus +string
      -

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

      -

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

      +

      Broker is the broker that this trigger receives events from.

      -SubscribableStatus
      +filter
      - -SubscribableStatus + +TriggerFilter
      -

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

      -

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

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

      -deadLetterChannel
      +subscriber
      -knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis/duck/v1.Destination + +
      +

      Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.

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

      +

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

      -

      DeliverySpec +

      BrokerSpec

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

      -

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

      @@ -940,67 +945,89 @@ such as channelable and source.

      + +
      -deadLetterSink
      +config
      -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.KReference
      (Optional) -

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

      +

      Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.

      -retry
      +delivery
      -int32 + +DeliverySpec +
      (Optional) -

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

      +

      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
      -backoffPolicy
      +Status
      - -BackoffPolicyType - +knative.dev/pkg/apis/duck/v1.Status
      -(Optional) -

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

      +

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

      -backoffDelay
      +address
      -string +knative.dev/pkg/apis/duck/v1.Addressable
      -(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^.

      +

      Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh.

      -

      DeliveryStatus +

      TriggerFilter

      -

      DeliveryStatus contains the Status of an object supporting delivery options.

      +(Appears on: +TriggerSpec) +

      +

      @@ -1012,25 +1039,42 @@ For exponential policy , backoff delay is backoffDelay*2^.

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

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

      +

      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

      -

      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.

      +(Appears on: +Trigger) +

      +

      @@ -1042,75 +1086,52 @@ SubscribableType ObjectReferences and access the Subscription data. This is not -
      -metadata
      +broker
      - -Kubernetes meta/v1.ObjectMeta - +string
      -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

      Broker is the broker that this trigger receives events from.

      -spec
      - - -SubscribableSpec - - -
      -

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

      -
      -
      - - - - -
      -subscribers
      +filter
      - -[]SubscriberSpec + +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.

      -status
      +subscriber
      - -SubscribableStatus - +knative.dev/pkg/apis/duck/v1.Destination
      -

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

      +

      Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.

      -

      SubscribableSpec +

      TriggerStatus

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

      -

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

      +

      TriggerStatus represents the current state of a Trigger.

      @@ -1122,63 +1143,45 @@ configured as to be compatible with Subscribable contract.

      - - -
      -subscribers
      +Status
      - -[]SubscriberSpec - +knative.dev/pkg/apis/duck/v1.Status
      -

      This is the list of subscriptions for this subscribable.

      -
      -

      SubscribableStatus -

      -

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

      -

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

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

      + - -
      FieldDescription
      -subscribers
      +subscriberUri
      - -[]SubscriberStatus - +knative.dev/pkg/apis.URL
      -

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

      +

      SubscriberURI is the resolved URI of the receiver for this Trigger.

      -

      SubscriberSpec -

      +
      +

      flows.knative.dev/v1beta1

      -(Appears on: -SubscribableSpec) +

      Package v1beta1 is the v1beta1 version of the API.

      +Resource Types: +
        +

        Parallel +

        -

        SubscriberSpec defines a single subscriber to a Subscribable.

        -

        At least one of SubscriberURI and ReplyURI must be present

        +

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

        @@ -1190,77 +1193,101 @@ section of the resource.

        -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 + +ParallelSpec +
        -(Optional) -

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

        +

        Spec defines the desired state of the Parallel.

        +
        +
        + + + + + +
        +branches
        + + +[]ParallelBranch + + +
        +

        Branches is the list of Filter/Subscribers pairs.

        -subscriberUri
        +channelTemplate
        -knative.dev/pkg/apis.URL + +ChannelTemplateSpec +
        (Optional) -

        SubscriberURI is the endpoint for the subscriber

        +

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

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

        ReplyURI is the endpoint for the reply

        +

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

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

        DeliverySpec contains options controlling the event delivery

        +

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

        -

        SubscriberStatus +

        ParallelBranch

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

        -

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

        @@ -1272,74 +1299,66 @@ DeliverySpec
        -uid
        +filter
        -k8s.io/apimachinery/pkg/types.UID +knative.dev/pkg/apis/duck/v1.Destination
        (Optional) -

        UID is used to understand the origin of the subscriber.

        +

        Filter is the expression guarding the branch

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

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

        +

        Subscriber receiving the event when the filter passes

        -ready
        +reply
        - -Kubernetes core/v1.ConditionStatus - +knative.dev/pkg/apis/duck/v1.Destination
        -

        Status of the subscriber.

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

        -message
        +delivery
        -string + +DeliverySpec +
        (Optional) -

        A human readable message indicating details of Ready status.

        +

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

        -
        -

        eventing.knative.dev/v1

        +

        ParallelBranchStatus +

        -

        Package v1 is the v1 version of the API.

        +(Appears on: +ParallelStatus)

        -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. Subscribers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.

        +

        ParallelBranchStatus represents the current state of a Parallel branch

        @@ -1351,104 +1370,95 @@ Addressable endpoint.

        - - - - + + +
        -apiVersion
        -string
        - -eventing.knative.dev/v1 - +filterSubscriptionStatus
        + + +ParallelSubscriptionStatus + +
        -kind
        -string +

        FilterSubscriptionStatus corresponds to the filter subscription status.

        Broker
        -metadata
        +filterChannelStatus
        - -Kubernetes meta/v1.ObjectMeta + +ParallelChannelStatus
        -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

        FilterChannelStatus corresponds to the filter channel status.

        -spec
        +subscriberSubscriptionStatus
        - -BrokerSpec + +ParallelSubscriptionStatus
        -

        Spec defines the desired state of the Broker.

        -
        -
        +

        SubscriptionStatus corresponds to the subscriber subscription status.

        +
        +

        ParallelChannelStatus +

        +

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

        +

        +

        + - - + + + + - -
        -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
        +channel
        - -DeliverySpec + +Kubernetes core/v1.ObjectReference
        -(Optional) -

        Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

        -
        +

        Channel is the reference to the underlying channel.

        -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 Channel is ready or not.

        -

        Trigger +

        ParallelSpec

        -

        Trigger represents a request to have events delivered to a subscriber from a -Broker’s event pool.

        +(Appears on: +Parallel) +

        +

        @@ -1460,113 +1470,130 @@ Broker’s event pool.

        - - - - - - - - + +
        -apiVersion
        -string
        - -eventing.knative.dev/v1 - -
        -kind
        -string -
        Trigger
        -metadata
        +branches
        - -Kubernetes meta/v1.ObjectMeta + +[]ParallelBranch
        -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

        Branches is the list of Filter/Subscribers pairs.

        -spec
        +channelTemplate
        - -TriggerSpec + +ChannelTemplateSpec
        -

        Spec defines the desired state of the Trigger.

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

        + + + +
        -broker
        +reply
        -string +knative.dev/pkg/apis/duck/v1.Destination
        -

        Broker is the broker that this trigger receives events from.

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

        +

        +(Appears on: +Parallel) +

        +

        +

        ParallelStatus represents the current state of a Parallel.

        +

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

        +

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

        -subscriber
        +ingressChannelStatus
        -knative.dev/pkg/apis/duck/v1.Destination + +ParallelChannelStatus +
        -

        Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.

        +

        IngressChannelStatus corresponds to the ingress channel status.

        +
        +branchStatuses
        + + +[]ParallelBranchStatus + + +
        +

        BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches 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 Parallel. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name}

        -

        BrokerSpec +

        ParallelSubscriptionStatus

        (Appears on: -Broker) +ParallelBranchStatus)

        @@ -1580,43 +1607,35 @@ date.

        -config
        +subscription
        -knative.dev/pkg/apis/duck/v1.KReference + +Kubernetes core/v1.ObjectReference + -(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.

        +

        Subscription is the reference to the underlying Subscription.

        -delivery
        +ready
        - -DeliverySpec - +knative.dev/pkg/apis.Condition -(Optional) -

        Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

        +

        ReadyCondition indicates whether the Subscription is ready or not.

        -

        BrokerStatus +

        Sequence

        -(Appears on: -Broker) -

        -

        -

        BrokerStatus represents the current state of a Broker.

        +

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

        @@ -1628,39 +1647,99 @@ This includes things like retries, DLQ, etc.

        + + + +
        -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 Broker 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.
        -address
        +spec
        -knative.dev/pkg/apis/duck/v1.Addressable + +SequenceSpec +
        -

        Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh.

        +

        Spec defines the desired state of the Sequence.

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

        +
        +
        +status
        + + +SequenceStatus + + +
        +(Optional) +

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

        -

        TriggerFilter +

        SequenceChannelStatus

        (Appears on: -TriggerSpec) +SequenceStatus)

        @@ -1674,40 +1753,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.

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

        ReadyCondition indicates whether the Channel is ready or not.

        -

        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 +

        SequenceSpec

        (Appears on: -Trigger) +Sequence)

        @@ -1721,52 +1795,55 @@ to indicate all strings match.

        -broker
        +steps
        -string + +[]SequenceStep + -

        Broker is the broker that this trigger receives events from.

        +

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

        -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 the last Subscriber gets sent to.

        -

        TriggerStatus +

        SequenceStatus

        (Appears on: -Trigger) +Sequence)

        -

        TriggerStatus represents the current state of a Trigger.

        +

        SequenceStatus represents the current state of a Sequence.

        @@ -1788,44 +1865,162 @@ 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
        +subscriptionStatuses
        -knative.dev/pkg/apis.URL + +[]SequenceSubscriptionStatus +
        -

        SubscriberURI is the resolved URI of the receiver for this Trigger.

        +

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

        +
        +channelStatuses
        + + +[]SequenceChannelStatus + + +
        +

        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}

        +
        +

        SequenceStep +

        +

        +(Appears on: +SequenceSpec) +

        +

        +

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

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

        +

        Subscriber receiving the step event

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

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

        +
        +

        SequenceSubscriptionStatus +

        +

        +(Appears on: +SequenceStatus) +

        +

        +

        + + + + + + + + + + + + + + +
        FieldDescription
        +subscription
        + + +Kubernetes core/v1.ObjectReference + + +
        +

        Subscription is the reference to the underlying Subscription.

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

        ReadyCondition indicates whether the Subscription is ready or not.


        -

        eventing.knative.dev/v1beta1

        +

        messaging.knative.dev/v1

        -

        Package v1beta1 is the v1beta1 version of the API.

        +

        Package v1 is the v1 version of the API.

        Resource Types: -

        Broker +

        Channel

        -

        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.

        +

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

        @@ -1841,7 +2036,7 @@ Addressable endpoint.

        string @@ -1850,13 +2045,13 @@ eventing.knative.dev/v1beta1 kind
        string - +
        -eventing.knative.dev/v1beta1 +messaging.knative.dev/v1
        BrokerChannel
        metadata
        - + Kubernetes meta/v1.ObjectMeta @@ -1871,43 +2066,44 @@ Refer to the Kubernetes API documentation for the fields of the
        spec
        - -BrokerSpec + +ChannelSpec
        -

        Spec defines the desired state of the Broker.

        +

        Spec defines the desired state of the Channel.



        -config
        +channelTemplate
        -knative.dev/pkg/apis/duck/v1.KReference + +ChannelTemplateSpec +
        -(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.

        +

        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.

        -delivery
        +ChannelableSpec
        - -DeliverySpec + +ChannelableSpec
        -(Optional) -

        Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

        +

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

        +

        Channel conforms to ChannelableSpec

        @@ -1917,23 +2113,23 @@ This includes things like retries, DLQ, etc.

        status
        - -BrokerStatus + +ChannelStatus
        (Optional) -

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

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

        -

        EventType +

        InMemoryChannel

        -

        EventType represents a type of event that can be consumed from a Broker.

        +

        InMemoryChannel is a resource representing an in memory channel

        @@ -1949,7 +2145,7 @@ date.

        string @@ -1958,13 +2154,13 @@ eventing.knative.dev/v1beta1 kind
        string - + - - - - - - - - - - - - -
        -eventing.knative.dev/v1beta1 +messaging.knative.dev/v1
        EventTypeInMemoryChannel
        metadata
        - + Kubernetes meta/v1.ObjectMeta @@ -1979,133 +2175,73 @@ Refer to the Kubernetes API documentation for the fields of the
        spec
        - -EventTypeSpec + +InMemoryChannelSpec
        -

        Spec defines the desired state of the EventType.

        +

        Spec defines the desired state of the Channel.



        - - -
        -type
        +ChannelableSpec
        -string + +ChannelableSpec +
        -

        Type represents the CloudEvents type. It is authoritative.

        +

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

        +

        Channel conforms to Duck type Channelable.

        -source
        - -knative.dev/pkg/apis.URL - -
        -(Optional) -

        Source is a URI, it represents the CloudEvents source.

        +
        -schema
        +status
        -knative.dev/pkg/apis.URL + +InMemoryChannelStatus +
        (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.

        +

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

        -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
        - -string - -
        -(Optional) -

        TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType.

        -
        -description
        - -string - -
        -(Optional) -

        Description is an optional field used to describe the EventType, in any meaningful way.

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

        - - - - -

        Trigger -

        -

        -

        Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.

        -

        - - - - - - - - + +
        FieldDescription
        +

        Subscription +

        +

        +

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

        +

        + + + + + + + + @@ -2114,19 +2250,18 @@ eventing.knative.dev/v1beta1 kind
        string - + @@ -2135,53 +2270,81 @@ Refer to the Kubernetes API documentation for the fields of the
        FieldDescription
        apiVersion
        string
        -eventing.knative.dev/v1beta1 +messaging.knative.dev/v1
        TriggerSubscription
        metadata
        - + Kubernetes meta/v1.ObjectMeta
        -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
        - -TriggerSpec + +SubscriptionSpec
        -

        Spec defines the desired state of the Trigger.



        + + + +
        -broker
        +channel
        -string + +Kubernetes core/v1.ObjectReference +
        -

        Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

        +

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

        -filter
        +subscriber
        - -TriggerFilter - +knative.dev/pkg/apis/duck/v1.Destination
        (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 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.

        -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 specifies (optionally) how to handle events returned from +the Subscriber target.

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

        Delivery configuration

        @@ -2191,26 +2354,31 @@ is required.

        status
        - -TriggerStatus + +SubscriptionStatus
        -(Optional) -

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

        -

        BrokerSpec +

        ChannelDefaulter +

        +

        +

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

        +

        +

        ChannelSpec

        (Appears on: -Broker) +Channel)

        +

        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.

        @@ -2222,43 +2390,44 @@ date.

        -config
        +channelTemplate
        -knative.dev/pkg/apis/duck/v1.KReference + +ChannelTemplateSpec +
        -(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.

        +

        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.

        -delivery
        +ChannelableSpec
        - -DeliverySpec + +ChannelableSpec
        -(Optional) -

        Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

        +

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

        +

        Channel conforms to ChannelableSpec

        -

        BrokerStatus +

        ChannelStatus

        (Appears on: -Broker) +Channel)

        -

        BrokerStatus represents the current state of a Broker.

        +

        ChannelStatus represents the current state of a Channel.

        @@ -2270,39 +2439,40 @@ This includes things like retries, DLQ, etc.

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

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

        +

        Channel conforms to ChannelableStatus

        -address
        +channel
        -knative.dev/pkg/apis/duck/v1.Addressable +knative.dev/pkg/apis/duck/v1.KReference
        -

        Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh.

        +

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

        -

        EventTypeSpec +

        ChannelTemplateSpec

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

        @@ -2316,89 +2486,81 @@ delivered into the Broker mesh.

        -type
        +spec
        -string +k8s.io/apimachinery/pkg/runtime.RawExtension -

        Type represents the CloudEvents type. It is authoritative.

        +(Optional) +

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

        +
        +
        + +
        + + +

        ChannelTemplateSpecInternal +

        +

        +

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

        +

        + + + + + + + + - - - - - - - - - - - -
        FieldDescription
        -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 +k8s.io/apimachinery/pkg/runtime.RawExtension
        (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
        - -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
        - -string - -
        -(Optional) -

        TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType.

        -
        -description
        - -string - -
        -(Optional) -

        Description is an optional field used to describe the EventType, in any meaningful way.

        +

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

        +
        +
        + +
        -

        EventTypeStatus +

        InMemoryChannelSpec

        (Appears on: -EventType) +InMemoryChannel)

        -

        EventTypeStatus represents the current state of a EventType.

        +

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

        @@ -2410,29 +2572,30 @@ string
        -Status
        +ChannelableSpec
        -knative.dev/pkg/apis/duck/v1.Status + +ChannelableSpec +

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

        +

        Channel conforms to Duck type Channelable.

        -

        TriggerFilter +

        InMemoryChannelStatus

        (Appears on: -TriggerSpec) +InMemoryChannel)

        +

        ChannelStatus represents the current state of a Channel.

        @@ -2444,42 +2607,41 @@ knative.dev/pkg/apis/duck/v1.Status
        -attributes
        +ChannelableStatus
        - -TriggerFilterAttributes + +ChannelableStatus
        -(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.

        +

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

        +

        Channel conforms to Duck type Channelable.

        -

        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 +

        SubscriptionSpec

        (Appears on: -Trigger) +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

        @@ -2491,53 +2653,82 @@ to indicate all strings match.

        + + + +
        -broker
        +channel
        -string + +Kubernetes core/v1.ObjectReference +
        -

        Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

        +

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

        -filter
        +subscriber
        - -TriggerFilter - +knative.dev/pkg/apis/duck/v1.Destination
        (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 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.

        -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 specifies (optionally) how to handle events returned from +the Subscriber target.

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

        Delivery configuration

        -

        TriggerStatus +

        SubscriptionStatus

        (Appears on: -Trigger) +Subscription)

        -

        TriggerStatus represents the current state of a Trigger.

        +

        SubscriptionStatus (computed) for a subscription

        @@ -2565,34 +2756,91 @@ knative.dev/pkg/apis/duck/v1.Status + + + +
        +physicalSubscription
        + + +SubscriptionStatusPhysicalSubscription + + +
        +

        PhysicalSubscription is the fully resolved values that this Subscription represents.

        +
        +

        SubscriptionStatusPhysicalSubscription +

        +

        +(Appears on: +SubscriptionStatus) +

        +

        +

        SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

        +

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

        SubscriberURI is the resolved URI of the receiver for this Trigger.

        +

        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.


        -

        messaging.knative.dev/v1

        +

        sources.knative.dev/v1alpha2

        -

        Package v1 is the v1 version of the API.

        +

        Package v1alpha2 contains API Schema definitions for the sources v1beta1 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

        @@ -2608,7 +2856,7 @@ Resource Types: string @@ -2617,19 +2865,18 @@ messaging.knative.dev/v1 kind
        string - + @@ -2638,44 +2885,90 @@ Refer to the Kubernetes API documentation for the fields of the
        -messaging.knative.dev/v1 +sources.knative.dev/v1alpha2
        ChannelApiServerSource
        metadata
        - + 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
        +SourceSpec
        - -ChannelTemplateSpec - +knative.dev/pkg/apis/duck/v1.SourceSpec
        -

        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.

        +

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

        -ChannelableSpec
        +resources
        - -ChannelableSpec + +[]APIVersionKindSelector
        -

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

        -

        Channel conforms to ChannelableSpec

        +

        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.

        @@ -2685,23 +2978,20 @@ ChannelableSpec
        status
        - -ChannelStatus + +ApiServerSourceStatus
        -(Optional) -

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

        -

        InMemoryChannel +

        ContainerSource

        -

        InMemoryChannel is a resource representing an in memory channel

        +

        ContainerSource is the Schema for the containersources API

        @@ -2717,7 +3007,7 @@ date.

        string @@ -2726,19 +3016,18 @@ messaging.knative.dev/v1 kind
        string - + @@ -2747,30 +3036,44 @@ Refer to the Kubernetes API documentation for the fields of the
        -messaging.knative.dev/v1 +sources.knative.dev/v1alpha2
        InMemoryChannelContainerSource
        metadata
        - + Kubernetes meta/v1.ObjectMeta
        -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
        - -InMemoryChannelSpec + +ContainerSourceSpec
        -

        Spec defines the desired state of the Channel.



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

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

        -

        Channel conforms to Duck type Channelable.

        +

        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

        @@ -2780,24 +3083,20 @@ ChannelableSpec
        status
        - -InMemoryChannelStatus + +ContainerSourceStatus
        -(Optional) -

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

        -

        Subscription +

        PingSource

        -

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

        +

        PingSource is the Schema for the PingSources API.

        @@ -2813,7 +3112,7 @@ corresponds to the subscriptions.channels.knative.dev CRD.

        string @@ -2822,13 +3121,13 @@ messaging.knative.dev/v1 kind
        string - + @@ -2853,70 +3152,46 @@ SubscriptionSpec
        -messaging.knative.dev/v1 +sources.knative.dev/v1alpha2
        SubscriptionPingSource
        metadata
        - + Kubernetes meta/v1.ObjectMeta @@ -2842,8 +3141,8 @@ Refer to the Kubernetes API documentation for the fields of the
        spec
        - -SubscriptionSpec + +PingSourceSpec
        - - - -
        -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
        +SourceSpec
        -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.SourceSpec
        -(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.

        +

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

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

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

        +

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

        -delivery
        +jsonData
        - -DeliverySpec - +string
        (Optional) -

        Delivery configuration

        +

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

        @@ -2926,8 +3201,8 @@ DeliverySpec status
        - -SubscriptionStatus + +PingSourceStatus @@ -2936,21 +3211,15 @@ SubscriptionStatus -

        ChannelDefaulter -

        -

        -

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

        -

        -

        ChannelSpec +

        SinkBinding

        -(Appears on: -Channel) -

        -

        -

        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.

        +

        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.

        @@ -2962,124 +3231,108 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba + + + + + + + + - - -
        -channelTemplate
        +apiVersion
        +string
        + +sources.knative.dev/v1alpha2 + +
        +kind
        +string +
        SinkBinding
        +metadata
        - -ChannelTemplateSpec + +Kubernetes meta/v1.ObjectMeta
        -

        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.

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

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

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

        -

        Channel conforms to ChannelableStatus

        +

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

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

        +

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

        -

        ChannelTemplateSpec -

        -

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

        -

        -

        - - - - - + - -
        FieldDescription
        -spec
        +status
        -k8s.io/apimachinery/pkg/runtime.RawExtension + +SinkBindingStatus +
        -(Optional) -

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

        -
        -
        - -
        -

        ChannelTemplateSpecInternal +

        APIVersionKind

        -

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

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

        +

        +

        APIVersionKind is an APIVersion and Kind tuple.

        @@ -3091,48 +3344,37 @@ we can easily create new Channels off of it.

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

        APIVersion - the API version of the resource to watch.

        -spec
        +kind
        -k8s.io/apimachinery/pkg/runtime.RawExtension +string
        -(Optional) -

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

        -
        -
        - -
        +

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

        -

        InMemoryChannelSpec +

        APIVersionKindSelector

        (Appears on: -InMemoryChannel) +ApiServerSourceSpec)

        -

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

        +

        APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

        @@ -3144,76 +3386,53 @@ arguments for a Channel.

        - -
        -ChannelableSpec
        +apiVersion
        - -ChannelableSpec - +string
        -

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

        -

        Channel conforms to Duck type Channelable.

        +

        APIVersion - the API version of the resource to watch.

        -

        InMemoryChannelStatus -

        -

        -(Appears on: -InMemoryChannel) -

        -

        -

        ChannelStatus represents the current state of a Channel.

        -

        - - - - + + - -
        FieldDescription +kind
        + +string + +
        +

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

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

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

        -

        Channel conforms to Duck type Channelable.

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

        -

        SubscriptionSpec +

        ApiServerSourceSpec

        (Appears on: -Subscription) +ApiServerSource)

        -

        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

        +

        ApiServerSourceSpec defines the desired state of ApiServerSource

        @@ -3225,82 +3444,91 @@ channel –> reply

        + + + +
        -channel
        +SourceSpec
        - -Kubernetes core/v1.ObjectReference +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
        -

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

        +

        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.

        -subscriber
        +owner
        -knative.dev/pkg/apis/duck/v1.Destination + +APIVersionKind +
        (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.

        +

        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.

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

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

        +

        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

        -delivery
        +serviceAccountName
        - -DeliverySpec - +string
        (Optional) -

        Delivery configuration

        +

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

        -

        SubscriptionStatus +

        ApiServerSourceStatus

        (Appears on: -Subscription) +ApiServerSource)

        -

        SubscriptionStatus (computed) for a subscription

        +

        ApiServerSourceStatus defines the observed state of ApiServerSource

        @@ -3312,44 +3540,34 @@ 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.

        +

        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.

        -

        SubscriptionStatusPhysicalSubscription +

        ContainerSourceSpec

        (Appears on: -SubscriptionStatus) +ContainerSource)

        -

        SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

        +

        ContainerSourceSpec defines the desired state of ContainerSource

        @@ -3361,54 +3579,84 @@ Subscription.

        + +
        -subscriberUri
        +SourceSpec
        -knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.SourceSpec
        -

        SubscriberURI is the fully resolved URI for spec.subscriber.

        +

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

        -replyUri
        +template
        -knative.dev/pkg/apis.URL + +Kubernetes core/v1.PodTemplateSpec +
        -

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

        +

        Template describes the pods that will be created

        +

        ContainerSourceStatus +

        +

        +(Appears on: +ContainerSource) +

        +

        +

        ContainerSourceStatus defines the observed state of ContainerSource

        +

        + + + + + + + +
        FieldDescription
        -deadLetterSinkUri
        +SourceStatus
        -knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.SourceStatus
        -

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

        +

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

        -
        -

        sources.knative.dev/v1alpha1

        +

        PingSourceSpec +

        -

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

        +(Appears on: +PingSource)

        -Resource Types: - -

        ApiServerSource -

        -

        ApiServerSource is the Schema for the apiserversources API

        +

        PingSourceSpec defines the desired state of the PingSource.

        @@ -3420,154 +3668,194 @@ Resource Types: - - - - - - - - - +

        SinkBindingStatus +

        +

        +(Appears on: +SinkBinding) +

        +

        +

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

        +

        +
        -apiVersion
        -string
        - -sources.knative.dev/v1alpha1 - -
        -kind
        -string -
        ApiServerSource
        -metadata
        +SourceSpec
        - -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis/duck/v1.SourceSpec
        -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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

        -spec
        - - -ApiServerSourceSpec - - -
        -
        -
        - - - + +
        -resources
        +schedule
        - -[]ApiServerResource - +string
        -

        Resources is the list of resources to watch

        +(Optional) +

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

        -serviceAccountName
        +jsonData
        string
        (Optional) -

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

        +

        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
        -sink
        +SourceStatus
        -knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.SourceStatus
        -(Optional) -

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

        +

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

        CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to 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.

        -owner
        +BindingSpec
        - -APIVersionKind - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
        -(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 - -
        -

        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.

        +

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

        -
        + + + + + +
        FieldDescription
        -status
        +SourceStatus
        - -ApiServerSourceStatus - +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.

        -

        SinkBinding +
        +

        configs.internal.knative.dev/v1alpha1

        +

        +

        Package v1alpha1 is the v1alpha1 version of the API.

        +

        +Resource Types: + +

        ConfigMapPropagation

        -

        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.

        +

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

        @@ -3583,7 +3871,7 @@ cloud events.

        string @@ -3592,18 +3880,19 @@ sources.knative.dev/v1alpha1 kind
        string - + @@ -3612,39 +3901,39 @@ Refer to the Kubernetes API documentation for the fields of the
        -sources.knative.dev/v1alpha1 +configs.internal.knative.dev/v1alpha1
        SinkBindingConfigMapPropagation
        metadata
        - + Kubernetes meta/v1.ObjectMeta
        +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
        - -SinkBindingSpec + +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.) -

        +

        OriginalNamespace is the namespace where the original configMaps are in

        -BindingSpec
        +selector
        -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +Kubernetes meta/v1.LabelSelector +
        -

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

        +(Optional) +

        Selector only selects original configMaps with corresponding labels

        @@ -3654,24 +3943,26 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
        status
        - -SinkBindingStatus + +ConfigMapPropagationStatus
        +(Optional) +

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

        -

        ApiServerResource +

        ConfigMapPropagationSpec

        (Appears on: -ApiServerSourceSpec) +ConfigMapPropagation)

        -

        ApiServerResource defines the resource to watch

        @@ -3683,80 +3974,88 @@ SinkBindingStatus - - - - + +
        -apiVersion
        - -string - -
        -

        API version of the resource to watch.

        -
        -kind
        +originalNamespace
        string
        -

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

        +

        OriginalNamespace is the namespace where the original configMaps are in

        -labelSelector
        +selector
        - + 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

        +(Optional) +

        Selector only selects original configMaps with corresponding labels

        +

        ConfigMapPropagationStatus +

        +

        +(Appears on: +ConfigMapPropagation) +

        +

        +

        ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

        +

        + + + + + + + +
        FieldDescription
        -controllerSelector
        +Status
        - -Kubernetes meta/v1.OwnerReference - +knative.dev/pkg/apis/duck/v1.Status
        -

        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.

        +

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

        -controller
        +copyConfigmaps
        -bool + +[]ConfigMapPropagationStatusCopyConfigMap +
        -

        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.

        +(Optional) +

        CopyConfigMaps is the status for each copied configmap.

        -

        ApiServerSourceSpec +

        ConfigMapPropagationStatusCopyConfigMap

        (Appears on: -ApiServerSource) +ConfigMapPropagationStatus)

        -

        ApiServerSourceSpec defines the desired state of ApiServerSource

        +

        ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

        @@ -3768,94 +4067,93 @@ v1alpha2, please use Spec.Owner as a GKV.

        -resources
        +name
        - -[]ApiServerResource - +string
        -

        Resources is the list of resources to watch

        +

        Name is copy configmap’s name

        -serviceAccountName
        +source
        string
        -(Optional) -

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

        +

        Source is “originalNamespace/originalConfigMapName”

        -sink
        +operation
        -knative.dev/pkg/apis/duck/v1beta1.Destination +string
        -(Optional) -

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

        +

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

        -ceOverrides
        +ready
        -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.

        +

        Ready represents the operation is ready or not

        -owner
        +reason
        - -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.

        +

        Reason indicates reasons if the operation is not ready

        -mode
        +resourceVersionFromSource
        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.

        +

        ResourceVersion is the resourceVersion of original configmap

        -

        ApiServerSourceStatus -

        +
        +

        eventing.knative.dev/v1beta1

        -(Appears on: -ApiServerSource) +

        Package v1beta1 is the v1beta1 version of the API.

        +Resource Types: + +

        Broker +

        -

        ApiServerSourceStatus defines the observed state of ApiServerSource

        +

        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.

        @@ -3867,122 +4165,103 @@ string +apiVersion
        +string - -
        -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.

        + +eventing.knative.dev/v1beta1 +
        -

        SinkBindingSpec -

        -

        -(Appears on: -SinkBinding) -

        -

        -

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

        -

        - - - - + + - - - -
        FieldDescription +kind
        +string +
        Broker
        -SourceSpec
        +metadata
        -knative.dev/pkg/apis/duck/v1.SourceSpec + +Kubernetes meta/v1.ObjectMeta +
        -

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

        +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
        -BindingSpec
        +spec
        -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +BrokerSpec +
        -

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

        +

        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.

        -

        SinkBindingStatus -

        -

        -(Appears on: -SinkBinding) -

        -

        -

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

        -

        - - - - + + + +
        FieldDescription +delivery
        + + +DeliverySpec + + +
        +(Optional) +

        Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.

        +
        +
        -SourceStatus
        +status
        -knative.dev/pkg/apis/duck/v1.SourceStatus + +BrokerStatus +
        -

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

        +(Optional) +

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

        -
        -

        sources.knative.dev/v1beta1

        -

        -

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

        -

        -Resource Types: - -

        ApiServerSource +

        EventType

        -

        ApiServerSource is the Schema for the apiserversources API

        +

        EventType represents a type of event that can be consumed from a Broker.

        @@ -3998,7 +4277,7 @@ Resource Types: string @@ -4007,18 +4286,19 @@ sources.knative.dev/v1beta1 kind
        string - + @@ -4027,90 +4307,89 @@ Refer to the Kubernetes API documentation for the fields of the
        -sources.knative.dev/v1beta1 +eventing.knative.dev/v1beta1
        ApiServerSourceEventType
        metadata
        - + Kubernetes meta/v1.ObjectMeta
        +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
        - -ApiServerSourceSpec + +EventTypeSpec
        +

        Spec defines the desired state of the EventType.



        + + + +
        -SourceSpec
        +type
        -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.

        +

        Type represents the CloudEvents type. It is authoritative.

        -resources
        +source
        - -[]APIVersionKindSelector - +knative.dev/pkg/apis.URL
        -

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

        Source is a URI, it represents the CloudEvents source.

        -owner
        +schema
        - -APIVersionKind - +knative.dev/pkg/apis.URL
        (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.

        +

        Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.

        -mode
        +schemaData
        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

        +

        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.

        -serviceAccountName
        +broker
        string
        (Optional) -

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

        +

        TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

        +
        +description
        + +string + +
        +(Optional) +

        Description is an optional field used to describe the EventType, in any meaningful way.

        @@ -4120,20 +4399,528 @@ source. Defaults to default if not set.

        status
        - -ApiServerSourceStatus + +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

        -

        ContainerSource +

        Trigger +

        +

        +

        Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.

        +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        FieldDescription
        +apiVersion
        +string
        + +eventing.knative.dev/v1beta1 + +
        +kind
        +string +
        Trigger
        +metadata
        + + +Kubernetes meta/v1.ObjectMeta + + +
        +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
        +spec
        + + +TriggerSpec + + +
        +

        Spec defines the desired state of the Trigger.

        +
        +
        + + + + + + + + + + + + + +
        +broker
        + +string + +
        +

        Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

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

        +
        +
        +status
        + + +TriggerStatus + + +
        +(Optional) +

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

        +
        +

        BrokerSpec +

        +

        +(Appears on: +Broker) +

        +

        +

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

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

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

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

        +

        +(Appears on: +EventType) +

        +

        +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        FieldDescription
        +type
        + +string + +
        +

        Type represents the CloudEvents type. It is authoritative.

        +
        +source
        + +knative.dev/pkg/apis.URL + +
        +(Optional) +

        Source is a URI, it represents the CloudEvents source.

        +
        +schema
        + +knative.dev/pkg/apis.URL + +
        +(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
        + +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
        + +string + +
        +(Optional) +

        TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

        +
        +description
        + +string + +
        +(Optional) +

        Description is an optional field used to describe the EventType, in any meaningful way.

        +
        +

        EventTypeStatus +

        +

        +(Appears on: +EventType) +

        +

        +

        EventTypeStatus represents the current state of a EventType.

        +

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

        +
        +

        TriggerFilter +

        +

        +(Appears on: +TriggerSpec) +

        +

        +

        + + + + + + + + + + + + + +
        FieldDescription
        +attributes
        + + +TriggerFilterAttributes + + +
        +(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.

        +
        +

        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
        +broker
        + +string + +
        +

        Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

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

        +
        +

        TriggerStatus +

        +

        +(Appears on: +Trigger) +

        +

        +

        TriggerStatus represents the current state of a Trigger.

        +

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

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

        SubscriberURI is the resolved URI of the receiver for this Trigger.

        +
        +
        +

        sources.knative.dev/v1

        +

        +

        Package v1 contains API Schema definitions for the sources v1 API group.

        +

        +Resource Types: + +

        ApiServerSource

        -

        ContainerSource is the Schema for the containersources API

        +

        ApiServerSource is the Schema for the apiserversources API

        @@ -4149,7 +4936,7 @@ ApiServerSourceStatus string @@ -4158,13 +4945,13 @@ sources.knative.dev/v1beta1 kind
        string - + @@ -4207,15 +4994,61 @@ and modifications of the event sent to the sink.

        + + + + + + + + + + + +
        -sources.knative.dev/v1beta1 +sources.knative.dev/v1
        ContainerSourceApiServerSource
        metadata
        - + Kubernetes meta/v1.ObjectMeta @@ -4178,8 +4965,8 @@ Refer to the Kubernetes API documentation for the fields of the
        spec
        - -ContainerSourceSpec + +ApiServerSourceSpec
        -template
        +resources
        - -Kubernetes core/v1.PodTemplateSpec + +[]APIVersionKindSelector
        -

        Template describes the pods that will be created

        +

        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.

        @@ -4225,8 +5058,8 @@ Kubernetes core/v1.PodTemplateSpec status
        - -ContainerSourceStatus + +ApiServerSourceStatus @@ -4235,10 +5068,10 @@ ContainerSourceStatus -

        PingSource +

        ContainerSource

        -

        PingSource is the Schema for the PingSources API.

        +

        ContainerSource is the Schema for the containersources API

        @@ -4254,7 +5087,7 @@ ContainerSourceStatus string @@ -4263,13 +5096,13 @@ sources.knative.dev/v1beta1 kind
        string - + @@ -4312,42 +5145,15 @@ and modifications of the event sent to the sink.

        - - - - - - - -
        -sources.knative.dev/v1beta1 +sources.knative.dev/v1
        PingSourceContainerSource
        metadata
        - + Kubernetes meta/v1.ObjectMeta @@ -4283,8 +5116,8 @@ Refer to the Kubernetes API documentation for the fields of the
        spec
        - -PingSourceSpec + +ContainerSourceSpec
        -schedule
        - -string - -
        -(Optional) -

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

        -
        -timezone
        - -string - -
        -

        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

        -
        -jsonData
        +template
        -string + +Kubernetes core/v1.PodTemplateSpec +
        -(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”.

        +

        Template describes the pods that will be created

        @@ -4357,8 +5163,8 @@ to “application/json”.

        status
        - -PingSourceStatus + +ContainerSourceStatus @@ -4367,7 +5173,7 @@ PingSourceStatus -

        SinkBinding +

        SinkBinding

        SinkBinding describes a Binding that is also a Source. @@ -4391,7 +5197,7 @@ cloud events.

        string -sources.knative.dev/v1beta1 +sources.knative.dev/v1 @@ -4406,7 +5212,7 @@ string metadata
        - + Kubernetes meta/v1.ObjectMeta @@ -4420,7 +5226,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
        - + SinkBindingSpec @@ -4451,14 +5257,14 @@ and modifications of the event sent to the sink.

        BindingSpec
        -knative.dev/pkg/apis/duck/v1beta1.BindingSpec +knative.dev/pkg/apis/duck/v1.BindingSpec

        (Members of BindingSpec are embedded into this type.)

        -

        inherits duck/v1beta1 BindingSpec, which currently provides: +

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

        @@ -4470,7 +5276,7 @@ should be augmented by Binding implementations.

        status
        - + SinkBindingStatus @@ -4480,11 +5286,11 @@ SinkBindingStatus -

        APIVersionKind +

        APIVersionKind

        (Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)

        APIVersionKind is an APIVersion and Kind tuple.

        @@ -4522,11 +5328,11 @@ More info: APIVersionKindSelector +

        APIVersionKindSelector

        (Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)

        APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

        @@ -4566,7 +5372,7 @@ More info: + Kubernetes meta/v1.LabelSelector @@ -4580,11 +5386,11 @@ More info: ApiServerSourceSpec +

        ApiServerSourceSpec

        (Appears on: -ApiServerSource) +ApiServerSource)

        ApiServerSourceSpec defines the desired state of ApiServerSource

        @@ -4619,7 +5425,7 @@ and modifications of the event sent to the sink.

        resources
        - + []APIVersionKindSelector @@ -4634,7 +5440,7 @@ selector to help filter.

        owner
        - + APIVersionKind @@ -4676,11 +5482,11 @@ source. Defaults to default if not set.

        -

        ApiServerSourceStatus +

        ApiServerSourceStatus

        (Appears on: -ApiServerSource) +ApiServerSource)

        ApiServerSourceStatus defines the observed state of ApiServerSource

        @@ -4715,11 +5521,11 @@ Source.

        -

        ContainerSourceSpec +

        ContainerSourceSpec

        (Appears on: -ContainerSource) +ContainerSource)

        ContainerSourceSpec defines the desired state of ContainerSource

        @@ -4754,7 +5560,7 @@ and modifications of the event sent to the sink.

        template
        - + Kubernetes core/v1.PodTemplateSpec @@ -4765,11 +5571,11 @@ Kubernetes core/v1.PodTemplateSpec -

        ContainerSourceStatus +

        ContainerSourceStatus

        (Appears on: -ContainerSource) +ContainerSource)

        ContainerSourceStatus defines the observed state of ContainerSource

        @@ -4804,127 +5610,11 @@ 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 * * * * *.

        -
        -timezone
        - -string - -
        -

        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

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

        SinkBindingSpec

        (Appears on: -SinkBinding) +SinkBinding)

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

        @@ -4959,25 +5649,25 @@ and modifications of the event sent to the sink.

        BindingSpec
        -knative.dev/pkg/apis/duck/v1beta1.BindingSpec +knative.dev/pkg/apis/duck/v1.BindingSpec

        (Members of BindingSpec are embedded into this type.)

        -

        inherits duck/v1beta1 BindingSpec, which currently provides: +

        inherits duck/v1 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).

        @@ -5013,18 +5703,17 @@ Source.


        -

        configs.internal.knative.dev/v1alpha1

        +

        flows.knative.dev/v1

        -

        Package v1alpha1 is the v1alpha1 version of the API.

        +

        Package v1 is the v1 version of the API.

        Resource Types: - -

        ConfigMapPropagation +
          +

          Parallel

          -

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

          +

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

          @@ -5036,26 +5725,9 @@ Resource Types: - - - - - - - -
          -apiVersion
          -string
          - -configs.internal.knative.dev/v1alpha1 - -
          -kind
          -string -
          ConfigMapPropagation
          metadata
          - + Kubernetes meta/v1.ObjectMeta @@ -5070,39 +5742,55 @@ Refer to the Kubernetes API documentation for the fields of the
          spec
          - -ConfigMapPropagationSpec + +ParallelSpec
          -

          Spec defines the desired state of the ConfigMapPropagation

          +

          Spec defines the desired state of the Parallel.



          + + + +
          -originalNamespace
          +branches
          -string + +[]ParallelBranch +
          -

          OriginalNamespace is the namespace where the original configMaps are in

          +

          Branches is the list of Filter/Subscribers pairs.

          -selector
          +channelTemplate
          - -Kubernetes meta/v1.LabelSelector + +ChannelTemplateSpec
          (Optional) -

          Selector only selects original configMaps with corresponding labels

          +

          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 a case Subscriber gets sent to +when the case does not have a Reply

          @@ -5112,24 +5800,24 @@ Kubernetes meta/v1.LabelSelector
          status
          - -ConfigMapPropagationStatus + +ParallelStatus
          (Optional) -

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

          +

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

          -

          ConfigMapPropagationSpec +

          ParallelBranch

          (Appears on: -ConfigMapPropagation) +ParallelSpec)

          @@ -5143,39 +5831,65 @@ This data may be out of date.

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

          OriginalNamespace is the namespace where the original configMaps are in

          +(Optional) +

          Filter is the expression guarding the branch

          -selector
          +subscriber
          - -Kubernetes meta/v1.LabelSelector +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) -

          Selector only selects original configMaps with corresponding labels

          +

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

          -

          ConfigMapPropagationStatus +

          ParallelBranchStatus

          (Appears on: -ConfigMapPropagation) +ParallelStatus)

          -

          ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

          +

          ParallelBranchStatus represents the current state of a Parallel branch

          @@ -5187,44 +5901,53 @@ Kubernetes meta/v1.LabelSelector + + + +
          -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 Service 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.

          -copyConfigmaps
          +filterChannelStatus
          - -[]ConfigMapPropagationStatusCopyConfigMap + +ParallelChannelStatus
          -(Optional) -

          CopyConfigMaps is the status for each copied configmap.

          +

          FilterChannelStatus corresponds to the filter channel status.

          +
          +subscriberSubscriptionStatus
          + + +ParallelSubscriptionStatus + + +
          +

          SubscriptionStatus corresponds to the subscriber subscription status.

          -

          ConfigMapPropagationStatusCopyConfigMap +

          ParallelChannelStatus

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

          -

          ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

          @@ -5236,176 +5959,214 @@ knative.dev/pkg/apis/duck/v1.Status + +
          -name
          +channel
          -string + +Kubernetes core/v1.ObjectReference +
          -

          Name is copy configmap’s name

          +

          Channel is the reference to the underlying channel.

          -source
          +ready
          -string +knative.dev/pkg/apis.Condition
          -

          Source is “originalNamespace/originalConfigMapName”

          +

          ReadyCondition indicates whether the Channel is ready or not.

          +

          ParallelSpec +

          +

          +(Appears on: +Parallel) +

          +

          +

          + + - - + + + +
          -operation
          - -string - -
          -

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

          -
          FieldDescription
          -ready
          +branches
          -string + +[]ParallelBranch +
          -

          Ready represents the operation is ready or not

          +

          Branches is the list of Filter/Subscribers pairs.

          -reason
          +channelTemplate
          -string + +ChannelTemplateSpec +
          -

          Reason indicates reasons if the operation is not ready

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

          -resourceVersionFromSource
          +reply
          -string +knative.dev/pkg/apis/duck/v1.Destination
          -

          ResourceVersion is the resourceVersion of original configmap

          +(Optional) +

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

          -
          -

          duck.knative.dev/v1alpha1

          +

          ParallelStatus +

          -

          Package v1alpha1 is the v1alpha1 version of the API.

          +(Appears on: +Parallel)

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

            +

            ParallelStatus represents the current state of a Parallel.

            +

            + + + + + + + + + + + +

            +

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

            + - -
            FieldDescription
            -metadata
            +ingressChannelStatus
            - -Kubernetes meta/v1.ObjectMeta + +ParallelChannelStatus
            -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

            IngressChannelStatus corresponds to the ingress channel status.

            -spec
            +branchStatuses
            - -ChannelableSpec + +[]ParallelBranchStatus
            -

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

            -
            -
            - +

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

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

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

            +

            +

            + + + + + + + + - -
            FieldDescription
            -delivery
            +subscription
            - -DeliverySpec + +Kubernetes core/v1.ObjectReference
            -(Optional) -

            DeliverySpec contains options controlling the event delivery

            -
            +

            Subscription is the reference to the underlying Subscription.

            -status
            +ready
            - -ChannelableStatus - +knative.dev/pkg/apis.Condition
            +

            ReadyCondition indicates whether the Subscription is ready or not.

            -

            ChannelableCombined +

            Sequence

            -

            ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of -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.

            +

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

            @@ -5419,12 +6180,13 @@ This is not a real resource.

            @@ -5433,60 +6195,55 @@ Refer to the Kubernetes API documentation for the fields of the
            metadata
            - + Kubernetes meta/v1.ObjectMeta
            +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
            - -ChannelableCombinedSpec + +SequenceSpec
            -

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

            +

            Spec defines the desired state of the Sequence.



            -SubscribableTypeSpec
            +steps
            - -SubscribableTypeSpec + +[]SequenceStep
            -

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

            -

            SubscribableTypeSpec is for the v1alpha1 spec compatibility.

            +

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

            -SubscribableSpec
            +channelTemplate
            - -SubscribableSpec + +ChannelTemplateSpec
            -

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

            -

            SubscribableSpec is for the v1beta1 spec compatibility.

            +(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
            +reply
            - -DeliverySpec - +knative.dev/pkg/apis/duck/v1.Destination
            (Optional) -

            DeliverySpec contains options controlling the event delivery

            +

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

            @@ -5496,24 +6253,26 @@ DeliverySpec
            status
            - -ChannelableCombinedStatus + +SequenceStatus
            +(Optional) +

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

            -

            ChannelableCombinedSpec +

            SequenceChannelStatus

            (Appears on: -ChannelableCombined) +SequenceStatus)

            -

            ChannelableSpec contains Spec of the Channelable object

            @@ -5525,60 +6284,97 @@ ChannelableCombinedStatus + + +
            -SubscribableTypeSpec
            +channel
            - -SubscribableTypeSpec + +Kubernetes core/v1.ObjectReference
            -

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

            -

            SubscribableTypeSpec is for the v1alpha1 spec compatibility.

            +

            Channel is the reference to the underlying channel.

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

            ReadyCondition indicates whether the Channel is ready or not.

            +
            +

            SequenceSpec +

            -(Members of SubscribableSpec are embedded into this type.) +(Appears on: +Sequence)

            -

            SubscribableSpec is for the v1beta1 spec compatibility.

            +

            +

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

            -delivery
            +channelTemplate
            - -DeliverySpec + +ChannelTemplateSpec
            (Optional) -

            DeliverySpec contains options controlling the event delivery

            +

            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.

            -

            ChannelableCombinedStatus +

            SequenceStatus

            (Appears on: -ChannelableCombined) +Sequence)

            -

            ChannelableStatus contains the Status of a Channelable object.

            +

            SequenceStatus represents the current state of a Sequence.

            @@ -5606,74 +6402,104 @@ knative.dev/pkg/apis/duck/v1.Status + + + + + + +
            -AddressStatus
            +subscriptionStatuses
            -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus + +[]SequenceSubscriptionStatus +
            -

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

            -

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

            +

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

            -SubscribableTypeStatus
            +channelStatuses
            - -SubscribableTypeStatus + +[]SequenceChannelStatus
            +

            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}

            +
            +

            SequenceStep +

            -(Members of SubscribableTypeStatus are embedded into this type.) +(Appears on: +SequenceSpec)

            -

            SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

            -
            + + + + + +
            FieldDescription
            -SubscribableStatus
            +Destination
            - -SubscribableStatus - +knative.dev/pkg/apis/duck/v1.Destination

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

            -

            SubscribableStatus is the v1beta1 part of the Subscribers status.

            +

            Subscriber receiving the step event

            -errorChannel
            +delivery
            - -Kubernetes core/v1.ObjectReference + +DeliverySpec
            (Optional) -

            ErrorChannel is set by the channel when it supports native error handling via a channel

            +

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

            -

            ChannelableSpec +

            SequenceSubscriptionStatus

            (Appears on: -Channelable) +SequenceStatus)

            -

            ChannelableSpec contains Spec of the Channelable object

            @@ -5685,43 +6511,47 @@ Kubernetes core/v1.ObjectReference
            -SubscribableTypeSpec
            +subscription
            - -SubscribableTypeSpec + +Kubernetes core/v1.ObjectReference
            -

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

            +

            Subscription is the reference to the underlying Subscription.

            -delivery
            +ready
            - -DeliverySpec - +knative.dev/pkg/apis.Condition
            -(Optional) -

            DeliverySpec contains options controlling the event delivery

            +

            ReadyCondition indicates whether the Subscription is ready or not.

            -

            ChannelableStatus -

            +
            +

            messaging.knative.dev/v1beta1

            -(Appears on: -Channelable) +

            Package v1beta1 is the v1beta1 version of the API.

            +Resource Types: + +

            Channel +

            -

            ChannelableStatus contains the Status of a Channelable object.

            +

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

            @@ -5733,71 +6563,104 @@ DeliverySpec + + + + + + + +
            -Status
            +apiVersion
            +string
            + +messaging.knative.dev/v1beta1 + +
            +kind
            +string +
            Channel
            +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.
            -AddressStatus
            +spec
            -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus + +ChannelSpec +
            -

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

            -

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

            +

            Spec defines the desired state of the Channel.

            +
            +
            + + + + + +
            +channelTemplate
            + + +ChannelTemplateSpec + + +
            +

            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.

            -SubscribableTypeStatus
            +ChannelableSpec
            - -SubscribableTypeStatus + +ChannelableSpec

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

            -

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

            +

            Channel conforms to ChannelableSpec

            +
            -errorChannel
            +status
            - -Kubernetes core/v1.ObjectReference + +ChannelStatus
            (Optional) -

            ErrorChannel is set by the channel when it supports native error handling via a channel

            +

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

            -

            Resource +

            InMemoryChannel

            -

            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.

            +

            InMemoryChannel is a resource representing an in memory channel

            @@ -5809,92 +6672,91 @@ arbitrary other resources (such as any Source or Addressable). This is not a rea + + + + + + + + - -
            +apiVersion
            +string
            + +messaging.knative.dev/v1beta1 + +
            +kind
            +string +
            InMemoryChannel
            metadata
            - + Kubernetes meta/v1.ObjectMeta
            +(Optional) 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.

            -

            - - - - - - - + +
            FieldDescription
            +spec
            + + +InMemoryChannelSpec + + +
            +

            Spec defines the desired state of the Channel.

            +
            +
            + -
            -subscribers
            +ChannelableSpec
            - -[]SubscriberSpec + +ChannelableSpec
            -

            This is the list of subscriptions for this subscribable.

            +

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

            +

            Channel conforms to Duck type Channelable.

            -

            SubscribableStatus -

            -

            -(Appears on: -SubscribableTypeStatus) -

            -

            -

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

            -

            - - - - - + - -
            FieldDescription
            -subscribers
            +status
            - -[]SubscriberStatus + +InMemoryChannelStatus
            -

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

            +(Optional) +

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

            -

            SubscribableType +

            Subscription

            -

            -

            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.

            +

            +

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

            @@ -5906,9 +6768,26 @@ SubscribableType ObjectReferences and access the Subscription data. This is not + + + + + + + +
            +apiVersion
            +string
            + +messaging.knative.dev/v1beta1 + +
            +kind
            +string +
            Subscription
            metadata
            - + Kubernetes meta/v1.ObjectMeta @@ -5922,27 +6801,81 @@ Refer to the Kubernetes API documentation for the fields of the
            spec
            - -SubscribableTypeSpec + +SubscriptionSpec
            -

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



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

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

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

            Delivery configuration

            @@ -5952,28 +6885,31 @@ Subscribable
            status
            - -SubscribableTypeStatus + +SubscriptionStatus
            -

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

            -

            SubscribableTypeSpec +

            ChannelDefaulter +

            +

            +

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

            +

            +

            ChannelSpec

            (Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) +Channel)

            -

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

            +

            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.

            @@ -5985,28 +6921,44 @@ configured as to be compatible with Subscribable contract.

            + + + +
            -subscribable
            +channelTemplate
            - -Subscribable + +ChannelTemplateSpec
            +

            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.

            +
            +ChannelableSpec
            + + +ChannelableSpec + + +
            +

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

            +

            Channel conforms to ChannelableSpec

            -

            SubscribableTypeStatus +

            ChannelStatus

            (Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -SubscribableType) +Channel)

            -

            SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

            +

            ChannelStatus represents the current state of a Channel.

            @@ -6018,30 +6970,42 @@ Subscribable + + + +
            -subscribableStatus
            +ChannelableStatus
            - -SubscribableStatus + +ChannelableStatus
            +

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

            +

            Channel conforms to ChannelableStatus

            +
            +channel
            + +knative.dev/pkg/apis/duck/v1.KReference + +
            +

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

            -

            SubscriberSpec +

            ChannelTemplateSpec

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

            -

            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

            @@ -6053,88 +7017,116 @@ At least one of SubscriberURI and ReplyURI must be present

            + +
            -uid
            +spec
            -k8s.io/apimachinery/pkg/types.UID +k8s.io/apimachinery/pkg/runtime.RawExtension
            (Optional) -

            UID is used to understand the origin of the subscriber.

            +

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

            +
            +
            + +
            +

            ChannelTemplateSpecInternal +

            +

            +

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

            +

            + + - - + + + + + +
            -generation
            - -int64 - -
            -(Optional) -

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

            -
            FieldDescription
            -subscriberURI
            +metadata
            -knative.dev/pkg/apis.URL + +Kubernetes meta/v1.ObjectMeta +
            (Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
            -replyURI
            +spec
            -knative.dev/pkg/apis.URL +k8s.io/apimachinery/pkg/runtime.RawExtension
            (Optional) +

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

            +
            +
            + +
            +

            InMemoryChannelSpec +

            +

            +(Appears on: +InMemoryChannel) +

            +

            +

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

            +

            + + - - + + + +
            -deadLetterSink
            - -knative.dev/pkg/apis.URL - -
            -(Optional) -FieldDescription
            -delivery
            +ChannelableSpec
            - -DeliverySpec + +ChannelableSpec
            -(Optional) +

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

            +

            Channel conforms to Duck type Channelable.

            -
            -

            flows.knative.dev/v1

            +

            InMemoryChannelStatus +

            -

            Package v1 is the v1 version of the API.

            +(Appears on: +InMemoryChannel)

            -Resource Types: -
              -

              Parallel -

              -

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

              +

              ChannelStatus represents the current state of a Channel.

              @@ -6146,59 +7138,89 @@ series through Channels and Subscriptions.

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

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

              +

              Channel conforms to Duck type Channelable.

              -spec
              - - -ParallelSpec - - -
              -

              Spec defines the desired state of the Parallel.

              -
              -
              +
              +

              SubscriptionSpec +

              +

              +(Appears on: +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

              +

              + + + + + + + @@ -6210,37 +7232,34 @@ knative.dev/pkg/apis/duck/v1.Destination - -
              FieldDescription
              -branches
              +channel
              - -[]ParallelBranch + +Kubernetes core/v1.ObjectReference
              -

              Branches is the list of Filter/Subscribers pairs.

              +

              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 a case Subscriber gets sent to -when the case does not have a Reply

              -
              +

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

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

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

              +

              Delivery configuration

              -

              ParallelBranch +

              SubscriptionStatus

              (Appears on: -ParallelSpec) +Subscription)

              +

              SubscriptionStatus (computed) for a subscription

              @@ -6252,65 +7271,44 @@ date.

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

              Filter is the expression guarding the branch

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

              Subscriber receiving the event when the filter passes

              -
              -reply
              +Status
              -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.Status
              -(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 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.

              -delivery
              +physicalSubscription
              - -DeliverySpec + +SubscriptionStatusPhysicalSubscription
              -(Optional) -

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

              +

              PhysicalSubscription is the fully resolved values that this Subscription represents.

              -

              ParallelBranchStatus +

              SubscriptionStatusPhysicalSubscription

              (Appears on: -ParallelStatus) +SubscriptionStatus)

              -

              ParallelBranchStatus represents the current state of a Parallel branch

              +

              SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

              @@ -6322,53 +7320,54 @@ This includes things like retries, DLQ, etc.

              -filterSubscriptionStatus
              +subscriberUri
              - -ParallelSubscriptionStatus - +knative.dev/pkg/apis.URL
              -

              FilterSubscriptionStatus corresponds to the filter subscription status.

              +

              SubscriberURI is the fully resolved URI for spec.subscriber.

              -filterChannelStatus
              +replyUri
              - -ParallelChannelStatus - +knative.dev/pkg/apis.URL
              -

              FilterChannelStatus corresponds to the filter channel status.

              +

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

              -subscriberSubscriptionStatus
              +deadLetterSinkUri
              - -ParallelSubscriptionStatus - +knative.dev/pkg/apis.URL
              -

              SubscriptionStatus corresponds to the subscriber subscription status.

              +

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

              -

              ParallelChannelStatus -

              +
              +

              sources.knative.dev/v1alpha1

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

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

              +Resource Types: + +

              ApiServerSource +

              +

              ApiServerSource is the Schema for the apiserversources API

              @@ -6380,174 +7379,154 @@ ParallelSubscriptionStatus + + + + - -
              -channel
              - - -Kubernetes core/v1.ObjectReference - - +apiVersion
              +string
              + +sources.knative.dev/v1alpha1 +
              -

              Channel is the reference to the underlying channel.

              +kind
              +string
              ApiServerSource
              -ready
              +metadata
              -knative.dev/pkg/apis.Condition + +Kubernetes meta/v1.ObjectMeta +
              -

              ReadyCondition indicates whether the Channel is ready or not.

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

              ParallelSpec -

              -

              -(Appears on: -Parallel) -

              -

              -

              + + +spec
              + + +ApiServerSourceSpec + + + + +
              +
              - - - - - - - - -
              FieldDescription
              -branches
              +resources
              - -[]ParallelBranch + +[]ApiServerResource
              -

              Branches is the list of Filter/Subscribers pairs.

              +

              Resources is the list of resources to watch

              -channelTemplate
              +serviceAccountName
              - -ChannelTemplateSpec - +string
              (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).

              +

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

              -reply
              +sink
              -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1beta1.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

              +

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

              -

              ParallelStatus -

              -

              -(Appears on: -Parallel) -

              -

              -

              ParallelStatus represents the current state of a Parallel.

              -

              - - - - - - - - + +
              FieldDescription
              -Status
              +ceOverrides
              -knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.CloudEventOverrides
              -

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

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

              -ingressChannelStatus
              +owner
              - -ParallelChannelStatus + +APIVersionKind
              -

              IngressChannelStatus corresponds to the ingress channel status.

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

              -branchStatuses
              +mode
              - -[]ParallelBranchStatus - +string
              -

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

              +

              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.

              +
              -AddressStatus
              +status
              -knative.dev/pkg/apis/duck/v1.AddressStatus + +ApiServerSourceStatus + -

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

              SinkBinding

              -(Appears on: -ParallelBranchStatus) -

              -

              +

              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.

              @@ -6559,55 +7538,31 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

              +apiVersion
              +string - + - -
              -subscription
              - - -Kubernetes core/v1.ObjectReference - - -
              -

              Subscription is the reference to the underlying Subscription.

              + +sources.knative.dev/v1alpha1 +
              -ready
              - -knative.dev/pkg/apis.Condition - -
              -

              ReadyCondition indicates whether the Subscription is ready or not.

              +kind
              +string
              SinkBinding
              -

              Sequence -

              -

              -

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

              -

              - - - - - - - - @@ -6616,55 +7571,39 @@ Refer to the Kubernetes API documentation for the fields of the
              FieldDescription
              metadata
              - + Kubernetes meta/v1.ObjectMeta
              -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
              - -SequenceSpec + +SinkBindingSpec
              -

              Spec defines the desired state of the Sequence.



              - - - -
              -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
              +SourceSpec
              - -ChannelTemplateSpec - +knative.dev/pkg/apis/duck/v1.SourceSpec
              -(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 SourceSpec are embedded into this type.) +

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

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

              +

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

              @@ -6674,26 +7613,24 @@ knative.dev/pkg/apis/duck/v1.Destination
              status
              - -SequenceStatus + +SinkBindingStatus
              -(Optional) -

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

              -

              SequenceChannelStatus +

              ApiServerResource

              (Appears on: -SequenceStatus) +ApiServerSourceSpec)

              +

              ApiServerResource defines the resource to watch

              @@ -6705,97 +7642,80 @@ date.

              - -
              -channel
              +apiVersion
              - -Kubernetes core/v1.ObjectReference - +string
              -

              Channel is the reference to the underlying channel.

              +

              API version of the resource to watch.

              -ready
              +kind
              -knative.dev/pkg/apis.Condition +string
              -

              ReadyCondition indicates whether the Channel is ready or not.

              +

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

              -

              SequenceSpec -

              -

              -(Appears on: -Sequence) -

              -

              -

              - - - - - - - -
              FieldDescription
              -steps
              +labelSelector
              - -[]SequenceStep + +Kubernetes meta/v1.LabelSelector
              -

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

              +

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

              -channelTemplate
              - - -ChannelTemplateSpec +controllerSelector
              + +
              +Kubernetes meta/v1.OwnerReference
              -(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).

              +

              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.

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

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

              +

              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.

              -

              SequenceStatus +

              ApiServerSourceSpec

              (Appears on: -Sequence) +ApiServerSource)

              -

              SequenceStatus represents the current state of a Sequence.

              +

              ApiServerSourceSpec defines the desired state of ApiServerSource

              @@ -6807,73 +7727,94 @@ knative.dev/pkg/apis/duck/v1.Destination + + + + + + + +
              -Status
              +resources
              -knative.dev/pkg/apis/duck/v1.Status + +[]ApiServerResource +
              -

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

              +

              Resources is the list of resources to watch

              -subscriptionStatuses
              +serviceAccountName
              - -[]SequenceSubscriptionStatus - +string
              -

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

              +(Optional) +

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

              -channelStatuses
              +sink
              - -[]SequenceChannelStatus +knative.dev/pkg/apis/duck/v1beta1.Destination + +
              +(Optional) +

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

              +
              +ceOverrides
              + +knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +
              +(Optional) +

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

              +
              +owner
              + + +APIVersionKind
              -

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

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

              -AddressStatus
              +mode
              -knative.dev/pkg/apis/duck/v1.AddressStatus +string
              -

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

              +

              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.

              -

              SequenceStep +

              ApiServerSourceStatus

              (Appears on: -SequenceSpec) +ApiServerSource)

              +

              ApiServerSourceStatus defines the observed state of ApiServerSource

              @@ -6885,42 +7826,34 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

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

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

              -

              Subscriber receiving the step event

              -
              -delivery
              - - -DeliverySpec - - -
              -(Optional) -

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

              +

              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.

              -

              SequenceSubscriptionStatus +

              SinkBindingSpec

              (Appears on: -SequenceStatus) +SinkBinding)

              +

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

              @@ -6932,42 +7865,40 @@ This includes things like retries, DLQ, etc.

              -subscription
              +SourceSpec
              - -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.SourceSpec
              -

              Subscription is the reference to the underlying Subscription.

              +

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

              -ready
              +BindingSpec
              -knative.dev/pkg/apis.Condition +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
              -

              ReadyCondition indicates whether the Subscription is ready or not.

              +

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

              -
              -

              flows.knative.dev/v1beta1

              +

              SinkBindingStatus +

              -

              Package v1beta1 is the v1beta1 version of the API.

              +(Appears on: +SinkBinding)

              -Resource Types: -
                -

                Parallel -

                -

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

                +

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

                @@ -6979,101 +7910,41 @@ series through Channels and Subscriptions.

                - - - - - - - -
                -metadata
                - - -Kubernetes meta/v1.ObjectMeta - - -
                -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
                -spec
                - - -ParallelSpec - - -
                -

                Spec defines the desired state of the Parallel.

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

                Branches is the list of Filter/Subscribers pairs.

                -
                -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 a case Subscriber gets sent to -when the case does not have a Reply

                -
                -
                -status
                +SourceStatus
                - -ParallelStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus
                -(Optional) -

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

                +

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

                -

                ParallelBranch -

                +
                +

                duck.knative.dev/v1

                +

                +

                Package v1 is the v1 version of the API.

                +

                +Resource Types: +
                  +

                  BackoffPolicyType +(string alias)

                  (Appears on: -ParallelSpec) +DeliverySpec) +

                  +

                  +

                  BackoffPolicyType is the type for backoff policies

                  +

                  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.

                  @@ -7085,124 +7956,88 @@ date.

                  - +

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

                  +
                  +
                  +
                  -filter
                  +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 + +ChannelableSpec +
                  -

                  Subscriber receiving the event when the filter passes

                  -
                  -
                  -reply
                  +SubscribableSpec
                  -knative.dev/pkg/apis/duck/v1.Destination + +SubscribableSpec +
                  -(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 SubscribableSpec are embedded into this type.) +

                  delivery
                  - + DeliverySpec
                  (Optional) -

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

                  +

                  DeliverySpec contains options controlling the event delivery

                  -

                  ParallelBranchStatus -

                  -

                  -(Appears on: -ParallelStatus) -

                  -

                  -

                  ParallelBranchStatus represents the current state of a Parallel branch

                  -

                  - - - - - - - - - - - - - - -
                  FieldDescription
                  -filterSubscriptionStatus
                  - - -ParallelSubscriptionStatus - - -
                  -

                  FilterSubscriptionStatus corresponds to the filter subscription status.

                  -
                  -filterChannelStatus
                  - - -ParallelChannelStatus - - -
                  -

                  FilterChannelStatus corresponds to the filter channel status.

                  -subscriberSubscriptionStatus
                  +status
                  - -ParallelSubscriptionStatus + +ChannelableStatus
                  -

                  SubscriptionStatus corresponds to the subscriber subscription status.

                  -

                  ParallelChannelStatus +

                  ChannelableSpec

                  (Appears on: -ParallelBranchStatus, -ParallelStatus) +ChannelSpec, +Channelable, +InMemoryChannelSpec)

                  +

                  ChannelableSpec contains Spec of the Channelable object

                  @@ -7214,37 +8049,45 @@ ParallelSubscriptionStatus
                  -channel
                  +SubscribableSpec
                  - -Kubernetes core/v1.ObjectReference + +SubscribableSpec
                  -

                  Channel is the reference to the underlying channel.

                  +

                  +(Members of SubscribableSpec 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) +ChannelStatus, +Channelable, +InMemoryChannelStatus)

                  +

                  ChannelableStatus contains the Status of a Channelable object.

                  @@ -7256,55 +8099,79 @@ 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/v1.AddressStatus + +
                  +

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

                  +

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

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

                  +

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

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

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

                  +

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

                  -

                  ParallelStatus +

                  DeliverySpec

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

                  -

                  ParallelStatus represents the current state of a Parallel.

                  +

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

                  @@ -7316,72 +8183,67 @@ when the case does not have a Reply

                  -Status
                  +deadLetterSink
                  -knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.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.

                  +(Optional) +

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

                  -ingressChannelStatus
                  +retry
                  - -ParallelChannelStatus - +int32
                  -

                  IngressChannelStatus corresponds to the ingress channel status.

                  +(Optional) +

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

                  -branchStatuses
                  +backoffPolicy
                  - -[]ParallelBranchStatus + +BackoffPolicyType
                  -

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

                  +(Optional) +

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

                  -AddressStatus
                  +backoffDelay
                  -knative.dev/pkg/apis/duck/v1.AddressStatus +string
                  -

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

                  +(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 backoffDelay*. +For exponential policy, backoff delay is backoffDelay*2^.

                  -

                  ParallelSubscriptionStatus +

                  DeliveryStatus

                  -(Appears on: -ParallelBranchStatus) -

                  -

                  +

                  DeliveryStatus contains the Status of an object supporting delivery options.

                  @@ -7393,35 +8255,25 @@ 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
                  +deadLetterChannel
                  -knative.dev/pkg/apis.Condition +knative.dev/pkg/apis/duck/v1.KReference
                  -

                  ReadyCondition indicates whether the Subscription is ready or not.

                  +(Optional) +

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

                  -

                  Sequence +

                  Subscribable

                  -

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

                  +

                  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.

                  @@ -7435,13 +8287,12 @@ series through Channels and Subscriptions.

                  @@ -7450,55 +8301,28 @@ Refer to the Kubernetes API documentation for the fields of the
                  metadata
                  - + Kubernetes meta/v1.ObjectMeta
                  -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                  - -SequenceSpec + +SubscribableSpec
                  -

                  Spec defines the desired state of the Sequence.

                  +

                  SubscribableSpec 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
                  +subscribers
                  - -ChannelTemplateSpec + +[]SubscriberSpec
                  -(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.

                  +

                  This is the list of subscriptions for this subscribable.

                  @@ -7508,26 +8332,27 @@ knative.dev/pkg/apis/duck/v1.Destination
                  status
                  - -SequenceStatus + +SubscribableStatus
                  -(Optional) -

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

                  +

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

                  -

                  SequenceChannelStatus +

                  SubscribableSpec

                  (Appears on: -SequenceStatus) +ChannelableSpec, +Subscribable)

                  +

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

                  @@ -7539,37 +8364,29 @@ date.

                  - - - -
                  -channel
                  +subscribers
                  - -Kubernetes core/v1.ObjectReference + +[]SubscriberSpec
                  -

                  Channel is the reference to the underlying channel.

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

                  ReadyCondition indicates whether the Channel is ready or not.

                  +

                  This is the list of subscriptions for this subscribable.

                  -

                  SequenceSpec +

                  SubscribableStatus

                  (Appears on: -Sequence) +ChannelableStatus, +Subscribable)

                  +

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

                  @@ -7581,55 +8398,28 @@ knative.dev/pkg/apis.Condition - - - - - - - -
                  -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
                  +subscribers
                  - -ChannelTemplateSpec + +[]SubscriberStatus
                  -(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.

                  +

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

                  -

                  SequenceStatus +

                  SubscriberSpec

                  (Appears on: -Sequence) +SubscribableSpec)

                  -

                  SequenceStatus represents the current state of a Sequence.

                  +

                  SubscriberSpec defines a single subscriber to a Subscribable.

                  +

                  At least one of SubscriberURI and ReplyURI must be present

                  @@ -7641,73 +8431,76 @@ knative.dev/pkg/apis/duck/v1.Destination + + + +
                  -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.

                  -subscriptionStatuses
                  +generation
                  - -[]SequenceSubscriptionStatus - +int64
                  -

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

                  +(Optional) +

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

                  -channelStatuses
                  +subscriberUri
                  - -[]SequenceChannelStatus - +knative.dev/pkg/apis.URL
                  -

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

                  +(Optional) +

                  SubscriberURI is the endpoint for the subscriber

                  -AddressStatus
                  +replyUri
                  -knative.dev/pkg/apis/duck/v1.AddressStatus +knative.dev/pkg/apis.URL
                  -

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

                  ReplyURI is the endpoint for the reply

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

                  DeliverySpec contains options controlling the event delivery

                  -

                  SequenceStep +

                  SubscriberStatus

                  (Appears on: -SequenceSpec) +SubscribableStatus)

                  +

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

                  @@ -7719,94 +8512,68 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

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

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

                  -

                  Subscriber receiving the step event

                  +(Optional) +

                  UID is used to understand the origin of the subscriber.

                  -delivery
                  +observedGeneration
                  - -DeliverySpec - +int64
                  (Optional) -

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

                  +

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

                  -

                  SequenceSubscriptionStatus -

                  -

                  -(Appears on: -SequenceStatus) -

                  -

                  -

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

                  Subscription is the reference to the underlying Subscription.

                  +

                  Status of the subscriber.

                  -ready
                  +message
                  -knative.dev/pkg/apis.Condition +string
                  -

                  ReadyCondition indicates whether the Subscription is ready or not.

                  +(Optional) +

                  A human readable message indicating details of Ready status.


                  -

                  messaging.knative.dev/v1beta1

                  +

                  duck.knative.dev/v1alpha1

                  -

                  Package v1beta1 is the v1beta1 version of the API.

                  +

                  Package v1alpha1 is the v1alpha1 version of the API.

                  Resource Types: - -

                  Channel +
                    +

                    Channelable

                    -

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

                    +

                    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.

                    @@ -7818,32 +8585,14 @@ Resource Types: - - - - - - - - @@ -7852,44 +8601,43 @@ Refer to the Kubernetes API documentation for the fields of the
                    -apiVersion
                    -string
                    - -messaging.knative.dev/v1beta1 - -
                    -kind
                    -string -
                    Channel
                    metadata
                    - + Kubernetes meta/v1.ObjectMeta
                    -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                    - -ChannelSpec + +ChannelableSpec
                    -

                    Spec defines the desired state of the Channel.

                    +

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



                    -channelTemplate
                    +SubscribableTypeSpec
                    - -ChannelTemplateSpec + +SubscribableTypeSpec
                    -

                    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.

                    +

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

                    -ChannelableSpec
                    +delivery
                    - -ChannelableSpec + +DeliverySpec
                    -

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

                    -

                    Channel conforms to ChannelableSpec

                    +(Optional) +

                    DeliverySpec contains options controlling the event delivery

                    @@ -7899,23 +8647,24 @@ ChannelableSpec
                    status
                    - -ChannelStatus + +ChannelableStatus
                    -(Optional) -

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

                    -

                    InMemoryChannel +

                    ChannelableCombined

                    -

                    InMemoryChannel is a resource representing an in memory channel

                    +

                    ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of +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.

                    @@ -7927,32 +8676,14 @@ date.

                    - - - - - - - - @@ -7961,30 +8692,60 @@ Refer to the Kubernetes API documentation for the fields of the
                    -apiVersion
                    -string
                    - -messaging.knative.dev/v1beta1 - -
                    -kind
                    -string -
                    InMemoryChannel
                    metadata
                    - + Kubernetes meta/v1.ObjectMeta
                    -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                    - -InMemoryChannelSpec + +ChannelableCombinedSpec
                    -

                    Spec defines the desired state of the Channel.

                    +

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



                    + + + + + + + +
                    -ChannelableSpec
                    +SubscribableTypeSpec
                    - -ChannelableSpec + +SubscribableTypeSpec

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

                    -

                    Channel conforms to Duck type Channelable.

                    +

                    SubscribableTypeSpec is for the v1alpha1 spec compatibility.

                    +
                    +SubscribableSpec
                    + + +SubscribableSpec + + +
                    +

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

                    +

                    SubscribableSpec is for the v1beta1 spec compatibility.

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

                    DeliverySpec contains options controlling the event delivery

                    @@ -7994,24 +8755,24 @@ ChannelableSpec
                    status
                    - -InMemoryChannelStatus + +ChannelableCombinedStatus
                    -(Optional) -

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

                    -

                    Subscription +

                    ChannelableCombinedSpec

                    -

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

                    +(Appears on: +ChannelableCombined) +

                    +

                    +

                    ChannelableSpec contains Spec of the Channelable object

                    @@ -8023,148 +8784,155 @@ corresponds to the subscriptions.channels.knative.dev CRD.

                    - - - - + + +
                    -apiVersion
                    -string
                    - -messaging.knative.dev/v1beta1 - +SubscribableTypeSpec
                    + + +SubscribableTypeSpec + +
                    -kind
                    -string +

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

                    +

                    SubscribableTypeSpec is for the v1alpha1 spec compatibility.

                    Subscription
                    -metadata
                    +SubscribableSpec
                    - -Kubernetes meta/v1.ObjectMeta + +SubscribableSpec
                    -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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

                    +

                    SubscribableSpec is for the v1beta1 spec compatibility.

                    -spec
                    +delivery
                    - -SubscriptionSpec + +DeliverySpec
                    -
                    -
                    +(Optional) +

                    DeliverySpec contains options controlling the event delivery

                    +
                    +

                    ChannelableCombinedStatus +

                    +

                    +(Appears on: +ChannelableCombined) +

                    +

                    +

                    ChannelableStatus contains the Status of a Channelable object.

                    +

                    + + + + + + + - -
                    FieldDescription
                    -channel
                    +Status
                    - -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.Status
                    -

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

                    +

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

                    -subscriber
                    +AddressStatus
                    -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
                    -(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.

                    +

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

                    +

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

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

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

                    +

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

                    +

                    SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

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

                    Delivery configuration

                    -
                    +

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

                    +

                    SubscribableStatus is the v1beta1 part of the Subscribers status.

                    -status
                    +errorChannel
                    - -SubscriptionStatus + +Kubernetes core/v1.ObjectReference +(Optional) +

                    ErrorChannel is set by the channel when it supports native error handling via a channel

                    -

                    ChannelDefaulter -

                    -

                    -

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

                    -

                    -

                    ChannelSpec +

                    ChannelableSpec

                    (Appears on: -Channel) +Channelable)

                    -

                    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.

                    +

                    ChannelableSpec contains Spec of the Channelable object

                    @@ -8176,44 +8944,43 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba
                    -channelTemplate
                    +SubscribableTypeSpec
                    - -ChannelTemplateSpec + +SubscribableTypeSpec
                    -

                    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.

                    +

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

                    -ChannelableSpec
                    +delivery
                    - -ChannelableSpec + +DeliverySpec
                    -

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

                    -

                    Channel conforms to ChannelableSpec

                    +(Optional) +

                    DeliverySpec contains options controlling the event delivery

                    -

                    ChannelStatus +

                    ChannelableStatus

                    (Appears on: -Channel) +Channelable)

                    -

                    ChannelStatus represents the current state of a Channel.

                    +

                    ChannelableStatus contains the Status of a Channelable object.

                    @@ -8225,75 +8992,71 @@ ChannelableSpec - - -
                    -ChannelableStatus
                    +Status
                    - -ChannelableStatus - +knative.dev/pkg/apis/duck/v1.Status

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

                    -

                    Channel conforms to ChannelableStatus

                    +

                    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.

                    -channel
                    +AddressStatus
                    -knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
                    -

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

                    -
                    -

                    ChannelTemplateSpec -

                    -(Appears on: -ChannelSpec, -ParallelSpec, -SequenceSpec) +(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.

                    + - -
                    FieldDescription
                    -spec
                    +errorChannel
                    -k8s.io/apimachinery/pkg/runtime.RawExtension + +Kubernetes core/v1.ObjectReference +
                    (Optional) -

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

                    -
                    -
                    - -
                    +

                    ErrorChannel is set by the channel when it supports native error handling via a channel

                    -

                    ChannelTemplateSpecInternal +

                    Resource

                    -

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

                    +

                    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.

                    @@ -8307,46 +9070,27 @@ we can easily create new Channels off of it.

                    - - - -
                    metadata
                    - + Kubernetes meta/v1.ObjectMeta
                    -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
                    -spec
                    - -k8s.io/apimachinery/pkg/runtime.RawExtension - -
                    -(Optional) -

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

                    -
                    -
                    - -
                    -
                    -

                    InMemoryChannelSpec +

                    Subscribable

                    (Appears on: -InMemoryChannel) +SubscribableTypeSpec)

                    -

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

                    +

                    Subscribable is the schema for the subscribable portion of the spec +section of the resource.

                    @@ -8358,30 +9102,28 @@ arguments for a Channel.

                    -ChannelableSpec
                    +subscribers
                    - -ChannelableSpec + +[]SubscriberSpec
                    -

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

                    -

                    Channel conforms to Duck type Channelable.

                    +

                    This is the list of subscriptions for this subscribable.

                    -

                    InMemoryChannelStatus +

                    SubscribableStatus

                    (Appears on: -InMemoryChannel) +SubscribableTypeStatus)

                    -

                    ChannelStatus represents the current state of a Channel.

                    +

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

                    @@ -8393,41 +9135,25 @@ ChannelableSpec
                    -ChannelableStatus
                    +subscribers
                    - -ChannelableStatus + +[]SubscriberStatus
                    -

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

                    -

                    Channel conforms to Duck type Channelable.

                    +

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

                    -

                    SubscriptionSpec +

                    SubscribableType

                    -(Appears on: -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

                    +

                    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.

                    @@ -8439,82 +9165,74 @@ channel –> reply

                    - +

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

                    +
                    +
                    +
                    -channel
                    +metadata
                    - -Kubernetes core/v1.ObjectReference + +Kubernetes meta/v1.ObjectMeta
                    -

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

                    +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                    -subscriber
                    +spec
                    -knative.dev/pkg/apis/duck/v1.Destination + +SubscribableTypeSpec +
                    -(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
                    +subscribable
                    -knative.dev/pkg/apis/duck/v1.Destination + +Subscribable +
                    -(Optional) -

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

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

                    Delivery configuration

                    +

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

                    -

                    SubscriptionStatus +

                    SubscribableTypeSpec

                    (Appears on: -Subscription) +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType)

                    -

                    SubscriptionStatus (computed) for a subscription

                    +

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

                    @@ -8526,44 +9244,63 @@ DeliverySpec + + +
                    -Status
                    +subscribable
                    -knative.dev/pkg/apis/duck/v1.Status + +Subscribable +
                    +
                    +

                    SubscribableTypeStatus +

                    -(Members of Status are embedded into this type.) +(Appears on: +ChannelableCombinedStatus, +ChannelableStatus, +SubscribableType)

                    -

                    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.

                    - +

                    +

                    SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

                    +

                    + + + + + + +
                    FieldDescription
                    -physicalSubscription
                    +subscribableStatus
                    - -SubscriptionStatusPhysicalSubscription + +SubscribableStatus
                    -

                    PhysicalSubscription is the fully resolved values that this Subscription represents.

                    -

                    SubscriptionStatusPhysicalSubscription +

                    SubscriberSpec

                    (Appears on: -SubscriptionStatus) +Subscribable)

                    -

                    SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

                    +

                    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

                    @@ -8575,55 +9312,92 @@ Subscription.

                    + + + + + + + + + + + +
                    -subscriberUri
                    +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
                    knative.dev/pkg/apis.URL
                    -

                    SubscriberURI is the fully resolved URI for spec.subscriber.

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

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

                    +(Optional)
                    -deadLetterSinkUri
                    +deadLetterSink
                    knative.dev/pkg/apis.URL
                    -

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

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

                    -

                    sources.knative.dev/v1alpha2

                    +

                    sources.knative.dev/v1beta1

                    -

                    Package v1alpha2 contains API Schema definitions for the sources v1beta1 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

                    @@ -8642,7 +9416,7 @@ Resource Types: string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1 @@ -8657,7 +9431,7 @@ string metadata
                    - + Kubernetes meta/v1.ObjectMeta @@ -8671,7 +9445,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                    - + ApiServerSourceSpec @@ -8702,7 +9476,7 @@ and modifications of the event sent to the sink.

                    resources
                    - + []APIVersionKindSelector @@ -8717,7 +9491,7 @@ selector to help filter.

                    owner
                    - + APIVersionKind @@ -8764,7 +9538,7 @@ source. Defaults to default if not set.

                    status
                    - + ApiServerSourceStatus @@ -8774,7 +9548,7 @@ ApiServerSourceStatus -

                    ContainerSource +

                    ContainerSource

                    ContainerSource is the Schema for the containersources API

                    @@ -8793,7 +9567,7 @@ ApiServerSourceStatus string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1 @@ -8808,7 +9582,7 @@ string metadata
                    - + Kubernetes meta/v1.ObjectMeta @@ -8822,7 +9596,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                    - + ContainerSourceSpec @@ -8853,7 +9627,7 @@ and modifications of the event sent to the sink.

                    template
                    - + Kubernetes core/v1.PodTemplateSpec @@ -8869,7 +9643,7 @@ Kubernetes core/v1.PodTemplateSpec status
                    - + ContainerSourceStatus @@ -8879,7 +9653,7 @@ ContainerSourceStatus -

                    PingSource +

                    PingSource

                    PingSource is the Schema for the PingSources API.

                    @@ -8898,7 +9672,7 @@ ContainerSourceStatus string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1 @@ -8913,7 +9687,7 @@ string metadata
                    - + Kubernetes meta/v1.ObjectMeta @@ -8927,7 +9701,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                    - + PingSourceSpec @@ -8968,6 +9742,20 @@ string +timezone
                    + +string + + + +

                    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

                    + + + + jsonData
                    string @@ -8987,7 +9775,7 @@ to “application/json”.

                    status
                    - + PingSourceStatus @@ -8997,7 +9785,7 @@ PingSourceStatus -

                    SinkBinding +

                    SinkBinding

                    SinkBinding describes a Binding that is also a Source. @@ -9021,7 +9809,7 @@ cloud events.

                    string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1 @@ -9036,7 +9824,7 @@ string metadata
                    - + Kubernetes meta/v1.ObjectMeta @@ -9050,7 +9838,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                    - + SinkBindingSpec @@ -9081,14 +9869,14 @@ 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/v1alpha1 BindingSpec, which currently provides: +

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

                    @@ -9100,7 +9888,7 @@ should be augmented by Binding implementations.

                    status
                    - + SinkBindingStatus @@ -9110,12 +9898,11 @@ SinkBindingStatus -

                    APIVersionKind +

                    APIVersionKind

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

                    APIVersionKind is an APIVersion and Kind tuple.

                    @@ -9153,11 +9940,11 @@ More info: APIVersionKindSelector +

                    APIVersionKindSelector

                    (Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)

                    APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

                    @@ -9197,7 +9984,7 @@ More info: + Kubernetes meta/v1.LabelSelector
                    @@ -9211,11 +9998,11 @@ More info: ApiServerSourceSpec +

                    ApiServerSourceSpec

                    (Appears on: -ApiServerSource) +ApiServerSource)

                    ApiServerSourceSpec defines the desired state of ApiServerSource

                    @@ -9250,7 +10037,7 @@ and modifications of the event sent to the sink.

                    resources
                    - + []APIVersionKindSelector @@ -9265,7 +10052,7 @@ selector to help filter.

                    owner
                    - + APIVersionKind @@ -9307,11 +10094,11 @@ source. Defaults to default if not set.

                    -

                    ApiServerSourceStatus +

                    ApiServerSourceStatus

                    (Appears on: -ApiServerSource) +ApiServerSource)

                    ApiServerSourceStatus defines the observed state of ApiServerSource

                    @@ -9346,11 +10133,11 @@ Source.

                    -

                    ContainerSourceSpec +

                    ContainerSourceSpec

                    (Appears on: -ContainerSource) +ContainerSource)

                    ContainerSourceSpec defines the desired state of ContainerSource

                    @@ -9385,7 +10172,7 @@ and modifications of the event sent to the sink.

                    template
                    - + Kubernetes core/v1.PodTemplateSpec @@ -9396,11 +10183,11 @@ Kubernetes core/v1.PodTemplateSpec -

                    ContainerSourceStatus +

                    ContainerSourceStatus

                    (Appears on: -ContainerSource) +ContainerSource)

                    ContainerSourceStatus defines the observed state of ContainerSource

                    @@ -9435,11 +10222,11 @@ Source.

                    -

                    PingSourceSpec +

                    PingSourceSpec

                    (Appears on: -PingSource) +PingSource)

                    PingSourceSpec defines the desired state of the PingSource.

                    @@ -9484,6 +10271,20 @@ string +timezone
                    + +string + + + +

                    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

                    + + + + jsonData
                    string @@ -9498,11 +10299,11 @@ to “application/json”.

                    -

                    PingSourceStatus +

                    PingSourceStatus

                    (Appears on: -PingSource) +PingSource)

                    PingSourceStatus defines the observed state of PingSource.

                    @@ -9537,11 +10338,11 @@ Source.

                    -

                    SinkBindingSpec +

                    SinkBindingSpec

                    (Appears on: -SinkBinding) +SinkBinding)

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

                    @@ -9576,25 +10377,25 @@ 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/v1alpha1 BindingSpec, which currently provides: +

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

                    @@ -9632,5 +10433,5 @@ Source.


                    Generated with gen-crd-api-reference-docs -on git commit 74b9bed2. +on git commit 0f9a8c55c.

                    diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index dc525dc149..8784d7bc30 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -1,11 +1,911 @@

                    Packages:

                    +

                    serving.knative.dev/v1alpha1

                    +

                    +

                    Package v1alpha1 contains the v1alpha1 versions of the serving apis. +Api versions allow the api contract for a resource to be changed while keeping +backward compatibility by support multiple concurrent versions +of the same resource

                    +

                    +Resource Types: + +

                    DomainMapping +

                    +

                    +

                    DomainMapping is a mapping from a custom hostname to an Addressable.

                    +

                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                    FieldDescription
                    +apiVersion
                    +string
                    + +serving.knative.dev/v1alpha1 + +
                    +kind
                    +string +
                    DomainMapping
                    +metadata
                    + + +Kubernetes meta/v1.ObjectMeta + + +
                    +(Optional) +

                    Standard object’s metadata. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata

                    +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
                    +spec
                    + + +DomainMappingSpec + + +
                    +(Optional) +

                    Spec is the desired state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

                    +
                    +
                    + + + + + +
                    +ref
                    + +knative.dev/pkg/apis/duck/v1.KReference + +
                    +

                    Ref points to an Addressable. +Currently, Ref must be a KSvc.

                    +
                    +
                    +status
                    + + +DomainMappingStatus + + +
                    +(Optional) +

                    Status is the current state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

                    +
                    +

                    CannotConvertError +

                    +

                    +

                    CannotConvertError is returned when a field cannot be converted.

                    +

                    + + + + + + + + + + + + + + + + + +
                    FieldDescription
                    +Message
                    + +string + +
                    +
                    +Field
                    + +string + +
                    +
                    +

                    DomainMappingSpec +

                    +

                    +(Appears on: +DomainMapping) +

                    +

                    +

                    DomainMappingSpec describes the DomainMapping the user wishes to exist.

                    +

                    + + + + + + + + + + + + + +
                    FieldDescription
                    +ref
                    + +knative.dev/pkg/apis/duck/v1.KReference + +
                    +

                    Ref points to an Addressable. +Currently, Ref must be a KSvc.

                    +
                    +

                    DomainMappingStatus +

                    +

                    +(Appears on: +DomainMapping) +

                    +

                    +

                    DomainMappingStatus describes the current state of the DomainMapping.

                    +

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

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

                    +
                    +url
                    + +knative.dev/pkg/apis.URL + +
                    +(Optional) +

                    URL is the URL of this DomainMapping.

                    +
                    +address
                    + +knative.dev/pkg/apis/duck/v1.Addressable + +
                    +(Optional) +

                    Address holds the information needed for a DomainMapping to be the target of an event.

                    +
                    +
                    +

                    autoscaling.internal.knative.dev/v1alpha1

                    +

                    +

                    Package v1alpha1 contains the Autoscaling v1alpha1 API types.

                    +

                    +Resource Types: + +

                    PodAutoscaler +

                    +

                    +

                    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

                    +

                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                    FieldDescription
                    +apiVersion
                    +string
                    + +autoscaling.internal.knative.dev/v1alpha1 + +
                    +kind
                    +string +
                    PodAutoscaler
                    +metadata
                    + + +Kubernetes meta/v1.ObjectMeta + + +
                    +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
                    +spec
                    + + +PodAutoscalerSpec + + +
                    +(Optional) +

                    Spec holds the desired state of the PodAutoscaler (from the client).

                    +
                    +
                    + + + + + + + + + + + + + + + + + +
                    +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
                    + + +ReachabilityType + + +
                    +(Optional) +

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

                    +
                    +
                    +status
                    + + +PodAutoscalerStatus + + +
                    +(Optional) +

                    Status communicates the observed state of the PodAutoscaler (from the controller).

                    +
                    +

                    Metric +

                    +

                    +

                    Metric represents a resource to configure the metric collector with.

                    +

                    + + + + + + + + + + + + + + + + + + + + + +
                    FieldDescription
                    +metadata
                    + + +Kubernetes meta/v1.ObjectMeta + + +
                    +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
                    +spec
                    + + +MetricSpec + + +
                    +(Optional) +

                    Spec holds the desired state of the Metric (from the client).

                    +
                    +
                    + + + + + + + + + + + + + +
                    +stableWindow
                    + +time.Duration + +
                    +

                    StableWindow is the aggregation window for metrics in a stable state.

                    +
                    +panicWindow
                    + +time.Duration + +
                    +

                    PanicWindow is the aggregation window for metrics where quick reactions are needed.

                    +
                    +scrapeTarget
                    + +string + +
                    +

                    ScrapeTarget is the K8s service that publishes the metric endpoint.

                    +
                    +
                    +status
                    + + +MetricStatus + + +
                    +(Optional) +

                    Status communicates the observed state of the Metric (from the controller).

                    +
                    +

                    MetricSpec +

                    +

                    +(Appears on: +Metric) +

                    +

                    +

                    MetricSpec contains all values a metric collector needs to operate.

                    +

                    + + + + + + + + + + + + + + + + + + + + + +
                    FieldDescription
                    +stableWindow
                    + +time.Duration + +
                    +

                    StableWindow is the aggregation window for metrics in a stable state.

                    +
                    +panicWindow
                    + +time.Duration + +
                    +

                    PanicWindow is the aggregation window for metrics where quick reactions are needed.

                    +
                    +scrapeTarget
                    + +string + +
                    +

                    ScrapeTarget is the K8s service that publishes the metric endpoint.

                    +
                    +

                    MetricStatus +

                    +

                    +(Appears on: +Metric) +

                    +

                    +

                    MetricStatus reflects the status of metric collection for this specific entity.

                    +

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

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

                    +
                    +

                    PodAutoscalerSpec +

                    +

                    +(Appears on: +PodAutoscaler) +

                    +

                    +

                    PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).

                    +

                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                    FieldDescription
                    +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
                    + + +ReachabilityType + + +
                    +(Optional) +

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

                    +
                    +

                    PodAutoscalerStatus +

                    +

                    +(Appears on: +PodAutoscaler) +

                    +

                    +

                    PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).

                    +

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

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

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

                    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.

                    +

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

                    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

                    +

                    Package v1 contains the Serving v1 API types.

                    Resource Types:
                    • @@ -55,7 +955,7 @@ string metadata
                      - + Kubernetes meta/v1.ObjectMeta @@ -149,7 +1049,7 @@ string metadata
                      - + Kubernetes meta/v1.ObjectMeta @@ -178,7 +1078,7 @@ RevisionSpec PodSpec
                      - + Kubernetes core/v1.PodSpec @@ -275,7 +1175,7 @@ string metadata
                      - + Kubernetes meta/v1.ObjectMeta @@ -378,7 +1278,7 @@ string metadata
                      - + Kubernetes meta/v1.ObjectMeta @@ -646,7 +1546,7 @@ string PodSpec
                      - + Kubernetes core/v1.PodSpec @@ -808,7 +1708,7 @@ Based on: + Kubernetes meta/v1.ObjectMeta
                      @@ -837,7 +1737,7 @@ RevisionSpec PodSpec
                      - + Kubernetes core/v1.PodSpec @@ -1273,5 +2173,5 @@ a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)<

                      Generated with gen-crd-api-reference-docs -on git commit af83e581d. +on git commit db4879e0f.

                      From 469c795ac99d63d791ded22290c60d0646a00a13 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Mon, 16 Nov 2020 16:51:32 -0800 Subject: [PATCH 4/9] revert API version and add troubleshooting docs --- docs/reference/api/README.md | 18 + docs/reference/api/eventing/eventing.md | 7130 +++++++++++------------ docs/reference/api/serving.md | 498 +- hack/reference-docs-gen-config.json | 2 +- 4 files changed, 3833 insertions(+), 3815 deletions(-) diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index aed60b7248..d14c5aa1a6 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -79,6 +79,24 @@ To generate a version of the API: After a successful build, the tool automatically opens that folder in the `tmp` directory. + If the script fails, there are a couple possible causes. + + * If you get the + `F1116 15:21:23.549503 63473 main.go:129] no API packages found in ./pkg/apis` + error, check if a new version of the script is available: + https://github.com/ahmetb/gen-crd-api-reference-docs/tags + + The script is kept up-to-date with changes that go into the Kubernetes API. + As Knative adds support for those APIs, you might need make sure the + corresponding + [script `gen-crd-api-reference-docs` version](https://github.com/knative/docs/blob/master/hack/gen-api-reference-docs.sh#L26) + is used. + + * If you get the + `F0807 13:58:20.621526 168834 main.go:444] type invalid type has kind=Unsupported which is unhandled` + error, the import target might have moved. For more details and an example, + see [#2054](https://github.com/knative/docs/pull/2054) (and the linked Issues). + 1. Copy the generated API files into the `docs/reference` directory of your knative/docs clone. diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index a17dee5c0a..7d23920f20 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -1,64 +1,64 @@

                      Packages:

                      -

                      duck.knative.dev/v1beta1

                      +

                      duck.knative.dev/v1

                      -

                      Package v1beta1 is the v1beta1 version of the API.

                      +

                      Package v1 is the v1 version of the API.

                      Resource Types:
                        -

                        BackoffPolicyType +

                        BackoffPolicyType (string alias)

                        (Appears on: -DeliverySpec) +DeliverySpec)

                        BackoffPolicyType is the type for backoff policies

                        -

                        Channelable +

                        Channelable

                        Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers @@ -77,7 +77,7 @@ Channelable ObjectReferences and access their subscription and address data. Th metadata
                        - + Kubernetes meta/v1.ObjectMeta @@ -91,7 +91,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                        - + ChannelableSpec @@ -105,7 +105,7 @@ ChannelableSpec SubscribableSpec
                        - + SubscribableSpec @@ -120,7 +120,7 @@ SubscribableSpec delivery
                        - + DeliverySpec @@ -137,7 +137,7 @@ DeliverySpec status
                        - + ChannelableStatus @@ -147,13 +147,13 @@ ChannelableStatus -

                        ChannelableSpec +

                        ChannelableSpec

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

                        ChannelableSpec contains Spec of the Channelable object

                        @@ -170,7 +170,7 @@ ChannelableStatus SubscribableSpec
                        - + SubscribableSpec @@ -185,7 +185,7 @@ SubscribableSpec delivery
                        - + DeliverySpec @@ -197,13 +197,13 @@ DeliverySpec -

                        ChannelableStatus +

                        ChannelableStatus

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

                        ChannelableStatus contains the Status of a Channelable object.

                        @@ -250,7 +250,7 @@ knative.dev/pkg/apis/duck/v1.AddressStatus SubscribableStatus
                        - + SubscribableStatus @@ -277,19 +277,16 @@ Failed messages are delivered here.

                        -

                        DeliverySpec +

                        DeliverySpec

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

                        DeliverySpec contains the delivery options for event senders, @@ -333,7 +330,7 @@ sending an event before moving it to the dead letter sink.

                        backoffPolicy
                        - + BackoffPolicyType @@ -362,7 +359,7 @@ For exponential policy, backoff delay is backoffDelay*2^.

                        -

                        DeliveryStatus +

                        DeliveryStatus

                        DeliveryStatus contains the Status of an object supporting delivery options.

                        @@ -390,7 +387,7 @@ where failed events are sent to.

                        -

                        Subscribable +

                        Subscribable

                        Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers @@ -409,7 +406,7 @@ SubscribableType ObjectReferences and access the Subscription data. This is not metadata
                        - + Kubernetes meta/v1.ObjectMeta @@ -423,7 +420,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                        - + SubscribableSpec @@ -438,7 +435,7 @@ configured as to be compatible with Subscribable contract.

                        subscribers
                        - + []SubscriberSpec @@ -454,7 +451,7 @@ configured as to be compatible with Subscribable contract.

                        status
                        - + SubscribableStatus @@ -466,13 +463,12 @@ configured as to be compatible with Subscribable contract.

                        -

                        SubscribableSpec +

                        SubscribableSpec

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

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

                        @@ -489,7 +485,7 @@ configured as to be compatible with Subscribable contract.

                        subscribers
                        - + []SubscriberSpec @@ -500,13 +496,12 @@ configured as to be compatible with Subscribable contract.

                        -

                        SubscribableStatus +

                        SubscribableStatus

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

                        SubscribableStatus is the schema for the subscribable’s status portion of the status @@ -524,7 +519,7 @@ section of the resource.

                        subscribers
                        - + []SubscriberStatus @@ -535,11 +530,11 @@ section of the resource.

                        -

                        SubscriberSpec +

                        SubscriberSpec

                        (Appears on: -SubscribableSpec) +SubscribableSpec)

                        SubscriberSpec defines a single subscriber to a Subscribable.

                        @@ -605,7 +600,7 @@ knative.dev/pkg/apis.URL delivery
                        - + DeliverySpec @@ -617,12 +612,11 @@ DeliverySpec -

                        SubscriberStatus +

                        SubscriberStatus

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

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

                        @@ -663,7 +657,7 @@ int64 ready
                        - + Kubernetes core/v1.ConditionStatus @@ -687,24 +681,18 @@ string
                        -

                        eventing.knative.dev/v1

                        +

                        duck.knative.dev/v1alpha1

                        -

                        Package v1 is the v1 version of the API.

                        +

                        Package v1alpha1 is the v1alpha1 version of the API.

                        Resource Types: - -

                        Broker +
                          +

                          Channelable

                          -

                          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.

                          +

                          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.

                          @@ -716,32 +704,14 @@ Addressable endpoint.

                          - - - - - - - - @@ -750,43 +720,43 @@ Refer to the Kubernetes API documentation for the fields of the
                          -apiVersion
                          -string
                          - -eventing.knative.dev/v1 - -
                          -kind
                          -string -
                          Broker
                          metadata
                          - + Kubernetes meta/v1.ObjectMeta
                          -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                          - -BrokerSpec + +ChannelableSpec
                          -

                          Spec defines the desired state of the Broker.

                          +

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



                          -config
                          +SubscribableTypeSpec
                          -knative.dev/pkg/apis/duck/v1.KReference + +SubscribableTypeSpec +
                          -(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 SubscribableTypeSpec are embedded into this type.) +

                          delivery
                          - + DeliverySpec
                          (Optional) -

                          Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

                          +

                          DeliverySpec contains options controlling the event delivery

                          @@ -796,24 +766,24 @@ This includes things like retries, DLQ, etc.

                          status
                          - -BrokerStatus + +ChannelableStatus
                          -(Optional) -

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

                          -

                          Trigger +

                          ChannelableCombined

                          -

                          Trigger represents a request to have events delivered to a subscriber from a -Broker’s event pool.

                          +

                          ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of +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.

                          @@ -825,32 +795,14 @@ Broker’s event pool.

                          - - - - - - - - @@ -859,52 +811,60 @@ Refer to the Kubernetes API documentation for the fields of the
                          -apiVersion
                          -string
                          - -eventing.knative.dev/v1 - -
                          -kind
                          -string -
                          Trigger
                          metadata
                          - + Kubernetes meta/v1.ObjectMeta
                          -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                          - -TriggerSpec + +ChannelableCombinedSpec
                          -

                          Spec defines the desired state of the Trigger.

                          +

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



                          -broker
                          +SubscribableTypeSpec
                          -string + +SubscribableTypeSpec +
                          -

                          Broker is the broker that this trigger receives events from.

                          +

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

                          +

                          SubscribableTypeSpec is for the v1alpha1 spec compatibility.

                          -filter
                          +SubscribableSpec
                          - -TriggerFilter + +SubscribableSpec
                          -(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.

                          +

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

                          +

                          SubscribableSpec is for the v1beta1 spec compatibility.

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

                          Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.

                          +(Optional) +

                          DeliverySpec contains options controlling the event delivery

                          @@ -914,26 +874,24 @@ is required.

                          status
                          - -TriggerStatus + +ChannelableCombinedStatus
                          -(Optional) -

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

                          -

                          BrokerSpec +

                          ChannelableCombinedSpec

                          (Appears on: -Broker) +ChannelableCombined)

                          +

                          ChannelableSpec contains Spec of the Channelable object

                          @@ -945,43 +903,60 @@ date.

                          + + + +
                          -config
                          +SubscribableTypeSpec
                          -knative.dev/pkg/apis/duck/v1.KReference + +SubscribableTypeSpec +
                          -(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 SubscribableTypeSpec are embedded into this type.) +

                          +

                          SubscribableTypeSpec is for the v1alpha1 spec compatibility.

                          +
                          +SubscribableSpec
                          + + +SubscribableSpec + + +
                          +

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

                          +

                          SubscribableSpec is for the v1beta1 spec compatibility.

                          delivery
                          - + DeliverySpec
                          (Optional) -

                          Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

                          +

                          DeliverySpec contains options controlling the event delivery

                          -

                          BrokerStatus +

                          ChannelableCombinedStatus

                          (Appears on: -Broker) +ChannelableCombined)

                          -

                          BrokerStatus represents the current state of a Broker.

                          +

                          ChannelableStatus contains the Status of a Channelable object.

                          @@ -1003,78 +978,80 @@ 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 Broker 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.

                          - -
                          -address
                          +AddressStatus
                          -knative.dev/pkg/apis/duck/v1.Addressable +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
                          -

                          Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh.

                          +

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

                          +

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

                          -

                          TriggerFilter -

                          + + +SubscribableTypeStatus
                          + + +SubscribableTypeStatus + + + +

                          -(Appears on: -TriggerSpec) +(Members of SubscribableTypeStatus are embedded into this type.)

                          +

                          SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

                          + + + + +SubscribableStatus
                          + + +SubscribableStatus + + + +

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

                          - - - - - +

                          SubscribableStatus is the v1beta1 part of the Subscribers status.

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

                          +

                          ErrorChannel is set by the channel when it supports native error handling via a 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 +

                          ChannelableSpec

                          (Appears on: -Trigger) +Channelable)

                          +

                          ChannelableSpec contains Spec of the Channelable object

                          @@ -1086,52 +1063,43 @@ to indicate all strings match.

                          - - - -
                          -broker
                          +SubscribableTypeSpec
                          -string + +SubscribableTypeSpec +
                          -

                          Broker is the broker that this trigger receives events from.

                          +

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

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

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

                          +

                          DeliverySpec contains options controlling the event delivery

                          -

                          TriggerStatus +

                          ChannelableStatus

                          (Appears on: -Trigger) +Channelable)

                          -

                          TriggerStatus represents the current state of a Trigger.

                          +

                          ChannelableStatus contains the Status of a Channelable object.

                          @@ -1153,35 +1121,61 @@ 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
                          +AddressStatus
                          -knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
                          -

                          SubscriberURI is the resolved URI of the receiver for this Trigger.

                          +

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

                          +

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

                          -
                          -

                          flows.knative.dev/v1beta1

                          + + +SubscribableTypeStatus
                          + + +SubscribableTypeStatus + + + +

                          -

                          Package v1beta1 is the v1beta1 version of the API.

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

                          -Resource Types: -
                            -

                            Parallel +

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

                            + + + + +errorChannel
                            + + +Kubernetes core/v1.ObjectReference + + + + +(Optional) +

                            ErrorChannel is set by the channel when it supports native error handling via a channel

                            + + + + +

                            Resource

                            -

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

                            +

                            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.

                            @@ -1195,99 +1189,90 @@ series through Channels and Subscriptions.

                            + +
                            metadata
                            - + Kubernetes meta/v1.ObjectMeta
                            -(Optional) 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.

                            +

                            + + + + + + + + - +

                            SubscribableStatus +

                            +

                            +(Appears on: +SubscribableTypeStatus) +

                            +

                            +

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

                            +

                            +
                            FieldDescription
                            -spec
                            +subscribers
                            - -ParallelSpec - - -
                            -

                            Spec defines the desired state of the Parallel.

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

                            Branches is the list of Filter/Subscribers pairs.

                            -
                            -channelTemplate
                            - - -ChannelTemplateSpec + +[]SubscriberSpec
                            -(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 a case Subscriber gets sent to -when the case does not have a Reply

                            +

                            This is the list of subscriptions for this subscribable.

                            -
                            + + + + + +
                            FieldDescription
                            -status
                            +subscribers
                            - -ParallelStatus + +[]SubscriberStatus
                            -(Optional) -

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

                            +

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

                            -

                            ParallelBranch +

                            SubscribableType

                            -(Appears on: -ParallelSpec) -

                            -

                            +

                            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.

                            @@ -1299,66 +1284,74 @@ date.

                            - +

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

                            +
                            +
                            +
                            -filter
                            +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 + +SubscribableTypeSpec +
                            -

                            Subscriber receiving the event when the filter passes

                            -
                            + +
                            -reply
                            +subscribable
                            -knative.dev/pkg/apis/duck/v1.Destination + +Subscribable +
                            -(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
                            +status
                            - -DeliverySpec + +SubscribableTypeStatus -(Optional) -

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

                            +

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

                            -

                            ParallelBranchStatus +

                            SubscribableTypeSpec

                            (Appears on: -ParallelStatus) +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType)

                            -

                            ParallelBranchStatus represents the current state of a Parallel branch

                            +

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

                            @@ -1370,53 +1363,28 @@ Needed for Roundtripping v1alpha1 <-> v1beta1.

                            - - - - - - - -
                            -filterSubscriptionStatus
                            - - -ParallelSubscriptionStatus - - -
                            -

                            FilterSubscriptionStatus corresponds to the filter subscription status.

                            -
                            -filterChannelStatus
                            - - -ParallelChannelStatus - - -
                            -

                            FilterChannelStatus corresponds to the filter channel status.

                            -
                            -subscriberSubscriptionStatus
                            +subscribable
                            - -ParallelSubscriptionStatus + +Subscribable
                            -

                            SubscriptionStatus corresponds to the subscriber subscription status.

                            -

                            ParallelChannelStatus +

                            SubscribableTypeStatus

                            (Appears on: -ParallelBranchStatus, -ParallelStatus) +ChannelableCombinedStatus, +ChannelableStatus, +SubscribableType)

                            +

                            SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

                            @@ -1428,37 +1396,30 @@ ParallelSubscriptionStatus - - - -
                            -channel
                            +subscribableStatus
                            - -Kubernetes core/v1.ObjectReference + +SubscribableStatus
                            -

                            Channel is the reference to the underlying channel.

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

                            ReadyCondition indicates whether the Channel is ready or not.

                            -

                            ParallelSpec +

                            SubscriberSpec

                            (Appears on: -Parallel) +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

                            @@ -1470,172 +1431,98 @@ knative.dev/pkg/apis.Condition - -
                            -branches
                            +uid
                            - -[]ParallelBranch - +k8s.io/apimachinery/pkg/types.UID
                            -

                            Branches is the list of Filter/Subscribers pairs.

                            +(Optional) +

                            UID is used to understand the origin of the subscriber.

                            -channelTemplate
                            +generation
                            - -ChannelTemplateSpec - +int64
                            (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).

                            +

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

                            -reply
                            +subscriberURI
                            -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis.URL
                            (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 -

                            -

                            -(Appears on: -Parallel) -

                            -

                            -

                            ParallelStatus represents the current state of a Parallel.

                            -

                            - - - - - - - - - - - -
                            FieldDescription
                            -Status
                            +replyURI
                            -knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis.URL
                            -

                            -(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)
                            -ingressChannelStatus
                            +deadLetterSink
                            - -ParallelChannelStatus - +knative.dev/pkg/apis.URL
                            -

                            IngressChannelStatus corresponds to the ingress channel status.

                            +(Optional)
                            -branchStatuses
                            +delivery
                            - -[]ParallelBranchStatus + +DeliverySpec
                            -

                            BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches 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 Parallel. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name}

                            +(Optional)
                            -

                            ParallelSubscriptionStatus -

                            +
                            +

                            duck.knative.dev/v1beta1

                            +

                            +

                            Package v1beta1 is the v1beta1 version of the API.

                            +

                            +Resource Types: +
                              +

                              BackoffPolicyType +(string alias)

                              (Appears on: -ParallelBranchStatus) +DeliverySpec)

                              +

                              BackoffPolicyType is the type for backoff policies

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

                              Subscription is the reference to the underlying Subscription.

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

                              ReadyCondition indicates whether the Subscription is ready or not.

                              -
                              -

                              Sequence +

                              Channelable

                              -

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

                              +

                              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.

                              @@ -1649,13 +1536,12 @@ series through Channels and Subscriptions.

                              @@ -1664,55 +1550,43 @@ Refer to the Kubernetes API documentation for the fields of the
                              metadata
                              - + Kubernetes meta/v1.ObjectMeta
                              -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                              - -SequenceSpec + +ChannelableSpec
                              -

                              Spec defines the desired state of the Sequence.

                              +

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



                              - - - -
                              -steps
                              +SubscribableSpec
                              - -[]SequenceStep + +SubscribableSpec
                              -

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

                              +

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

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

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

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

                              +

                              DeliverySpec contains options controlling the event delivery

                              @@ -1722,26 +1596,26 @@ knative.dev/pkg/apis/duck/v1.Destination
                              status
                              - -SequenceStatus + +ChannelableStatus
                              -(Optional) -

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

                              -

                              SequenceChannelStatus +

                              ChannelableSpec

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

                              +

                              ChannelableSpec contains Spec of the Channelable object

                              @@ -1753,37 +1627,45 @@ date.

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

                              Channel is the reference to the underlying channel.

                              +

                              +(Members of SubscribableSpec 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

                              -

                              SequenceSpec +

                              ChannelableStatus

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

                              +

                              ChannelableStatus contains the Status of a Channelable object.

                              @@ -1795,55 +1677,82 @@ knative.dev/pkg/apis.Condition + + + +
                              -steps
                              +Status
                              - -[]SequenceStep - +knative.dev/pkg/apis/duck/v1.Status
                              -

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

                              +

                              +(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/v1.AddressStatus + +
                              +

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

                              +

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

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

                              +

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

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

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

                              +

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

                              -

                              SequenceStatus +

                              DeliverySpec

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

                              -

                              SequenceStatus represents the current state of a Sequence.

                              +

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

                              @@ -1855,73 +1764,67 @@ knative.dev/pkg/apis/duck/v1.Destination
                              -Status
                              +deadLetterSink
                              -knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.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.

                              +(Optional) +

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

                              -subscriptionStatuses
                              +retry
                              - -[]SequenceSubscriptionStatus - +int32
                              -

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

                              +(Optional) +

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

                              -channelStatuses
                              +backoffPolicy
                              - -[]SequenceChannelStatus + +BackoffPolicyType
                              -

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

                              +(Optional) +

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

                              -AddressStatus
                              +backoffDelay
                              -knative.dev/pkg/apis/duck/v1.AddressStatus +string
                              -

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

                              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 backoffDelay*. +For exponential policy, backoff delay is backoffDelay*2^.

                              -

                              SequenceStep +

                              DeliveryStatus

                              -(Appears on: -SequenceSpec) -

                              -

                              +

                              DeliveryStatus contains the Status of an object supporting delivery options.

                              @@ -1933,42 +1836,105 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

                              + + +
                              -Destination
                              +deadLetterChannel
                              -knative.dev/pkg/apis/duck/v1.Destination +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.

                              +
                              +

                              Subscribable +

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

                              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.

                              -

                              Subscriber receiving the step event

                              + + + + + + + + + + + + + + +
                              FieldDescription
                              +metadata
                              + + +Kubernetes meta/v1.ObjectMeta + + +
                              +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                              -delivery
                              +spec
                              - -DeliverySpec + +SubscribableSpec
                              -(Optional) -

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

                              +

                              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.

                              -

                              SequenceSubscriptionStatus +

                              SubscribableSpec

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

                              +

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

                              @@ -1980,47 +1946,63 @@ This includes things like retries, DLQ, etc.

                              + +
                              -subscription
                              +subscribers
                              - -Kubernetes core/v1.ObjectReference + +[]SubscriberSpec
                              -

                              Subscription is the reference to the underlying Subscription.

                              +

                              This is the list of subscriptions for this subscribable.

                              +

                              SubscribableStatus +

                              +

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

                              +

                              +

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

                              +

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

                              -
                              -

                              messaging.knative.dev/v1

                              +

                              SubscriberSpec +

                              -

                              Package v1 is the v1 version of the API.

                              +(Appears on: +SubscribableSpec)

                              -Resource Types: - -

                              Channel -

                              -

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

                              +

                              SubscriberSpec defines a single subscriber to a Subscribable.

                              +

                              At least one of SubscriberURI and ReplyURI must be present

                              @@ -2032,106 +2014,79 @@ Resource Types: - - - - - - - -
                              -apiVersion
                              -string
                              - -messaging.knative.dev/v1 - -
                              -kind
                              -string -
                              Channel
                              -metadata
                              +uid
                              - -Kubernetes meta/v1.ObjectMeta - +k8s.io/apimachinery/pkg/types.UID
                              (Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

                              UID is used to understand the origin of the subscriber.

                              -spec
                              +generation
                              - -ChannelSpec - +int64
                              -

                              Spec defines the desired state of the Channel.

                              -
                              -
                              - +(Optional) +

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

                              + + - -
                              -channelTemplate
                              +subscriberUri
                              - -ChannelTemplateSpec - +knative.dev/pkg/apis.URL
                              -

                              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.

                              +(Optional) +

                              SubscriberURI is the endpoint for the subscriber

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

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

                              -

                              Channel conforms to ChannelableSpec

                              -
                              +(Optional) +

                              ReplyURI is the endpoint for the reply

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

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

                              +

                              DeliverySpec contains options controlling the event delivery

                              -

                              InMemoryChannel +

                              SubscriberStatus

                              -

                              InMemoryChannel is a resource representing an in memory channel

                              +(Appears on: +SubscribableStatus, +SubscribableStatus)

                              - +

                              +

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

                              +

                              +
                              @@ -2141,91 +2096,67 @@ date.

                              - - - - - - - -
                              Field
                              -apiVersion
                              -string
                              - -messaging.knative.dev/v1 - -
                              -kind
                              -string -
                              InMemoryChannel
                              -metadata
                              +uid
                              - -Kubernetes meta/v1.ObjectMeta - +k8s.io/apimachinery/pkg/types.UID
                              (Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

                              UID is used to understand the origin of the subscriber.

                              -spec
                              +observedGeneration
                              - -InMemoryChannelSpec - +int64
                              -

                              Spec defines the desired state of the Channel.

                              -
                              -
                              - +(Optional) +

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

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

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

                              -

                              Channel conforms to Duck type Channelable.

                              -
                              +

                              Status of the subscriber.

                              -status
                              +message
                              - -InMemoryChannelStatus - +string
                              (Optional) -

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

                              +

                              A human readable message indicating details of Ready status.

                              -

                              Subscription +
                              +

                              flows.knative.dev/v1beta1

                              +

                              +

                              Package v1beta1 is the v1beta1 version of the API.

                              +

                              +Resource Types: +
                                +

                                Parallel

                                -

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

                                +

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

                                @@ -2237,31 +2168,15 @@ corresponds to the subscriptions.channels.knative.dev CRD.

                                - - - - - - - - @@ -2270,54 +2185,42 @@ Refer to the Kubernetes API documentation for the fields of the
                                -apiVersion
                                -string
                                - -messaging.knative.dev/v1 - -
                                -kind
                                -string -
                                Subscription
                                metadata
                                - + Kubernetes meta/v1.ObjectMeta
                                +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                                - -SubscriptionSpec + +ParallelSpec
                                +

                                Spec defines the desired state of the Parallel.



                                @@ -2329,22 +2232,8 @@ knative.dev/pkg/apis/duck/v1.Destination - - - -
                                -channel
                                +branches
                                - -Kubernetes core/v1.ObjectReference + +[]ParallelBranch
                                -

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

                                +

                                Branches is the list of Filter/Subscribers pairs.

                                -subscriber
                                +channelTemplate
                                -knative.dev/pkg/apis/duck/v1.Destination + +ChannelTemplateSpec +
                                (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.

                                +

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

                                (Optional) -

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

                                -
                                -delivery
                                - - -DeliverySpec - - -
                                -(Optional) -

                                Delivery configuration

                                +

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

                                @@ -2354,31 +2243,26 @@ DeliverySpec
                                status
                                - -SubscriptionStatus + +ParallelStatus
                                +(Optional) +

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

                                -

                                ChannelDefaulter -

                                -

                                -

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

                                -

                                -

                                ChannelSpec +

                                ParallelBranch

                                (Appears on: -Channel) +ParallelSpec)

                                -

                                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.

                                @@ -2390,91 +2274,66 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba - -
                                -channelTemplate
                                +filter
                                - -ChannelTemplateSpec - +knative.dev/pkg/apis/duck/v1.Destination
                                -

                                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.

                                +(Optional) +

                                Filter is the expression guarding the branch

                                -ChannelableSpec
                                +subscriber
                                - -ChannelableSpec - +knative.dev/pkg/apis/duck/v1.Destination
                                -

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

                                -

                                Channel conforms to ChannelableSpec

                                +

                                Subscriber receiving the event when the filter passes

                                -

                                ChannelStatus -

                                -

                                -(Appears on: -Channel) -

                                -

                                -

                                ChannelStatus represents the current state of a Channel.

                                -

                                - - - - - - - -
                                FieldDescription
                                -ChannelableStatus
                                +reply
                                - -ChannelableStatus - +knative.dev/pkg/apis/duck/v1.Destination
                                -

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

                                -

                                Channel conforms to ChannelableStatus

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

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

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

                                +(Optional) +

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

                                -

                                ChannelTemplateSpec +

                                ParallelBranchStatus

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

                                +

                                ParallelBranchStatus represents the current state of a Parallel branch

                                @@ -2486,81 +2345,53 @@ knative.dev/pkg/apis/duck/v1.KReference - -
                                -spec
                                +filterSubscriptionStatus
                                -k8s.io/apimachinery/pkg/runtime.RawExtension + +ParallelSubscriptionStatus +
                                -(Optional) -

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

                                -
                                -
                                - -
                                +

                                FilterSubscriptionStatus corresponds to the filter subscription status.

                                -

                                ChannelTemplateSpecInternal -

                                -

                                -

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

                                -

                                - - - - - - - -
                                FieldDescription
                                -metadata
                                +filterChannelStatus
                                - -Kubernetes meta/v1.ObjectMeta + +ParallelChannelStatus
                                -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

                                FilterChannelStatus corresponds to the filter channel status.

                                -spec
                                +subscriberSubscriptionStatus
                                -k8s.io/apimachinery/pkg/runtime.RawExtension + +ParallelSubscriptionStatus +
                                -(Optional) -

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

                                -
                                -
                                - -
                                +

                                SubscriptionStatus corresponds to the subscriber subscription status.

                                -

                                InMemoryChannelSpec +

                                ParallelChannelStatus

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

                                -

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

                                @@ -2572,76 +2403,37 @@ arguments for a Channel.

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

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

                                -

                                Channel conforms to Duck type Channelable.

                                +

                                Channel is the reference to the underlying channel.

                                -

                                InMemoryChannelStatus -

                                -

                                -(Appears on: -InMemoryChannel) -

                                -

                                -

                                ChannelStatus represents the current state of a Channel.

                                -

                                - - - - - - - -
                                FieldDescription
                                -ChannelableStatus
                                +ready
                                - -ChannelableStatus - +knative.dev/pkg/apis.Condition
                                -

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

                                -

                                Channel conforms to Duck type Channelable.

                                +

                                ReadyCondition indicates whether the Channel is ready or not.

                                -

                                SubscriptionSpec +

                                ParallelSpec

                                (Appears on: -Subscription) +Parallel)

                                -

                                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

                                @@ -2653,43 +2445,30 @@ channel –> reply

                                @@ -2701,34 +2480,20 @@ knative.dev/pkg/apis/duck/v1.Destination - - - -
                                -channel
                                +branches
                                - -Kubernetes core/v1.ObjectReference + +[]ParallelBranch
                                -

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

                                +

                                Branches is the list of Filter/Subscribers pairs.

                                -subscriber
                                +channelTemplate
                                -knative.dev/pkg/apis/duck/v1.Destination + +ChannelTemplateSpec +
                                (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.

                                +

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

                                (Optional) -

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

                                -
                                -delivery
                                - - -DeliverySpec - - -
                                -(Optional) -

                                Delivery configuration

                                +

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

                                -

                                SubscriptionStatus +

                                ParallelStatus

                                (Appears on: -Subscription) +Parallel)

                                -

                                SubscriptionStatus (computed) for a subscription

                                +

                                ParallelStatus represents the current state of a Parallel.

                                @@ -2756,28 +2521,56 @@ knative.dev/pkg/apis/duck/v1.Status + + + + + + + +
                                -physicalSubscription
                                +ingressChannelStatus
                                - -SubscriptionStatusPhysicalSubscription + +ParallelChannelStatus
                                -

                                PhysicalSubscription is the fully resolved values that this Subscription represents.

                                +

                                IngressChannelStatus corresponds to the ingress channel status.

                                +
                                +branchStatuses
                                + + +[]ParallelBranchStatus + + +
                                +

                                BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches 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 Parallel. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name}

                                -

                                SubscriptionStatusPhysicalSubscription +

                                ParallelSubscriptionStatus

                                (Appears on: -SubscriptionStatus) +ParallelBranchStatus)

                                -

                                SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

                                @@ -2789,58 +2582,35 @@ Subscription.

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

                                SubscriberURI is the fully resolved URI for spec.subscriber.

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

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

                                +

                                Subscription is the reference to the underlying Subscription.

                                -deadLetterSinkUri
                                +ready
                                -knative.dev/pkg/apis.URL +knative.dev/pkg/apis.Condition
                                -

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

                                +

                                ReadyCondition indicates whether the Subscription is ready or not.

                                -
                                -

                                sources.knative.dev/v1alpha2

                                -

                                -

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

                                -

                                -Resource Types: - -

                                ApiServerSource +

                                Sequence

                                -

                                ApiServerSource is the Schema for the apiserversources API

                                +

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

                                @@ -2852,31 +2622,15 @@ Resource Types: - - - - - - - - +metadata
                                + + +Kubernetes meta/v1.ObjectMeta + + + @@ -2885,90 +2639,55 @@ Refer to the Kubernetes API documentation for the fields of the
                                -apiVersion
                                -string
                                - -sources.knative.dev/v1alpha2 - -
                                -kind
                                -string -
                                ApiServerSource
                                -metadata
                                - - -Kubernetes meta/v1.ObjectMeta - - -
                                +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                                - -ApiServerSourceSpec + +SequenceSpec
                                +

                                Spec defines the desired state of the Sequence.



                                - - - - - - - -
                                -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
                                +steps
                                - -[]APIVersionKindSelector + +[]SequenceStep
                                -

                                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.

                                +

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

                                -owner
                                +channelTemplate
                                - -APIVersionKind + +ChannelTemplateSpec
                                (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

                                +

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

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

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

                                +

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

                                @@ -2978,20 +2697,26 @@ source. Defaults to default if not set.

                                status
                                - -ApiServerSourceStatus + +SequenceStatus
                                +(Optional) +

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

                                -

                                ContainerSource +

                                SequenceChannelStatus

                                -

                                ContainerSource is the Schema for the containersources API

                                +(Appears on: +SequenceStatus) +

                                +

                                @@ -3003,100 +2728,97 @@ ApiServerSourceStatus - - - - - - - - + + +
                                -apiVersion
                                -string
                                - -sources.knative.dev/v1alpha2 - -
                                -kind
                                -string -
                                ContainerSource
                                -metadata
                                +channel
                                - -Kubernetes meta/v1.ObjectMeta + +Kubernetes core/v1.ObjectReference
                                -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

                                Channel is the reference to the underlying channel.

                                -spec
                                +ready
                                - -ContainerSourceSpec - +knative.dev/pkg/apis.Condition
                                -
                                -
                                +

                                ReadyCondition indicates whether the Channel is ready or not.

                                +
                                +

                                SequenceSpec +

                                +

                                +(Appears on: +Sequence) +

                                +

                                +

                                + + + + + + + - -
                                FieldDescription
                                -SourceSpec
                                +steps
                                -knative.dev/pkg/apis/duck/v1.SourceSpec + +[]SequenceStep +
                                -

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

                                +

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

                                -template
                                +channelTemplate
                                - -Kubernetes core/v1.PodTemplateSpec + +ChannelTemplateSpec
                                -

                                Template describes the pods that will be created

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

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

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

                                -

                                PingSource +

                                SequenceStatus

                                -

                                PingSource is the Schema for the PingSources API.

                                +(Appears on: +Sequence) +

                                +

                                +

                                SequenceStatus represents the current state of a Sequence.

                                @@ -3108,118 +2830,174 @@ ContainerSourceStatus - - - - +

                                SequenceSubscriptionStatus +

                                +

                                +(Appears on: +SequenceStatus) +

                                +

                                +

                                +
                                -apiVersion
                                -string
                                - -sources.knative.dev/v1alpha2 - +Status
                                + +knative.dev/pkg/apis/duck/v1.Status +
                                -kind
                                -string +

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

                                PingSource
                                -metadata
                                +subscriptionStatuses
                                - -Kubernetes meta/v1.ObjectMeta + +[]SequenceSubscriptionStatus
                                -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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

                                -spec
                                +channelStatuses
                                - -PingSourceSpec + +[]SequenceChannelStatus
                                -
                                -
                                - +

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

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

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

                                +

                                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}

                                -schedule
                                +
                                +

                                SequenceStep +

                                +

                                +(Appears on: +SequenceSpec) +

                                +

                                +

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

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

                                +

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

                                +

                                Subscriber receiving the step event

                                -jsonData
                                +delivery
                                -string + +DeliverySpec +
                                (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”.

                                +

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

                                -
                                + + + + + + + + + +
                                FieldDescription
                                -status
                                +subscription
                                - -PingSourceStatus + +Kubernetes core/v1.ObjectReference
                                +

                                Subscription is the reference to the underlying Subscription.

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

                                ReadyCondition indicates whether the Subscription is ready or not.

                                -

                                SinkBinding +
                                +

                                sources.knative.dev/v1beta1

                                +

                                +

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

                                +

                                +Resource Types: + +

                                ApiServerSource

                                -

                                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.

                                +

                                ApiServerSource is the Schema for the apiserversources API

                                @@ -3235,7 +3013,7 @@ cloud events.

                                string @@ -3244,13 +3022,13 @@ sources.knative.dev/v1alpha2 kind
                                string - + @@ -3293,88 +3071,84 @@ and modifications of the event sent to the sink.

                                - -
                                -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1
                                SinkBindingApiServerSource
                                metadata
                                - + Kubernetes meta/v1.ObjectMeta @@ -3264,8 +3042,8 @@ Refer to the Kubernetes API documentation for the fields of the
                                spec
                                - -SinkBindingSpec + +ApiServerSourceSpec
                                -BindingSpec
                                +resources
                                -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +[]APIVersionKindSelector +
                                -

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

                                -
                                +

                                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.

                                -status
                                +owner
                                - -SinkBindingStatus + +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.

                                - - -

                                APIVersionKind -

                                -

                                -(Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) -

                                -

                                -

                                APIVersionKind is an APIVersion and Kind tuple.

                                -

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

                                +
                                -apiVersion
                                +serviceAccountName
                                string
                                -

                                APIVersion - the API version of the resource to watch.

                                +(Optional) +

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

                                +
                                -kind
                                +status
                                -string + +ApiServerSourceStatus + -

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

                                -

                                APIVersionKindSelector +

                                ContainerSource

                                -(Appears on: -ApiServerSourceSpec) -

                                -

                                -

                                APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

                                +

                                ContainerSource is the Schema for the containersources API

                                @@ -3387,61 +3161,47 @@ More info: +Kubernetes meta/v1.ObjectMeta + - - -
                                -

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

                                +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                                -selector
                                +spec
                                - -Kubernetes meta/v1.LabelSelector + +ContainerSourceSpec
                                -(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
                                @@ -3462,73 +3222,38 @@ and modifications of the event sent to the sink.

                                -resources
                                +template
                                - -[]APIVersionKindSelector + +Kubernetes core/v1.PodTemplateSpec
                                -

                                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.

                                +

                                Template describes the pods that will be created

                                +
                                -owner
                                +status
                                - -APIVersionKind + +ContainerSourceStatus -(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 +

                                PingSource

                                -(Appears on: -ApiServerSource) -

                                -

                                -

                                ApiServerSourceStatus defines the observed state of ApiServerSource

                                +

                                PingSource is the Schema for the PingSources API.

                                @@ -3540,132 +3265,48 @@ source. Defaults to default if not set.

                                +apiVersion
                                +string - -
                                -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.

                                + +sources.knative.dev/v1beta1 +
                                -

                                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.

                                +kind
                                +string
                                PingSource
                                -template
                                +metadata
                                - -Kubernetes core/v1.PodTemplateSpec + +Kubernetes meta/v1.ObjectMeta
                                -

                                Template describes the pods that will be created

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

                                ContainerSourceStatus -

                                -

                                -(Appears on: -ContainerSource) -

                                -

                                -

                                ContainerSourceStatus defines the observed state of ContainerSource

                                -

                                - - - - - - - - - - -
                                FieldDescription
                                -SourceStatus
                                +spec
                                -knative.dev/pkg/apis/duck/v1.SourceStatus + +PingSourceSpec +
                                -

                                -(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
                                @@ -3698,6 +3339,20 @@ string
                                +timezone
                                + +string + +
                                +

                                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

                                +
                                jsonData
                                string @@ -3710,55 +3365,32 @@ 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
                                +status
                                -knative.dev/pkg/apis/duck/v1.SourceStatus + +PingSourceStatus +
                                -

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

                                SinkBinding

                                -(Appears on: -SinkBinding) -

                                -

                                -

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

                                +

                                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.

                                @@ -3770,129 +3402,31 @@ Source.

                                + + + + - - -
                                -SourceSpec
                                - -knative.dev/pkg/apis/duck/v1.SourceSpec - +apiVersion
                                +string
                                + +sources.knative.dev/v1beta1 +
                                -

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

                                +kind
                                +string
                                SinkBinding
                                -BindingSpec
                                +metadata
                                -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +Kubernetes meta/v1.ObjectMeta +
                                -

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

                                -

                                - - - - - - - - - - - - - - - - - - - @@ -3901,39 +3435,47 @@ Refer to the Kubernetes API documentation for the fields of the
                                FieldDescription
                                -apiVersion
                                -string
                                - -configs.internal.knative.dev/v1alpha1 - -
                                -kind
                                -string -
                                ConfigMapPropagation
                                -metadata
                                - - -Kubernetes meta/v1.ObjectMeta - - -
                                -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                                - -ConfigMapPropagationSpec + +SinkBindingSpec
                                -

                                Spec defines the desired state of the ConfigMapPropagation



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

                                OriginalNamespace is the namespace where the original configMaps are in

                                +

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

                                -selector
                                +BindingSpec
                                - -Kubernetes meta/v1.LabelSelector - +knative.dev/pkg/apis/duck/v1beta1.BindingSpec
                                -(Optional) -

                                Selector only selects original configMaps with corresponding labels

                                +

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

                                @@ -3943,26 +3485,24 @@ Kubernetes meta/v1.LabelSelector
                                status
                                - -ConfigMapPropagationStatus + +SinkBindingStatus
                                -(Optional) -

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

                                -

                                ConfigMapPropagationSpec +

                                APIVersionKind

                                (Appears on: -ConfigMapPropagation) +ApiServerSourceSpec)

                                +

                                APIVersionKind is an APIVersion and Kind tuple.

                                @@ -3974,39 +3514,37 @@ This data may be out of date.

                                -originalNamespace
                                +apiVersion
                                string
                                -

                                OriginalNamespace is the namespace where the original configMaps are in

                                +

                                APIVersion - the API version of the resource to watch.

                                -selector
                                +kind
                                - -Kubernetes meta/v1.LabelSelector - +string
                                -(Optional) -

                                Selector only selects original configMaps with corresponding labels

                                +

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

                                -

                                ConfigMapPropagationStatus +

                                APIVersionKindSelector

                                (Appears on: -ConfigMapPropagation) +ApiServerSourceSpec)

                                -

                                ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

                                +

                                APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

                                @@ -4018,44 +3556,53 @@ Kubernetes meta/v1.LabelSelector + + + +
                                -Status
                                +apiVersion
                                -knative.dev/pkg/apis/duck/v1.Status +string
                                -

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

                                +

                                APIVersion - the API version of the resource to watch.

                                -copyConfigmaps
                                +kind
                                - -[]ConfigMapPropagationStatusCopyConfigMap +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) -

                                CopyConfigMaps is the status for each copied configmap.

                                +

                                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

                                -

                                ConfigMapPropagationStatusCopyConfigMap +

                                ApiServerSourceSpec

                                (Appears on: -ConfigMapPropagationStatus) +ApiServerSource)

                                -

                                ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

                                +

                                ApiServerSourceSpec defines the desired state of ApiServerSource

                                @@ -4067,93 +3614,91 @@ knative.dev/pkg/apis/duck/v1.Status - - - -
                                -name
                                - -string - -
                                -

                                Name is copy configmap’s name

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

                                Source is “originalNamespace/originalConfigMapName”

                                +

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

                                -operation
                                +resources
                                -string + +[]APIVersionKindSelector +
                                -

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

                                +

                                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.

                                -ready
                                +owner
                                -string + +APIVersionKind +
                                -

                                Ready represents the operation is ready or not

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

                                -reason
                                +mode
                                string
                                -

                                Reason indicates reasons if the operation is not ready

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

                                -resourceVersionFromSource
                                +serviceAccountName
                                string
                                -

                                ResourceVersion is the resourceVersion of original configmap

                                +(Optional) +

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

                                -
                                -

                                eventing.knative.dev/v1beta1

                                +

                                ApiServerSourceStatus +

                                -

                                Package v1beta1 is the v1beta1 version of the API.

                                +(Appears on: +ApiServerSource)

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

                                +

                                ApiServerSourceStatus defines the observed state of ApiServerSource

                                @@ -4165,103 +3710,342 @@ Addressable endpoint.

                                +SourceStatus
                                + +knative.dev/pkg/apis/duck/v1.SourceStatus + + + +
                                -apiVersion
                                -string
                                - -eventing.knative.dev/v1beta1 - +

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

                                Broker
                                -metadata
                                +template
                                - -Kubernetes meta/v1.ObjectMeta + +Kubernetes core/v1.PodTemplateSpec
                                -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

                                Template describes the pods that will be created

                                +

                                ContainerSourceStatus +

                                +

                                +(Appears on: +ContainerSource) +

                                +

                                +

                                ContainerSourceStatus defines the observed state of ContainerSource

                                +

                                + + + + + + + + + + +
                                FieldDescription
                                -spec
                                +SourceStatus
                                - -BrokerSpec - +knative.dev/pkg/apis/duck/v1.SourceStatus
                                -

                                Spec defines the desired state of the Broker.

                                -
                                -
                                +

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

                                Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap.

                                +

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

                                -delivery
                                +timezone
                                - -DeliverySpec - +string + +
                                +

                                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

                                +
                                +jsonData
                                + +string
                                (Optional) -

                                Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.

                                +

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

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

                                +

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

                                -

                                EventType +

                                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.

                                +
                                +
                                +

                                eventing.knative.dev/v1

                                +

                                +

                                Package v1 is the v1 version of the API.

                                +

                                +Resource Types: + +

                                Broker

                                -

                                EventType represents a type of event that can be consumed from a 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. Subscribers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.

                                @@ -4277,7 +4061,7 @@ date.

                                string @@ -4286,13 +4070,13 @@ eventing.knative.dev/v1beta1 kind
                                string - +
                                -eventing.knative.dev/v1beta1 +eventing.knative.dev/v1
                                EventTypeBroker
                                metadata
                                - + Kubernetes meta/v1.ObjectMeta @@ -4307,89 +4091,43 @@ Refer to the Kubernetes API documentation for the fields of the
                                spec
                                - -EventTypeSpec + +BrokerSpec
                                -

                                Spec defines the desired state of the EventType.

                                +

                                Spec defines the desired state of the Broker.



                                - - - - - - - - - - - - - - - -
                                -type
                                - -string - -
                                -

                                Type represents the CloudEvents type. It is authoritative.

                                -
                                -source
                                - -knative.dev/pkg/apis.URL - -
                                -(Optional) -

                                Source is a URI, it represents the CloudEvents source.

                                -
                                -schema
                                - -knative.dev/pkg/apis.URL - -
                                -(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
                                - -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
                                +config
                                -string +knative.dev/pkg/apis/duck/v1.KReference
                                (Optional) -

                                TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType.

                                +

                                Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.

                                -description
                                +delivery
                                -string + +DeliverySpec +
                                (Optional) -

                                Description is an optional field used to describe the EventType, in any meaningful way.

                                +

                                Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.

                                @@ -4399,24 +4137,23 @@ string
                                status
                                - -EventTypeStatus + +BrokerStatus
                                (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

                                +

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

                                -

                                Trigger +

                                Trigger

                                -

                                Trigger represents a request to have events delivered to a consumer from a +

                                Trigger represents a request to have events delivered to a subscriber from a Broker’s event pool.

                                @@ -4433,7 +4170,7 @@ Broker’s event pool.

                                string @@ -4448,7 +4185,7 @@ string
                                -eventing.knative.dev/v1beta1 +eventing.knative.dev/v1
                                metadata
                                - + Kubernetes meta/v1.ObjectMeta @@ -4463,7 +4200,7 @@ Refer to the Kubernetes API documentation for the fields of the
                                spec
                                - + TriggerSpec @@ -4481,15 +4218,14 @@ string
                                -

                                Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

                                +

                                Broker is the broker that this trigger receives events from.

                                filter
                                - + TriggerFilter @@ -4519,7 +4255,7 @@ is required.

                                status
                                - + TriggerStatus @@ -4532,11 +4268,11 @@ date.

                                -

                                BrokerSpec +

                                BrokerSpec

                                (Appears on: -Broker) +Broker)

                                @@ -4566,7 +4302,7 @@ a pointer to a ConfigMap.

                                delivery
                                - + DeliverySpec @@ -4579,154 +4315,14 @@ This includes things like retries, DLQ, etc.

                                -

                                BrokerStatus -

                                -

                                -(Appears on: -Broker) -

                                -

                                -

                                BrokerStatus represents the current state of a Broker.

                                -

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

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

                                -

                                -(Appears on: -EventType) -

                                -

                                -

                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                FieldDescription
                                -type
                                - -string - -
                                -

                                Type represents the CloudEvents type. It is authoritative.

                                -
                                -source
                                - -knative.dev/pkg/apis.URL - -
                                -(Optional) -

                                Source is a URI, it represents the CloudEvents source.

                                -
                                -schema
                                - -knative.dev/pkg/apis.URL - -
                                -(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
                                - -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
                                - -string - -
                                -(Optional) -

                                TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType.

                                -
                                -description
                                - -string - -
                                -(Optional) -

                                Description is an optional field used to describe the EventType, in any meaningful way.

                                -
                                -

                                EventTypeStatus +

                                BrokerStatus

                                (Appears on: -EventType) +Broker)

                                -

                                EventTypeStatus represents the current state of a EventType.

                                +

                                BrokerStatus represents the current state of a Broker.

                                @@ -4748,17 +4344,29 @@ 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. +* ObservedGeneration - the ‘Generation’ of the Broker that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.

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

                                +
                                -

                                TriggerFilter +

                                TriggerFilter

                                (Appears on: -TriggerSpec) +TriggerSpec)

                                @@ -4774,7 +4382,7 @@ knative.dev/pkg/apis/duck/v1.Status attributes
                                - + TriggerFilterAttributes @@ -4790,22 +4398,22 @@ specified values.

                                -

                                TriggerFilterAttributes +

                                TriggerFilterAttributes (map[string]string alias)

                                (Appears on: -TriggerFilter) +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 +

                                TriggerSpec

                                (Appears on: -Trigger) +Trigger)

                                @@ -4825,15 +4433,14 @@ string -

                                Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

                                +

                                Broker is the broker that this trigger receives events from.

                                filter
                                - + TriggerFilter @@ -4858,11 +4465,11 @@ is required.

                                -

                                TriggerStatus +

                                TriggerStatus

                                (Appears on: -Trigger) +Trigger)

                                TriggerStatus represents the current state of a Trigger.

                                @@ -4887,7 +4494,7 @@ 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. +* ObservedGeneration - the ‘Generation’ of the Trigger that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.

                                @@ -4951,7 +4558,7 @@ string metadata
                                - + Kubernetes meta/v1.ObjectMeta @@ -5102,7 +4709,7 @@ string metadata
                                - + Kubernetes meta/v1.ObjectMeta @@ -5147,7 +4754,7 @@ and modifications of the event sent to the sink.

                                template
                                - + Kubernetes core/v1.PodTemplateSpec @@ -5212,7 +4819,7 @@ string metadata
                                - + Kubernetes meta/v1.ObjectMeta @@ -5372,7 +4979,7 @@ More info: + Kubernetes meta/v1.LabelSelector @@ -5560,7 +5167,7 @@ and modifications of the event sent to the sink.

                                template
                                - + Kubernetes core/v1.PodTemplateSpec @@ -5703,17 +5310,20 @@ Source.


                                -

                                flows.knative.dev/v1

                                +

                                sources.knative.dev/v1alpha1

                                -

                                Package v1 is the v1 version of the API.

                                +

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

                                Resource Types: -
                                  -

                                  Parallel + +

                                  ApiServerSource

                                  -

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

                                  +

                                  ApiServerSource is the Schema for the apiserversources API

                                  @@ -5725,15 +5335,31 @@ series through Channels and Subscriptions.

                                  + + + + + + + + @@ -5742,55 +5368,93 @@ Refer to the Kubernetes API documentation for the fields of the
                                  +apiVersion
                                  +string
                                  + +sources.knative.dev/v1alpha1 + +
                                  +kind
                                  +string +
                                  ApiServerSource
                                  metadata
                                  - + Kubernetes meta/v1.ObjectMeta
                                  -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                                  - -ParallelSpec + +ApiServerSourceSpec
                                  -

                                  Spec defines the desired state of the Parallel.



                                  + + + + + + + + + + + +
                                  -branches
                                  +resources
                                  - -[]ParallelBranch + +[]ApiServerResource
                                  -

                                  Branches is the list of Filter/Subscribers pairs.

                                  +

                                  Resources is the list of resources to watch

                                  -channelTemplate
                                  +serviceAccountName
                                  - -ChannelTemplateSpec - +string
                                  (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).

                                  +

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

                                  -reply
                                  +sink
                                  -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1beta1.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

                                  +

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

                                  +
                                  +ceOverrides
                                  + +knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +
                                  +(Optional) +

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

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

                                  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.

                                  @@ -5800,26 +5464,25 @@ when the case does not have a Reply

                                  status
                                  - -ParallelStatus + +ApiServerSourceStatus
                                  -(Optional) -

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

                                  -

                                  ParallelBranch +

                                  SinkBinding

                                  -(Appears on: -ParallelSpec) -

                                  -

                                  +

                                  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.

                                  @@ -5831,123 +5494,184 @@ date.

                                  + + + + + + + +
                                  -filter
                                  +apiVersion
                                  +string
                                  + +sources.knative.dev/v1alpha1 + +
                                  +kind
                                  +string +
                                  SinkBinding
                                  +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 + +SinkBindingSpec +
                                  -

                                  Subscriber receiving the event when the filter passes

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

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

                                  -reply
                                  +BindingSpec
                                  -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
                                  -(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 BindingSpec are embedded into this type.) +

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

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

                                  -

                                  ParallelBranchStatus +

                                  ApiServerResource

                                  (Appears on: -ParallelStatus) +ApiServerSourceSpec)

                                  -

                                  ParallelBranchStatus represents the current state of a Parallel branch

                                  +

                                  ApiServerResource defines the resource to watch

                                  - - + + + + + + + + + + + + - -
                                  FieldDescriptionFieldDescription
                                  +apiVersion
                                  + +string + +
                                  +

                                  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

                                  +
                                  -filterSubscriptionStatus
                                  +labelSelector
                                  - -ParallelSubscriptionStatus + +Kubernetes meta/v1.LabelSelector
                                  -

                                  FilterSubscriptionStatus corresponds to the filter subscription status.

                                  +

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

                                  -filterChannelStatus
                                  +controllerSelector
                                  - -ParallelChannelStatus + +Kubernetes meta/v1.OwnerReference
                                  -

                                  FilterChannelStatus corresponds to the filter channel status.

                                  +

                                  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.

                                  -subscriberSubscriptionStatus
                                  +controller
                                  - -ParallelSubscriptionStatus - +bool
                                  -

                                  SubscriptionStatus corresponds to the subscriber subscription status.

                                  +

                                  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.

                                  -

                                  ParallelChannelStatus +

                                  ApiServerSourceSpec

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

                                  +

                                  ApiServerSourceSpec defines the desired state of ApiServerSource

                                  @@ -5959,97 +5683,94 @@ ParallelSubscriptionStatus - -
                                  -channel
                                  +resources
                                  - -Kubernetes core/v1.ObjectReference + +[]ApiServerResource
                                  -

                                  Channel is the reference to the underlying channel.

                                  +

                                  Resources is the list of resources to watch

                                  -ready
                                  +serviceAccountName
                                  -knative.dev/pkg/apis.Condition +string
                                  -

                                  ReadyCondition indicates whether the Channel is ready or not.

                                  +(Optional) +

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

                                  -

                                  ParallelSpec -

                                  -

                                  -(Appears on: -Parallel) -

                                  -

                                  -

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

                                  +
                                  -branches
                                  +ceOverrides
                                  - -[]ParallelBranch - +knative.dev/pkg/apis/duck/v1.CloudEventOverrides
                                  -

                                  Branches is the list of Filter/Subscribers pairs.

                                  +(Optional) +

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

                                  -channelTemplate
                                  +owner
                                  - -ChannelTemplateSpec + +APIVersionKind
                                  (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).

                                  +

                                  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.

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

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

                                  +

                                  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.

                                  -

                                  ParallelStatus +

                                  ApiServerSourceStatus

                                  (Appears on: -Parallel) +ApiServerSource)

                                  -

                                  ParallelStatus represents the current state of a Parallel.

                                  +

                                  ApiServerSourceStatus defines the observed state of ApiServerSource

                                  @@ -6061,72 +5782,79 @@ when the case does not have a Reply

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

                                  +

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

                                  +

                                  + + - - + + + +
                                  -ingressChannelStatus
                                  - - -ParallelChannelStatus - - -
                                  -

                                  IngressChannelStatus corresponds to the ingress channel status.

                                  -
                                  FieldDescription
                                  -branchStatuses
                                  +SourceSpec
                                  - -[]ParallelBranchStatus - +knative.dev/pkg/apis/duck/v1.SourceSpec
                                  -

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

                                  +

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

                                  -AddressStatus
                                  +BindingSpec
                                  -knative.dev/pkg/apis/duck/v1.AddressStatus +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec

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

                                  SinkBindingStatus

                                  (Appears on: -ParallelBranchStatus) +SinkBinding)

                                  +

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

                                  @@ -6138,35 +5866,40 @@ 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
                                  +SourceStatus
                                  -knative.dev/pkg/apis.Condition +knative.dev/pkg/apis/duck/v1.SourceStatus
                                  -

                                  ReadyCondition indicates whether the Subscription is ready or not.

                                  +

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

                                  -

                                  Sequence +
                                  +

                                  eventing.knative.dev/v1beta1

                                  +

                                  +

                                  Package v1beta1 is the v1beta1 version of the API.

                                  +

                                  +Resource Types: + +

                                  Broker

                                  -

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

                                  +

                                  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.

                                  @@ -6178,9 +5911,26 @@ series through Channels and Subscriptions.

                                  + + + + + + + +
                                  +apiVersion
                                  +string
                                  + +eventing.knative.dev/v1beta1 + +
                                  +kind
                                  +string +
                                  Broker
                                  metadata
                                  - + Kubernetes meta/v1.ObjectMeta @@ -6195,55 +5945,43 @@ Refer to the Kubernetes API documentation for the fields of the
                                  spec
                                  - -SequenceSpec + +BrokerSpec
                                  -

                                  Spec defines the desired state of the Sequence.

                                  +

                                  Spec defines the desired state of the Broker.



                                  - - - -
                                  -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
                                  +config
                                  - -ChannelTemplateSpec - +knative.dev/pkg/apis/duck/v1.KReference
                                  (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).

                                  +

                                  Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.

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

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

                                  +

                                  Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.

                                  @@ -6253,26 +5991,23 @@ knative.dev/pkg/apis/duck/v1.Destination
                                  status
                                  - -SequenceStatus + +BrokerStatus
                                  (Optional) -

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

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

                                  -

                                  SequenceChannelStatus +

                                  EventType

                                  -(Appears on: -SequenceStatus) -

                                  -

                                  +

                                  EventType represents a type of event that can be consumed from a Broker.

                                  @@ -6284,274 +6019,151 @@ date.

                                  - - - - +apiVersion
                                  +string - -
                                  -channel
                                  - - -Kubernetes core/v1.ObjectReference - - -
                                  -

                                  Channel is the reference to the underlying channel.

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

                                  ReadyCondition indicates whether the Channel is ready or not.

                                  + +eventing.knative.dev/v1beta1 +
                                  -

                                  SequenceSpec -

                                  -

                                  -(Appears on: -Sequence) -

                                  -

                                  -

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

                                  +kind
                                  +string
                                  EventType
                                  -channelTemplate
                                  +metadata
                                  - -ChannelTemplateSpec + +Kubernetes meta/v1.ObjectMeta
                                  (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).

                                  +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                                  -reply
                                  +spec
                                  -knative.dev/pkg/apis/duck/v1.Destination + +EventTypeSpec +
                                  -(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.

                                  -

                                  +

                                  Spec defines the desired state of the EventType.

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

                                  -
                                  -subscriptionStatuses
                                  +type
                                  - -[]SequenceSubscriptionStatus - +string
                                  -

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

                                  +

                                  Type represents the CloudEvents type. It is authoritative.

                                  -channelStatuses
                                  +source
                                  - -[]SequenceChannelStatus - +knative.dev/pkg/apis.URL
                                  -

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

                                  +(Optional) +

                                  Source is a URI, it represents the CloudEvents source.

                                  -AddressStatus
                                  +schema
                                  -knative.dev/pkg/apis/duck/v1.AddressStatus +knative.dev/pkg/apis.URL
                                  -

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

                                  Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.

                                  -

                                  SequenceStep -

                                  -

                                  -(Appears on: -SequenceSpec) -

                                  -

                                  -

                                  - - - - - - - - - -
                                  FieldDescription
                                  -Destination
                                  +schemaData
                                  -knative.dev/pkg/apis/duck/v1.Destination +string
                                  -

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

                                  -

                                  Subscriber receiving the step event

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

                                  -delivery
                                  +broker
                                  - -DeliverySpec - +string
                                  (Optional) -

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

                                  +

                                  TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

                                  -

                                  SequenceSubscriptionStatus -

                                  -

                                  -(Appears on: -SequenceStatus) -

                                  -

                                  -

                                  - - - - - - - - + +
                                  FieldDescription
                                  -subscription
                                  +description
                                  - -Kubernetes core/v1.ObjectReference - +string
                                  -

                                  Subscription is the reference to the underlying Subscription.

                                  +(Optional) +

                                  Description is an optional field used to describe the EventType, in any meaningful way.

                                  +
                                  -ready
                                  +status
                                  -knative.dev/pkg/apis.Condition + +EventTypeStatus + -

                                  ReadyCondition indicates whether the Subscription is ready or not.

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

                                  -
                                  -

                                  messaging.knative.dev/v1beta1

                                  -

                                  -

                                  Package v1beta1 is the v1beta1 version of the API.

                                  -

                                  -Resource Types: - -

                                  Channel +

                                  Trigger

                                  -

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

                                  +

                                  Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.

                                  @@ -6567,7 +6179,7 @@ Resource Types: string @@ -6576,13 +6188,13 @@ messaging.knative.dev/v1beta1 kind
                                  string - +
                                  -messaging.knative.dev/v1beta1 +eventing.knative.dev/v1beta1
                                  ChannelTrigger
                                  metadata
                                  - + Kubernetes meta/v1.ObjectMeta @@ -6597,44 +6209,53 @@ Refer to the Kubernetes API documentation for the fields of the
                                  spec
                                  - -ChannelSpec + +TriggerSpec
                                  -

                                  Spec defines the desired state of the Channel.

                                  +

                                  Spec defines the desired state of the Trigger.



                                  + + + +
                                  -channelTemplate
                                  +broker
                                  - -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.

                                  +

                                  Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

                                  -ChannelableSpec
                                  +filter
                                  - -ChannelableSpec + +TriggerFilter
                                  -

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

                                  -

                                  Channel conforms to ChannelableSpec

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

                                  @@ -6644,23 +6265,26 @@ ChannelableSpec
                                  status
                                  - -ChannelStatus + +TriggerStatus
                                  (Optional) -

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

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

                                  -

                                  InMemoryChannel +

                                  BrokerSpec

                                  -

                                  InMemoryChannel is a resource representing an in memory channel

                                  +(Appears on: +Broker) +

                                  +

                                  @@ -6672,91 +6296,89 @@ date.

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

                                  Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.

                                  -spec
                                  +delivery
                                  - -InMemoryChannelSpec + +DeliverySpec
                                  -

                                  Spec defines the desired state of the Channel.

                                  -
                                  -
                                  +(Optional) +

                                  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
                                  -ChannelableSpec
                                  +Status
                                  - -ChannelableSpec - +knative.dev/pkg/apis/duck/v1.Status

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

                                  -

                                  Channel conforms to Duck type Channelable.

                                  -
                                  +

                                  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.

                                  -status
                                  +address
                                  - -InMemoryChannelStatus - +knative.dev/pkg/apis/duck/v1.Addressable -(Optional) -

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

                                  +

                                  Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh.

                                  -

                                  Subscription +

                                  EventTypeSpec

                                  -

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

                                  +(Appears on: +EventType) +

                                  +

                                  @@ -6768,148 +6390,170 @@ corresponds to the subscriptions.channels.knative.dev CRD.

                                  - - - - +

                                  TriggerFilter +

                                  +

                                  +(Appears on: +TriggerSpec) +

                                  +

                                  +

                                  +
                                  -apiVersion
                                  -string
                                  - -messaging.knative.dev/v1beta1 - +type
                                  + +string +
                                  -kind
                                  -string +

                                  Type represents the CloudEvents type. It is authoritative.

                                  Subscription
                                  -metadata
                                  +source
                                  - -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis.URL
                                  -Refer to the Kubernetes API documentation for the fields of the -metadata field. +(Optional) +

                                  Source is a URI, it represents the CloudEvents source.

                                  -spec
                                  +schema
                                  - -SubscriptionSpec - +knative.dev/pkg/apis.URL
                                  -
                                  -
                                  - +(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.

                                  + + + +
                                  -channel
                                  +schemaData
                                  - -Kubernetes core/v1.ObjectReference - +string
                                  -

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

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

                                  -subscriber
                                  +broker
                                  -knative.dev/pkg/apis/duck/v1.Destination +string
                                  (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.

                                  +

                                  TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

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

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

                                  +

                                  Description is an optional field used to describe the EventType, in any meaningful way.

                                  +

                                  EventTypeStatus +

                                  +

                                  +(Appears on: +EventType) +

                                  +

                                  +

                                  EventTypeStatus represents the current state of a EventType.

                                  +

                                  + + + + + + + + +
                                  FieldDescription
                                  -delivery
                                  +Status
                                  - -DeliverySpec - +knative.dev/pkg/apis/duck/v1.Status
                                  -(Optional) -

                                  Delivery configuration

                                  +

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

                                  -
                                  + + + + + +
                                  FieldDescription
                                  -status
                                  +attributes
                                  - -SubscriptionStatus + +TriggerFilterAttributes
                                  +(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.

                                  -

                                  ChannelDefaulter -

                                  +

                                  TriggerFilterAttributes +(map[string]string alias)

                                  -

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

                                  +(Appears on: +TriggerFilter)

                                  -

                                  ChannelSpec +

                                  +

                                  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: -Channel) +Trigger)

                                  -

                                  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.

                                  @@ -6921,44 +6565,53 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba + + + +
                                  -channelTemplate
                                  +broker
                                  - -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.

                                  +

                                  Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

                                  -ChannelableSpec
                                  +filter
                                  - -ChannelableSpec + +TriggerFilter
                                  -

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

                                  -

                                  Channel conforms to ChannelableSpec

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

                                  -

                                  ChannelStatus +

                                  TriggerStatus

                                  (Appears on: -Channel) +Trigger)

                                  -

                                  ChannelStatus represents the current state of a Channel.

                                  +

                                  TriggerStatus represents the current state of a Trigger.

                                  @@ -6970,42 +6623,50 @@ ChannelableSpec
                                  -ChannelableStatus
                                  +Status
                                  - -ChannelableStatus - +knative.dev/pkg/apis/duck/v1.Status

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

                                  -

                                  Channel conforms to ChannelableStatus

                                  +

                                  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.

                                  -channel
                                  +subscriberUri
                                  -knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis.URL
                                  -

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

                                  +

                                  SubscriberURI is the resolved URI of the receiver for this Trigger.

                                  -

                                  ChannelTemplateSpec -

                                  +
                                  +

                                  messaging.knative.dev/v1

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

                                  Package v1 is the v1 version of the API.

                                  +Resource Types: + +

                                  Channel +

                                  +

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

                                  @@ -7017,28 +6678,104 @@ knative.dev/pkg/apis/duck/v1.KReference + + + + + + + + + + + + + + + +
                                  -spec
                                  +apiVersion
                                  +string
                                  + +messaging.knative.dev/v1 + +
                                  +kind
                                  +string +
                                  Channel
                                  +metadata
                                  -k8s.io/apimachinery/pkg/runtime.RawExtension + +Kubernetes meta/v1.ObjectMeta +
                                  (Optional) -

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

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

                                  Spec defines the desired state of the Channel.



                                  + + + + + + + +
                                  +channelTemplate
                                  + + +ChannelTemplateSpec + + +
                                  +

                                  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.

                                  +
                                  +ChannelableSpec
                                  + + +ChannelableSpec + + +
                                  +

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

                                  +

                                  Channel conforms to ChannelableSpec

                                  +
                                  +status
                                  + + +ChannelStatus + + +
                                  +(Optional) +

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

                                  +
                                  -

                                  ChannelTemplateSpecInternal +

                                  InMemoryChannel

                                  -

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

                                  +

                                  InMemoryChannel is a resource representing an in memory channel

                                  @@ -7050,9 +6787,26 @@ we can easily create new Channels off of it.

                                  + + + + + + + + - - -
                                  +apiVersion
                                  +string
                                  + +messaging.knative.dev/v1 + +
                                  +kind
                                  +string +
                                  InMemoryChannel
                                  metadata
                                  - + Kubernetes meta/v1.ObjectMeta @@ -7067,45 +6821,21 @@ Refer to the Kubernetes API documentation for the fields of the
                                  spec
                                  -k8s.io/apimachinery/pkg/runtime.RawExtension + +InMemoryChannelSpec +
                                  -(Optional) -

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

                                  +

                                  Spec defines the desired state of the Channel.



                                  -
                                  -
                                  -

                                  InMemoryChannelSpec -

                                  -

                                  -(Appears on: -InMemoryChannel) -

                                  -

                                  -

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

                                  -

                                  - - - - - - - - -
                                  FieldDescription
                                  ChannelableSpec
                                  - + ChannelableSpec @@ -7117,62 +6847,31 @@ ChannelableSpec

                                  Channel conforms to Duck type Channelable.

                                  -

                                  InMemoryChannelStatus -

                                  -

                                  -(Appears on: -InMemoryChannel) -

                                  -

                                  -

                                  ChannelStatus represents the current state of a Channel.

                                  -

                                  - - - - - + - -
                                  FieldDescription
                                  -ChannelableStatus
                                  +status
                                  - -ChannelableStatus + +InMemoryChannelStatus
                                  -

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

                                  -

                                  Channel conforms to Duck type Channelable.

                                  +(Optional) +

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

                                  -

                                  SubscriptionSpec +

                                  Subscription

                                  -(Appears on: -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

                                  +

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

                                  @@ -7184,9 +6883,53 @@ channel –> reply

                                  + + + + + + + + + + + + + +

                                  InMemoryChannelSpec +

                                  +

                                  +(Appears on: +InMemoryChannel) +

                                  +

                                  +

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

                                  +

                                  +
                                  +apiVersion
                                  +string
                                  + +messaging.knative.dev/v1 + +
                                  +kind
                                  +string +
                                  Subscription
                                  +metadata
                                  + + +Kubernetes meta/v1.ObjectMeta + + +
                                  +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
                                  +spec
                                  + + +SubscriptionSpec + + +
                                  +
                                  +
                                  + + + -
                                  channel
                                  - + Kubernetes core/v1.ObjectReference @@ -7240,7 +6983,7 @@ the Subscriber target.

                                  delivery
                                  - + DeliverySpec @@ -7250,124 +6993,38 @@ DeliverySpec

                                  Delivery configuration

                                  -

                                  SubscriptionStatus -

                                  -

                                  -(Appears on: -Subscription) -

                                  -

                                  -

                                  SubscriptionStatus (computed) for a subscription

                                  -

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

                                  -physicalSubscription
                                  +status
                                  - -SubscriptionStatusPhysicalSubscription + +SubscriptionStatus
                                  -

                                  PhysicalSubscription is the fully resolved values that this Subscription represents.

                                  -

                                  SubscriptionStatusPhysicalSubscription +

                                  ChannelDefaulter

                                  -(Appears on: -SubscriptionStatus) -

                                  -

                                  -

                                  SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

                                  -

                                  - - - - - - - - - - - - - - - - - - - - - -
                                  FieldDescription
                                  -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/v1alpha1

                                  -

                                  -

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

                                  -

                                  -Resource Types: - -

                                  ApiServerSource +

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

                                  +

                                  +

                                  ChannelSpec

                                  -

                                  ApiServerSource is the Schema for the apiserversources API

                                  +(Appears on: +Channel) +

                                  +

                                  +

                                  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.

                                  @@ -7379,154 +7036,212 @@ Resource Types: - - - - - - - - + + +
                                  -apiVersion
                                  -string
                                  - -sources.knative.dev/v1alpha1 - -
                                  -kind
                                  -string -
                                  ApiServerSource
                                  -metadata
                                  +channelTemplate
                                  - -Kubernetes meta/v1.ObjectMeta + +ChannelTemplateSpec
                                  -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

                                  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.

                                  -spec
                                  +ChannelableSpec
                                  - -ApiServerSourceSpec + +ChannelableSpec
                                  -
                                  -
                                  +

                                  +(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
                                  -resources
                                  +ChannelableStatus
                                  - -[]ApiServerResource + +ChannelableStatus
                                  -

                                  Resources is the list of resources to watch

                                  +

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

                                  +

                                  Channel conforms to ChannelableStatus

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

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

                                  +

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

                                  +

                                  ChannelTemplateSpec +

                                  +

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

                                  +

                                  +

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

                                  -
                                  FieldDescription
                                  -ceOverrides
                                  +spec
                                  -knative.dev/pkg/apis/duck/v1.CloudEventOverrides +k8s.io/apimachinery/pkg/runtime.RawExtension
                                  (Optional) -

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

                                  +

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

                                  +
                                  +
                                  + +
                                  +

                                  ChannelTemplateSpecInternal +

                                  +

                                  +

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

                                  +

                                  + + + + + + + + +
                                  FieldDescription
                                  -owner
                                  +metadata
                                  - -APIVersionKind + +Kubernetes meta/v1.ObjectMeta
                                  (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.

                                  +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                                  -mode
                                  +spec
                                  -string +k8s.io/apimachinery/pkg/runtime.RawExtension
                                  -

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

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

                                  +
                                  +
                                  + +
                                  -
                                  + + + + + +
                                  FieldDescription
                                  -status
                                  +ChannelableSpec
                                  - -ApiServerSourceStatus + +ChannelableSpec
                                  +

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

                                  +

                                  Channel conforms to Duck type Channelable.

                                  -

                                  SinkBinding +

                                  InMemoryChannelStatus

                                  -

                                  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.

                                  +(Appears on: +InMemoryChannel) +

                                  +

                                  +

                                  ChannelStatus represents the current state of a Channel.

                                  @@ -7538,99 +7253,128 @@ cloud events.

                                  - - - - + +
                                  -apiVersion
                                  -string
                                  - -sources.knative.dev/v1alpha1 - +ChannelableStatus
                                  + + +ChannelableStatus + +
                                  -kind
                                  -string +

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

                                  +

                                  Channel conforms to Duck type Channelable.

                                  SinkBinding
                                  +

                                  SubscriptionSpec +

                                  +

                                  +(Appears on: +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

                                  +

                                  + + + + + + + + -
                                  FieldDescription
                                  -metadata
                                  +channel
                                  - -Kubernetes meta/v1.ObjectMeta + +Kubernetes core/v1.ObjectReference
                                  -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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

                                  -spec
                                  - - -SinkBindingSpec - - -
                                  -
                                  -
                                  - - - - -
                                  -SourceSpec
                                  +subscriber
                                  -knative.dev/pkg/apis/duck/v1.SourceSpec +knative.dev/pkg/apis/duck/v1.Destination
                                  -

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

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

                                  -BindingSpec
                                  +reply
                                  -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +knative.dev/pkg/apis/duck/v1.Destination
                                  -

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

                                  -
                                  +(Optional) +

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

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

                                  Delivery configuration

                                  -

                                  ApiServerResource +

                                  SubscriptionStatus

                                  (Appears on: -ApiServerSourceSpec) +Subscription)

                                  -

                                  ApiServerResource defines the resource to watch

                                  +

                                  SubscriptionStatus (computed) for a subscription

                                  @@ -7642,80 +7386,105 @@ SinkBindingStatus + +
                                  -apiVersion
                                  +Status
                                  -string +knative.dev/pkg/apis/duck/v1.Status
                                  -

                                  API version of the resource to watch.

                                  +

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

                                  -kind
                                  +physicalSubscription
                                  -string + +SubscriptionStatusPhysicalSubscription +
                                  -

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

                                  +

                                  PhysicalSubscription is the fully resolved values that this Subscription represents.

                                  +

                                  SubscriptionStatusPhysicalSubscription +

                                  +

                                  +(Appears on: +SubscriptionStatus) +

                                  +

                                  +

                                  SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

                                  +

                                  + + + + + + + +
                                  FieldDescription
                                  -labelSelector
                                  +subscriberUri
                                  - -Kubernetes meta/v1.LabelSelector - +knative.dev/pkg/apis.URL
                                  -

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

                                  +

                                  SubscriberURI is the fully resolved URI for spec.subscriber.

                                  -controllerSelector
                                  +replyUri
                                  - -Kubernetes meta/v1.OwnerReference - +knative.dev/pkg/apis.URL
                                  -

                                  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.

                                  +

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

                                  -controller
                                  +deadLetterSinkUri
                                  -bool +knative.dev/pkg/apis.URL
                                  -

                                  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.

                                  +

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

                                  -

                                  ApiServerSourceSpec -

                                  +
                                  +

                                  messaging.knative.dev/v1beta1

                                  -(Appears on: -ApiServerSource) +

                                  Package v1beta1 is the v1beta1 version of the API.

                                  +Resource Types: + +

                                  Channel +

                                  -

                                  ApiServerSourceSpec defines the desired state of ApiServerSource

                                  +

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

                                  @@ -7727,133 +7496,104 @@ v1alpha2, please use Spec.Owner as a GKV.

                                  +apiVersion
                                  +string - + - +

                                  Spec defines the desired state of the Channel.

                                  +
                                  +
                                  +
                                  -resources
                                  - - -[]ApiServerResource - - -
                                  -

                                  Resources is the list of resources to watch

                                  + +messaging.knative.dev/v1beta1 +
                                  -serviceAccountName
                                  - +kind
                                  string -
                                  -
                                  -(Optional) -

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

                                  Channel
                                  -sink
                                  +metadata
                                  -knative.dev/pkg/apis/duck/v1beta1.Destination + +Kubernetes meta/v1.ObjectMeta +
                                  (Optional) -

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

                                  +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                                  -ceOverrides
                                  +spec
                                  -knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +ChannelSpec +
                                  -(Optional) -

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

                                  -
                                  -
                                  -owner
                                  +channelTemplate
                                  - -APIVersionKind + +ChannelTemplateSpec
                                  -(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.

                                  +

                                  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.

                                  -mode
                                  +ChannelableSpec
                                  -string + +ChannelableSpec +
                                  -

                                  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.

                                  +

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

                                  +

                                  Channel conforms to ChannelableSpec

                                  -

                                  ApiServerSourceStatus -

                                  -

                                  -(Appears on: -ApiServerSource) -

                                  -

                                  -

                                  ApiServerSourceStatus defines the observed state of ApiServerSource

                                  -

                                  - - - - - + - -
                                  FieldDescription
                                  -SourceStatus
                                  +status
                                  -knative.dev/pkg/apis/duck/v1.SourceStatus + +ChannelStatus +
                                  -

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

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

                                  -

                                  SinkBindingSpec +

                                  InMemoryChannel

                                  -(Appears on: -SinkBinding) -

                                  -

                                  -

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

                                  +

                                  InMemoryChannel is a resource representing an in memory channel

                                  @@ -7865,86 +7605,91 @@ Source.

                                  + + + + + + + + + +
                                  -SourceSpec
                                  +apiVersion
                                  +string
                                  + +messaging.knative.dev/v1beta1 + +
                                  +kind
                                  +string +
                                  InMemoryChannel
                                  +metadata
                                  -knative.dev/pkg/apis/duck/v1.SourceSpec + +Kubernetes meta/v1.ObjectMeta +
                                  -

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

                                  +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                                  -BindingSpec
                                  +spec
                                  -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +InMemoryChannelSpec + + +
                                  +

                                  Spec defines the desired state of the Channel.

                                  +
                                  +
                                  + + + -
                                  +ChannelableSpec
                                  + + +ChannelableSpec +

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

                                  +

                                  Channel conforms to Duck type Channelable.

                                  -

                                  SinkBindingStatus -

                                  -

                                  -(Appears on: -SinkBinding) -

                                  -

                                  -

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

                                  -

                                  - - - - - + - -
                                  FieldDescription
                                  -SourceStatus
                                  +status
                                  -knative.dev/pkg/apis/duck/v1.SourceStatus + +InMemoryChannelStatus +
                                  -

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

                                  +(Optional) +

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

                                  -
                                  -

                                  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 +

                                    Subscription

                                    -

                                    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.

                                    +

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

                                    @@ -7956,9 +7701,26 @@ Channelable ObjectReferences and access their subscription and address data. Th + + + + + + + + + + + +
                                    +apiVersion
                                    +string
                                    + +messaging.knative.dev/v1beta1 + +
                                    +kind
                                    +string +
                                    Subscription
                                    metadata
                                    - + Kubernetes meta/v1.ObjectMeta @@ -7972,43 +7734,81 @@ Refer to the Kubernetes API documentation for the fields of the
                                    spec
                                    - -ChannelableSpec + +SubscriptionSpec
                                    -

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



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

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

                                    +

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

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

                                    delivery
                                    - + DeliverySpec
                                    (Optional) -

                                    DeliverySpec contains options controlling the event delivery

                                    +

                                    Delivery configuration

                                    @@ -8018,26 +7818,80 @@ DeliverySpec
                                    status
                                    - -ChannelableStatus + +SubscriptionStatus + + +
                                    +
                                    +

                                    ChannelDefaulter +

                                    +

                                    +

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

                                    +

                                    +

                                    ChannelSpec +

                                    +

                                    +(Appears on: +Channel) +

                                    +

                                    +

                                    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.

                                    +

                                    + + + + + + + + + + + + + +
                                    FieldDescription
                                    +channelTemplate
                                    + + +ChannelTemplateSpec + + +
                                    +

                                    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.

                                    +
                                    +ChannelableSpec
                                    + + +ChannelableSpec
                                    +

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

                                    +

                                    Channel conforms to ChannelableSpec

                                    -

                                    ChannelableSpec +

                                    ChannelStatus

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

                                    -

                                    ChannelableSpec contains Spec of the Channelable object

                                    +

                                    ChannelStatus represents the current state of a Channel.

                                    @@ -8049,45 +7903,42 @@ ChannelableStatus
                                    -SubscribableSpec
                                    +ChannelableStatus
                                    - -SubscribableSpec + +ChannelableStatus

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

                                    +

                                    Channel conforms to ChannelableStatus

                                    -delivery
                                    +channel
                                    - -DeliverySpec - +knative.dev/pkg/apis/duck/v1.KReference
                                    -(Optional) -

                                    DeliverySpec contains options controlling the event delivery

                                    +

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

                                    -

                                    ChannelableStatus +

                                    ChannelTemplateSpec

                                    (Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) +ChannelSpec, +ParallelSpec, +SequenceSpec)

                                    -

                                    ChannelableStatus contains the Status of a Channelable object.

                                    @@ -8099,79 +7950,81 @@ DeliverySpec - - - +
                                    -Status
                                    +spec
                                    -knative.dev/pkg/apis/duck/v1.Status +k8s.io/apimachinery/pkg/runtime.RawExtension
                                    -

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

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

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

                                    ChannelTemplateSpecInternal +

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

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

                                    -

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

                                    -
                                    + + + + + +
                                    FieldDescription
                                    -SubscribableStatus
                                    +metadata
                                    - -SubscribableStatus + +Kubernetes meta/v1.ObjectMeta
                                    -

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

                                    -

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

                                    +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                                    -deadLetterChannel
                                    +spec
                                    -knative.dev/pkg/apis/duck/v1.KReference +k8s.io/apimachinery/pkg/runtime.RawExtension
                                    (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.

                                    +

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

                                    +
                                    +
                                    + +
                                    -

                                    DeliverySpec +

                                    InMemoryChannelSpec

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

                                    -

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

                                    +

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

                                    @@ -8183,67 +8036,30 @@ such as channelable and source.

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

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

                                    -
                                    -retry
                                    - -int32 - -
                                    -(Optional) -

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

                                    -
                                    -backoffPolicy
                                    +ChannelableSpec
                                    - -BackoffPolicyType + +ChannelableSpec
                                    -(Optional) -

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

                                    -
                                    -backoffDelay
                                    - -string - -
                                    -(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 backoffDelay*. -For exponential policy, backoff delay is backoffDelay*2^.

                                    +

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

                                    +

                                    Channel conforms to Duck type Channelable.

                                    -

                                    DeliveryStatus +

                                    InMemoryChannelStatus

                                    -

                                    DeliveryStatus contains the Status of an object supporting delivery options.

                                    +(Appears on: +InMemoryChannel) +

                                    +

                                    +

                                    ChannelStatus represents the current state of a Channel.

                                    @@ -8255,25 +8071,41 @@ For exponential policy, backoff delay is backoffDelay*2^.

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

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

                                    +

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

                                    +

                                    Channel conforms to Duck type Channelable.

                                    -

                                    Subscribable +

                                    SubscriptionSpec

                                    -

                                    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.

                                    +(Appears on: +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

                                    @@ -8285,74 +8117,82 @@ SubscribableType ObjectReferences and access the Subscription data. This is not
                                    -metadata
                                    +channel
                                    - -Kubernetes meta/v1.ObjectMeta + +Kubernetes core/v1.ObjectReference
                                    -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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

                                    -spec
                                    +subscriber
                                    - -SubscribableSpec - +knative.dev/pkg/apis/duck/v1.Destination
                                    -

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

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

                                    + + - -
                                    -subscribers
                                    +reply
                                    - -[]SubscriberSpec - +knative.dev/pkg/apis/duck/v1.Destination
                                    -

                                    This is the list of subscriptions for this subscribable.

                                    -
                                    +(Optional) +

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

                                    -status
                                    +delivery
                                    - -SubscribableStatus + +DeliverySpec
                                    -

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

                                    +(Optional) +

                                    Delivery configuration

                                    -

                                    SubscribableSpec +

                                    SubscriptionStatus

                                    (Appears on: -ChannelableSpec, -Subscribable) +Subscription)

                                    -

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

                                    +

                                    SubscriptionStatus (computed) for a subscription

                                    @@ -8364,29 +8204,44 @@ configured as to be compatible with Subscribable contract.

                                    + + + +
                                    -subscribers
                                    +Status
                                    - -[]SubscriberSpec +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.

                                    +
                                    +physicalSubscription
                                    + + +SubscriptionStatusPhysicalSubscription
                                    -

                                    This is the list of subscriptions for this subscribable.

                                    +

                                    PhysicalSubscription is the fully resolved values that this Subscription represents.

                                    -

                                    SubscribableStatus +

                                    SubscriptionStatusPhysicalSubscription

                                    (Appears on: -ChannelableStatus, -Subscribable) +SubscriptionStatus)

                                    -

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

                                    +

                                    SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

                                    @@ -8398,28 +8253,52 @@ section of the resource.

                                    + + + + + + + +
                                    -subscribers
                                    +subscriberUri
                                    - -[]SubscriberStatus - +knative.dev/pkg/apis.URL
                                    -

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

                                    +

                                    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.

                                    -

                                    SubscriberSpec -

                                    +
                                    +

                                    configs.internal.knative.dev/v1alpha1

                                    -(Appears on: -SubscribableSpec) +

                                    Package v1alpha1 is the v1alpha1 version of the API.

                                    +Resource Types: + +

                                    ConfigMapPropagation +

                                    -

                                    SubscriberSpec defines a single subscriber to a Subscribable.

                                    -

                                    At least one of SubscriberURI and ReplyURI must be present

                                    +

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

                                    @@ -8431,76 +8310,102 @@ section of the resource.

                                    + + + +
                                    -uid
                                    - -k8s.io/apimachinery/pkg/types.UID - +apiVersion
                                    +string
                                    + +configs.internal.knative.dev/v1alpha1 +
                                    -(Optional) -

                                    UID is used to understand the origin of the subscriber.

                                    +kind
                                    +string
                                    ConfigMapPropagation
                                    -generation
                                    +metadata
                                    -int64 + +Kubernetes meta/v1.ObjectMeta +
                                    (Optional) -

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

                                    +Refer to the Kubernetes API documentation for the fields of the +metadata field.
                                    -subscriberUri
                                    +spec
                                    -knative.dev/pkg/apis.URL + +ConfigMapPropagationSpec +
                                    -(Optional) -

                                    SubscriberURI is the endpoint for the subscriber

                                    +

                                    Spec defines the desired state of the ConfigMapPropagation

                                    +
                                    +
                                    + + + + + +
                                    +originalNamespace
                                    + +string + +
                                    +

                                    OriginalNamespace is the namespace where the original configMaps are in

                                    -replyUri
                                    +selector
                                    -knative.dev/pkg/apis.URL + +Kubernetes meta/v1.LabelSelector +
                                    (Optional) -

                                    ReplyURI is the endpoint for the reply

                                    +

                                    Selector only selects original configMaps with corresponding labels

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

                                    DeliverySpec contains options controlling the event delivery

                                    +

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

                                    -

                                    SubscriberStatus +

                                    ConfigMapPropagationSpec

                                    (Appears on: -SubscribableStatus) +ConfigMapPropagation)

                                    -

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

                                    @@ -8512,68 +8417,88 @@ DeliverySpec + +
                                    -uid
                                    +originalNamespace
                                    -k8s.io/apimachinery/pkg/types.UID +string
                                    -(Optional) -

                                    UID is used to understand the origin of the subscriber.

                                    +

                                    OriginalNamespace is the namespace where the original configMaps are in

                                    -observedGeneration
                                    +selector
                                    -int64 + +Kubernetes meta/v1.LabelSelector +
                                    (Optional) -

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

                                    +

                                    Selector only selects original configMaps with corresponding labels

                                    +

                                    ConfigMapPropagationStatus +

                                    +

                                    +(Appears on: +ConfigMapPropagation) +

                                    +

                                    +

                                    ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

                                    +

                                    + + + + + + + +
                                    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 Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

                                    -message
                                    +copyConfigmaps
                                    -string + +[]ConfigMapPropagationStatusCopyConfigMap +
                                    (Optional) -

                                    A human readable message indicating details of Ready status.

                                    +

                                    CopyConfigMaps is the status for each copied configmap.

                                    -
                                    -

                                    duck.knative.dev/v1alpha1

                                    +

                                    ConfigMapPropagationStatusCopyConfigMap +

                                    -

                                    Package v1alpha1 is the v1alpha1 version of the API.

                                    +(Appears on: +ConfigMapPropagationStatus)

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

                                      +

                                      ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

                                      @@ -8581,90 +8506,88 @@ Channelable ObjectReferences and access their subscription and address data. Th - - + + + + + +
                                      Field Description
                                      +name
                                      + +string + +
                                      +

                                      Name is copy configmap’s name

                                      +
                                      -metadata
                                      +source
                                      - -Kubernetes meta/v1.ObjectMeta - +string
                                      -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

                                      Source is “originalNamespace/originalConfigMapName”

                                      -spec
                                      +operation
                                      - -ChannelableSpec - +string
                                      -

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

                                      -
                                      -
                                      - +

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

                                      + + - -
                                      -SubscribableTypeSpec
                                      +ready
                                      - -SubscribableTypeSpec - +string
                                      -

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

                                      +

                                      Ready represents the operation is ready or not

                                      -delivery
                                      +reason
                                      - -DeliverySpec - +string
                                      -(Optional) -

                                      DeliverySpec contains options controlling the event delivery

                                      -
                                      +

                                      Reason indicates reasons if the operation is not ready

                                      -status
                                      +resourceVersionFromSource
                                      - -ChannelableStatus - +string
                                      +

                                      ResourceVersion is the resourceVersion of original configmap

                                      -

                                      ChannelableCombined +
                                      +

                                      flows.knative.dev/v1

                                      +

                                      +

                                      Package v1 is the v1 version of the API.

                                      +

                                      +Resource Types: +
                                        +

                                        Parallel

                                        -

                                        ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of -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.

                                        +

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

                                        @@ -8678,12 +8601,13 @@ This is not a real resource.

                                        @@ -8692,60 +8616,55 @@ Refer to the Kubernetes API documentation for the fields of the
                                        metadata
                                        - + Kubernetes meta/v1.ObjectMeta
                                        +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                                        - -ChannelableCombinedSpec + +ParallelSpec
                                        -

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

                                        +

                                        Spec defines the desired state of the Parallel.



                                        -SubscribableTypeSpec
                                        +branches
                                        - -SubscribableTypeSpec + +[]ParallelBranch
                                        -

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

                                        -

                                        SubscribableTypeSpec is for the v1alpha1 spec compatibility.

                                        +

                                        Branches is the list of Filter/Subscribers pairs.

                                        -SubscribableSpec
                                        +channelTemplate
                                        - -SubscribableSpec + +ChannelTemplateSpec
                                        -

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

                                        -

                                        SubscribableSpec is for the v1beta1 spec compatibility.

                                        +(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
                                        +reply
                                        - -DeliverySpec - +knative.dev/pkg/apis/duck/v1.Destination
                                        (Optional) -

                                        DeliverySpec contains options controlling the event delivery

                                        +

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

                                        @@ -8755,24 +8674,26 @@ DeliverySpec
                                        status
                                        - -ChannelableCombinedStatus + +ParallelStatus
                                        +(Optional) +

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

                                        -

                                        ChannelableCombinedSpec +

                                        ParallelBranch

                                        (Appears on: -ChannelableCombined) +ParallelSpec)

                                        -

                                        ChannelableSpec contains Spec of the Channelable object

                                        @@ -8784,60 +8705,65 @@ ChannelableCombinedStatus + + + +
                                        -SubscribableTypeSpec
                                        +filter
                                        - -SubscribableTypeSpec - +knative.dev/pkg/apis/duck/v1.Destination
                                        -

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

                                        -

                                        SubscribableTypeSpec is for the v1alpha1 spec compatibility.

                                        +(Optional) +

                                        Filter is the expression guarding the branch

                                        -SubscribableSpec
                                        +subscriber
                                        - -SubscribableSpec - +knative.dev/pkg/apis/duck/v1.Destination
                                        -

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

                                        -

                                        SubscribableSpec is for the v1beta1 spec compatibility.

                                        +

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

                                        DeliverySpec contains options controlling the event delivery

                                        +

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

                                        -

                                        ChannelableCombinedStatus +

                                        ParallelBranchStatus

                                        (Appears on: -ChannelableCombined) +ParallelStatus)

                                        -

                                        ChannelableStatus contains the Status of a Channelable object.

                                        +

                                        ParallelBranchStatus represents the current state of a Parallel branch

                                        @@ -8849,90 +8775,95 @@ DeliverySpec + + +
                                        -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 Service 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.

                                        -AddressStatus
                                        +filterChannelStatus
                                        -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus + +ParallelChannelStatus +
                                        -

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

                                        -

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

                                        +

                                        FilterChannelStatus corresponds to the filter channel status.

                                        -SubscribableTypeStatus
                                        +subscriberSubscriptionStatus
                                        - -SubscribableTypeStatus + +ParallelSubscriptionStatus
                                        +

                                        SubscriptionStatus corresponds to the subscriber subscription status.

                                        +
                                        +

                                        ParallelChannelStatus +

                                        -(Members of SubscribableTypeStatus are embedded into this type.) +(Appears on: +ParallelBranchStatus, +ParallelStatus)

                                        -

                                        SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

                                        - +

                                        +

                                        + + + + + + +
                                        FieldDescription
                                        -SubscribableStatus
                                        +channel
                                        - -SubscribableStatus + +Kubernetes core/v1.ObjectReference
                                        -

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

                                        -

                                        SubscribableStatus is the v1beta1 part of the Subscribers status.

                                        +

                                        Channel is the reference to the underlying channel.

                                        -errorChannel
                                        +ready
                                        - -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis.Condition
                                        -(Optional) -

                                        ErrorChannel is set by the channel when it supports native error handling via a channel

                                        +

                                        ReadyCondition indicates whether the Channel is ready or not.

                                        -

                                        ChannelableSpec +

                                        ParallelSpec

                                        (Appears on: -Channelable) +Parallel)

                                        -

                                        ChannelableSpec contains Spec of the Channelable object

                                        @@ -8940,47 +8871,59 @@ Kubernetes core/v1.ObjectReference - - + + + + + +
                                        Field Description
                                        +branches
                                        + + +[]ParallelBranch + + +
                                        +

                                        Branches is the list of Filter/Subscribers pairs.

                                        +
                                        -SubscribableTypeSpec
                                        +channelTemplate
                                        - -SubscribableTypeSpec + +ChannelTemplateSpec
                                        -

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

                                        +(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
                                        +reply
                                        - -DeliverySpec - +knative.dev/pkg/apis/duck/v1.Destination
                                        (Optional) -

                                        DeliverySpec contains options controlling the event delivery

                                        +

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

                                        -

                                        ChannelableStatus +

                                        ParallelStatus

                                        (Appears on: -Channelable) +Parallel)

                                        -

                                        ChannelableStatus contains the Status of a Channelable object.

                                        +

                                        ParallelStatus represents the current state of a Parallel.

                                        @@ -9008,89 +8951,56 @@ knative.dev/pkg/apis/duck/v1.Status - - -
                                        -AddressStatus
                                        +ingressChannelStatus
                                        -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus + +ParallelChannelStatus +
                                        -

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

                                        -

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

                                        +

                                        IngressChannelStatus corresponds to the ingress channel status.

                                        -SubscribableTypeStatus
                                        +branchStatuses
                                        - -SubscribableTypeStatus + +[]ParallelBranchStatus
                                        -

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

                                        -

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

                                        +

                                        BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order.

                                        -errorChannel
                                        +AddressStatus
                                        - -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.AddressStatus
                                        -(Optional) -

                                        ErrorChannel is set by the channel when it supports native error handling via a channel

                                        -
                                        -

                                        Resource -

                                        -

                                        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.

                                        +(Members of AddressStatus are embedded into this type.)

                                        - - - - - - - - - - -
                                        FieldDescription
                                        -metadata
                                        - - -Kubernetes meta/v1.ObjectMeta - - -
                                        -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

                                        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}

                                        -

                                        Subscribable +

                                        ParallelSubscriptionStatus

                                        (Appears on: -SubscribableTypeSpec) +ParallelBranchStatus)

                                        -

                                        Subscribable is the schema for the subscribable portion of the spec -section of the resource.

                                        @@ -9102,58 +9012,35 @@ section of the resource.

                                        - -
                                        -subscribers
                                        +subscription
                                        - -[]SubscriberSpec + +Kubernetes core/v1.ObjectReference
                                        -

                                        This is the list of subscriptions for this subscribable.

                                        +

                                        Subscription is the reference to the underlying Subscription.

                                        -

                                        SubscribableStatus -

                                        -

                                        -(Appears on: -SubscribableTypeStatus) -

                                        -

                                        -

                                        SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.

                                        -

                                        - - - - - - - -
                                        FieldDescription
                                        -subscribers
                                        +ready
                                        - -[]SubscriberStatus - +knative.dev/pkg/apis.Condition
                                        -

                                        This is the list of subscription’s statuses for this channel.

                                        +

                                        ReadyCondition indicates whether the Subscription is ready or not.

                                        -

                                        SubscribableType +

                                        Sequence

                                        -

                                        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.

                                        +

                                        Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.

                                        @@ -9167,12 +9054,13 @@ SubscribableType ObjectReferences and access the Subscription data. This is not @@ -9181,27 +9069,55 @@ Refer to the Kubernetes API documentation for the fields of the
                                        metadata
                                        - + Kubernetes meta/v1.ObjectMeta
                                        +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
                                        - -SubscribableTypeSpec + +SequenceSpec
                                        -

                                        SubscribableTypeSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract.

                                        +

                                        Spec defines the desired state of the Sequence.



                                        + + + + + + + +
                                        -subscribable
                                        +steps
                                        - -Subscribable + +[]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.

                                        @@ -9211,28 +9127,26 @@ Subscribable
                                        status
                                        - -SubscribableTypeStatus + +SequenceStatus
                                        -

                                        SubscribableTypeStatus 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.

                                        -

                                        SubscribableTypeSpec +

                                        SequenceChannelStatus

                                        (Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) +SequenceStatus)

                                        -

                                        SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.

                                        @@ -9244,28 +9158,37 @@ configured as to be compatible with Subscribable contract.

                                        + + + +
                                        -subscribable
                                        +channel
                                        - -Subscribable + +Kubernetes core/v1.ObjectReference
                                        +

                                        Channel is the reference to the underlying channel.

                                        +
                                        +ready
                                        + +knative.dev/pkg/apis.Condition + +
                                        +

                                        ReadyCondition indicates whether the Channel is ready or not.

                                        -

                                        SubscribableTypeStatus +

                                        SequenceSpec

                                        (Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -SubscribableType) +Sequence)

                                        -

                                        SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

                                        @@ -9277,30 +9200,55 @@ Subscribable + + + + + + + +
                                        -subscribableStatus
                                        +steps
                                        - -SubscribableStatus + +[]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.

                                        -

                                        SubscriberSpec +

                                        SequenceStatus

                                        (Appears on: -Subscribable) +Sequence)

                                        -

                                        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

                                        +

                                        SequenceStatus represents the current state of a Sequence.

                                        @@ -9312,92 +9260,171 @@ At least one of SubscriberURI and ReplyURI must be present

                                        + +
                                        -uid
                                        +Status
                                        -k8s.io/apimachinery/pkg/types.UID +knative.dev/pkg/apis/duck/v1.Status
                                        -(Optional) -

                                        UID is used to understand the origin of the subscriber.

                                        +

                                        +(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.

                                        -generation
                                        +subscriptionStatuses
                                        -int64 + +[]SequenceSubscriptionStatus +
                                        -(Optional) -

                                        Generation of the origin of the subscriber with uid:UID.

                                        +

                                        SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order.

                                        -subscriberURI
                                        +channelStatuses
                                        -knative.dev/pkg/apis.URL + +[]SequenceChannelStatus +
                                        -(Optional) +

                                        ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order.

                                        -replyURI
                                        +AddressStatus
                                        -knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.AddressStatus
                                        -(Optional) +

                                        +(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}

                                        +

                                        SequenceStep +

                                        +

                                        +(Appears on: +SequenceSpec) +

                                        +

                                        +

                                        + + + + + + + + + + +
                                        FieldDescription
                                        -deadLetterSink
                                        +Destination
                                        -knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination
                                        -(Optional) +

                                        +(Members of Destination are embedded into this type.) +

                                        +

                                        Subscriber receiving the step event

                                        delivery
                                        - + DeliverySpec
                                        (Optional) +

                                        Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc.

                                        +
                                        +

                                        SequenceSubscriptionStatus +

                                        +

                                        +(Appears on: +SequenceStatus) +

                                        +

                                        +

                                        + + + + + + + + + + + + + + +
                                        FieldDescription
                                        +subscription
                                        + + +Kubernetes core/v1.ObjectReference + + +
                                        +

                                        Subscription is the reference to the underlying Subscription.

                                        +
                                        +ready
                                        + +knative.dev/pkg/apis.Condition + +
                                        +

                                        ReadyCondition indicates whether the Subscription is ready or not.


                                        -

                                        sources.knative.dev/v1beta1

                                        +

                                        sources.knative.dev/v1alpha2

                                        -

                                        Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.

                                        +

                                        Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group

                                        Resource Types: -

                                        ApiServerSource +

                                        ApiServerSource

                                        ApiServerSource is the Schema for the apiserversources API

                                        @@ -9416,7 +9443,7 @@ Resource Types: string -sources.knative.dev/v1beta1 +sources.knative.dev/v1alpha2 @@ -9431,7 +9458,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -9445,7 +9472,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                                        - + ApiServerSourceSpec @@ -9476,7 +9503,7 @@ and modifications of the event sent to the sink.

                                        resources
                                        - + []APIVersionKindSelector @@ -9491,7 +9518,7 @@ selector to help filter.

                                        owner
                                        - + APIVersionKind @@ -9538,7 +9565,7 @@ source. Defaults to default if not set.

                                        status
                                        - + ApiServerSourceStatus @@ -9548,7 +9575,7 @@ ApiServerSourceStatus -

                                        ContainerSource +

                                        ContainerSource

                                        ContainerSource is the Schema for the containersources API

                                        @@ -9567,7 +9594,7 @@ ApiServerSourceStatus string -sources.knative.dev/v1beta1 +sources.knative.dev/v1alpha2 @@ -9582,7 +9609,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -9596,7 +9623,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                                        - + ContainerSourceSpec @@ -9627,7 +9654,7 @@ and modifications of the event sent to the sink.

                                        template
                                        - + Kubernetes core/v1.PodTemplateSpec @@ -9643,7 +9670,7 @@ Kubernetes core/v1.PodTemplateSpec status
                                        - + ContainerSourceStatus @@ -9653,7 +9680,7 @@ ContainerSourceStatus -

                                        PingSource +

                                        PingSource

                                        PingSource is the Schema for the PingSources API.

                                        @@ -9672,7 +9699,7 @@ ContainerSourceStatus string -sources.knative.dev/v1beta1 +sources.knative.dev/v1alpha2 @@ -9687,7 +9714,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -9701,7 +9728,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                                        - + PingSourceSpec @@ -9742,20 +9769,6 @@ string -timezone
                                        - -string - - - -

                                        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

                                        - - - - jsonData
                                        string @@ -9775,7 +9788,7 @@ to “application/json”.

                                        status
                                        - + PingSourceStatus @@ -9785,7 +9798,7 @@ PingSourceStatus -

                                        SinkBinding +

                                        SinkBinding

                                        SinkBinding describes a Binding that is also a Source. @@ -9809,7 +9822,7 @@ cloud events.

                                        string -sources.knative.dev/v1beta1 +sources.knative.dev/v1alpha2 @@ -9824,7 +9837,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -9838,7 +9851,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
                                        - + SinkBindingSpec @@ -9869,14 +9882,14 @@ and modifications of the event sent to the sink.

                                        BindingSpec
                                        -knative.dev/pkg/apis/duck/v1beta1.BindingSpec +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec

                                        (Members of BindingSpec are embedded into this type.)

                                        -

                                        inherits duck/v1beta1 BindingSpec, which currently provides: +

                                        inherits duck/v1alpha1 BindingSpec, which currently provides: * Subject - Subject references the resource(s) whose “runtime contract” should be augmented by Binding implementations.

                                        @@ -9888,7 +9901,7 @@ should be augmented by Binding implementations.

                                        status
                                        - + SinkBindingStatus @@ -9898,11 +9911,12 @@ SinkBindingStatus -

                                        APIVersionKind +

                                        APIVersionKind

                                        (Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec, +ApiServerSourceSpec)

                                        APIVersionKind is an APIVersion and Kind tuple.

                                        @@ -9940,11 +9954,11 @@ More info: APIVersionKindSelector +

                                        APIVersionKindSelector

                                        (Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)

                                        APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

                                        @@ -9984,7 +9998,7 @@ More info: + Kubernetes meta/v1.LabelSelector
                                        @@ -9998,11 +10012,11 @@ More info: ApiServerSourceSpec +

                                        ApiServerSourceSpec

                                        (Appears on: -ApiServerSource) +ApiServerSource)

                                        ApiServerSourceSpec defines the desired state of ApiServerSource

                                        @@ -10037,7 +10051,7 @@ and modifications of the event sent to the sink.

                                        resources
                                        - + []APIVersionKindSelector @@ -10052,7 +10066,7 @@ selector to help filter.

                                        owner
                                        - + APIVersionKind @@ -10094,11 +10108,11 @@ source. Defaults to default if not set.

                                        -

                                        ApiServerSourceStatus +

                                        ApiServerSourceStatus

                                        (Appears on: -ApiServerSource) +ApiServerSource)

                                        ApiServerSourceStatus defines the observed state of ApiServerSource

                                        @@ -10133,11 +10147,11 @@ Source.

                                        -

                                        ContainerSourceSpec +

                                        ContainerSourceSpec

                                        (Appears on: -ContainerSource) +ContainerSource)

                                        ContainerSourceSpec defines the desired state of ContainerSource

                                        @@ -10172,7 +10186,7 @@ and modifications of the event sent to the sink.

                                        template
                                        - + Kubernetes core/v1.PodTemplateSpec @@ -10183,11 +10197,11 @@ Kubernetes core/v1.PodTemplateSpec -

                                        ContainerSourceStatus +

                                        ContainerSourceStatus

                                        (Appears on: -ContainerSource) +ContainerSource)

                                        ContainerSourceStatus defines the observed state of ContainerSource

                                        @@ -10222,11 +10236,11 @@ Source.

                                        -

                                        PingSourceSpec +

                                        PingSourceSpec

                                        (Appears on: -PingSource) +PingSource)

                                        PingSourceSpec defines the desired state of the PingSource.

                                        @@ -10271,20 +10285,6 @@ string -timezone
                                        - -string - - - -

                                        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

                                        - - - - jsonData
                                        string @@ -10299,11 +10299,11 @@ to “application/json”.

                                        -

                                        PingSourceStatus +

                                        PingSourceStatus

                                        (Appears on: -PingSource) +PingSource)

                                        PingSourceStatus defines the observed state of PingSource.

                                        @@ -10338,11 +10338,11 @@ Source.

                                        -

                                        SinkBindingSpec +

                                        SinkBindingSpec

                                        (Appears on: -SinkBinding) +SinkBinding)

                                        SinkBindingSpec holds the desired state of the SinkBinding (from the client).

                                        @@ -10377,25 +10377,25 @@ and modifications of the event sent to the sink.

                                        BindingSpec
                                        -knative.dev/pkg/apis/duck/v1beta1.BindingSpec +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec

                                        (Members of BindingSpec are embedded into this type.)

                                        -

                                        inherits duck/v1beta1 BindingSpec, which currently provides: +

                                        inherits duck/v1alpha1 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).

                                        diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index 8784d7bc30..2e3ac53adc 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -1,244 +1,15 @@

                                        Packages:

                                        -

                                        serving.knative.dev/v1alpha1

                                        -

                                        -

                                        Package v1alpha1 contains the v1alpha1 versions of the serving apis. -Api versions allow the api contract for a resource to be changed while keeping -backward compatibility by support multiple concurrent versions -of the same resource

                                        -

                                        -Resource Types: - -

                                        DomainMapping -

                                        -

                                        -

                                        DomainMapping is a mapping from a custom hostname to an Addressable.

                                        -

                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                        FieldDescription
                                        -apiVersion
                                        -string
                                        - -serving.knative.dev/v1alpha1 - -
                                        -kind
                                        -string -
                                        DomainMapping
                                        -metadata
                                        - - -Kubernetes meta/v1.ObjectMeta - - -
                                        -(Optional) -

                                        Standard object’s metadata. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata

                                        -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
                                        -spec
                                        - - -DomainMappingSpec - - -
                                        -(Optional) -

                                        Spec is the desired state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

                                        -
                                        -
                                        - - - - - -
                                        -ref
                                        - -knative.dev/pkg/apis/duck/v1.KReference - -
                                        -

                                        Ref points to an Addressable. -Currently, Ref must be a KSvc.

                                        -
                                        -
                                        -status
                                        - - -DomainMappingStatus - - -
                                        -(Optional) -

                                        Status is the current state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

                                        -
                                        -

                                        CannotConvertError -

                                        -

                                        -

                                        CannotConvertError is returned when a field cannot be converted.

                                        -

                                        - - - - - - - - - - - - - - - - - -
                                        FieldDescription
                                        -Message
                                        - -string - -
                                        -
                                        -Field
                                        - -string - -
                                        -
                                        -

                                        DomainMappingSpec -

                                        -

                                        -(Appears on: -DomainMapping) -

                                        -

                                        -

                                        DomainMappingSpec describes the DomainMapping the user wishes to exist.

                                        -

                                        - - - - - - - - - - - - - -
                                        FieldDescription
                                        -ref
                                        - -knative.dev/pkg/apis/duck/v1.KReference - -
                                        -

                                        Ref points to an Addressable. -Currently, Ref must be a KSvc.

                                        -
                                        -

                                        DomainMappingStatus -

                                        -

                                        -(Appears on: -DomainMapping) -

                                        -

                                        -

                                        DomainMappingStatus describes the current state of the DomainMapping.

                                        -

                                        - - - - - - - - - - - - - - - - - - - - - -
                                        FieldDescription
                                        -Status
                                        - -knative.dev/pkg/apis/duck/v1.Status - -
                                        -

                                        -(Members of Status are embedded into this type.) -

                                        -
                                        -url
                                        - -knative.dev/pkg/apis.URL - -
                                        -(Optional) -

                                        URL is the URL of this DomainMapping.

                                        -
                                        -address
                                        - -knative.dev/pkg/apis/duck/v1.Addressable - -
                                        -(Optional) -

                                        Address holds the information needed for a DomainMapping to be the target of an event.

                                        -
                                        -

                                        autoscaling.internal.knative.dev/v1alpha1

                                        Package v1alpha1 contains the Autoscaling v1alpha1 API types.

                                        @@ -284,7 +55,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -328,7 +99,7 @@ Defaults to 0 which means unlimited concurrency.

                                        scaleTargetRef
                                        - + Kubernetes core/v1.ObjectReference @@ -400,7 +171,7 @@ PodAutoscalerStatus metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -597,7 +368,7 @@ Defaults to 0 which means unlimited concurrency.

                                        scaleTargetRef
                                        - + Kubernetes core/v1.ObjectReference @@ -734,7 +505,7 @@ the referenced resources may take.

                                        metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -771,7 +542,7 @@ int32 selector
                                        - + Kubernetes meta/v1.LabelSelector @@ -783,7 +554,7 @@ Kubernetes meta/v1.LabelSelector template
                                        - + Kubernetes core/v1.PodTemplateSpec @@ -840,7 +611,7 @@ int32 selector
                                        - + Kubernetes meta/v1.LabelSelector @@ -852,7 +623,7 @@ Kubernetes meta/v1.LabelSelector template
                                        - + Kubernetes core/v1.PodTemplateSpec @@ -955,7 +726,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -1049,7 +820,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -1078,7 +849,7 @@ RevisionSpec PodSpec
                                        - + Kubernetes core/v1.PodSpec @@ -1175,7 +946,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -1278,7 +1049,7 @@ string metadata
                                        - + Kubernetes meta/v1.ObjectMeta @@ -1546,7 +1317,7 @@ string PodSpec
                                        - + Kubernetes core/v1.PodSpec @@ -1708,7 +1479,7 @@ Based on: + Kubernetes meta/v1.ObjectMeta
                                        @@ -1737,7 +1508,7 @@ RevisionSpec PodSpec
                                        - + Kubernetes core/v1.PodSpec @@ -2171,6 +1942,235 @@ a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)<
                                        +

                                        serving.knative.dev/v1alpha1

                                        +

                                        +

                                        Package v1alpha1 contains the v1alpha1 versions of the serving apis. +Api versions allow the api contract for a resource to be changed while keeping +backward compatibility by support multiple concurrent versions +of the same resource

                                        +

                                        +Resource Types: + +

                                        DomainMapping +

                                        +

                                        +

                                        DomainMapping is a mapping from a custom hostname to an Addressable.

                                        +

                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                        FieldDescription
                                        +apiVersion
                                        +string
                                        + +serving.knative.dev/v1alpha1 + +
                                        +kind
                                        +string +
                                        DomainMapping
                                        +metadata
                                        + + +Kubernetes meta/v1.ObjectMeta + + +
                                        +(Optional) +

                                        Standard object’s metadata. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata

                                        +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
                                        +spec
                                        + + +DomainMappingSpec + + +
                                        +(Optional) +

                                        Spec is the desired state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

                                        +
                                        +
                                        + + + + + +
                                        +ref
                                        + +knative.dev/pkg/apis/duck/v1.KReference + +
                                        +

                                        Ref points to an Addressable. +Currently, Ref must be a KSvc.

                                        +
                                        +
                                        +status
                                        + + +DomainMappingStatus + + +
                                        +(Optional) +

                                        Status is the current state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

                                        +
                                        +

                                        CannotConvertError +

                                        +

                                        +

                                        CannotConvertError is returned when a field cannot be converted.

                                        +

                                        + + + + + + + + + + + + + + + + + +
                                        FieldDescription
                                        +Message
                                        + +string + +
                                        +
                                        +Field
                                        + +string + +
                                        +
                                        +

                                        DomainMappingSpec +

                                        +

                                        +(Appears on: +DomainMapping) +

                                        +

                                        +

                                        DomainMappingSpec describes the DomainMapping the user wishes to exist.

                                        +

                                        + + + + + + + + + + + + + +
                                        FieldDescription
                                        +ref
                                        + +knative.dev/pkg/apis/duck/v1.KReference + +
                                        +

                                        Ref points to an Addressable. +Currently, Ref must be a KSvc.

                                        +
                                        +

                                        DomainMappingStatus +

                                        +

                                        +(Appears on: +DomainMapping) +

                                        +

                                        +

                                        DomainMappingStatus describes the current state of the DomainMapping.

                                        +

                                        + + + + + + + + + + + + + + + + + + + + + +
                                        FieldDescription
                                        +Status
                                        + +knative.dev/pkg/apis/duck/v1.Status + +
                                        +

                                        +(Members of Status are embedded into this type.) +

                                        +
                                        +url
                                        + +knative.dev/pkg/apis.URL + +
                                        +(Optional) +

                                        URL is the URL of this DomainMapping.

                                        +
                                        +address
                                        + +knative.dev/pkg/apis/duck/v1.Addressable + +
                                        +(Optional) +

                                        Address holds the information needed for a DomainMapping to be the target of an event.

                                        +
                                        +

                                        Generated with gen-crd-api-reference-docs on git commit db4879e0f. diff --git a/hack/reference-docs-gen-config.json b/hack/reference-docs-gen-config.json index b4df81a3c1..dcd5eb9de9 100644 --- a/hack/reference-docs-gen-config.json +++ b/hack/reference-docs-gen-config.json @@ -13,7 +13,7 @@ }, { "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", - "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" + "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" }, { "typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/", From cc591409578c41f0acdbf5de0040309b46e1727d Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Mon, 16 Nov 2020 17:27:06 -0800 Subject: [PATCH 5/9] revert file --- docs/reference/api/eventing/_index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/reference/api/eventing/_index.md diff --git a/docs/reference/api/eventing/_index.md b/docs/reference/api/eventing/_index.md new file mode 100644 index 0000000000..e1add05a56 --- /dev/null +++ b/docs/reference/api/eventing/_index.md @@ -0,0 +1,10 @@ +--- +title: "Knative Eventing Component" +linkTitle: "Eventing API" +weight: 20 +type: "docs" +aliases: + - /docs/reference/eventing/eventing +--- + +{{< readfile file="eventing.md" >}} From fbdee69170a202614fab171248a3ec5ea31c43e5 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Tue, 17 Nov 2020 09:44:23 -0800 Subject: [PATCH 6/9] remove whitespace --- docs/reference/api/eventing/eventing.md | 78 ++++++++++++------------- docs/reference/api/serving.md | 12 ++-- 2 files changed, 45 insertions(+), 45 deletions(-) diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index 7d23920f20..996ab92f40 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -151,8 +151,8 @@ ChannelableStatus

                                        (Appears on: -ChannelSpec, -Channelable, +ChannelSpec, +Channelable, InMemoryChannelSpec)

                                        @@ -201,8 +201,8 @@ DeliverySpec

                                        (Appears on: -ChannelStatus, -Channelable, +ChannelStatus, +Channelable, InMemoryChannelStatus)

                                        @@ -281,11 +281,11 @@ Failed messages are delivered here.

                                        (Appears on: -BrokerSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, +BrokerSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, SubscriptionSpec)

                                        @@ -467,7 +467,7 @@ configured as to be compatible with Subscribable contract.

                                        (Appears on: -ChannelableSpec, +ChannelableSpec, Subscribable)

                                        @@ -500,7 +500,7 @@ configured as to be compatible with Subscribable contract.

                                        (Appears on: -ChannelableStatus, +ChannelableStatus, Subscribable)

                                        @@ -1346,8 +1346,8 @@ configured as to be compatible with Subscribable contract.

                                        (Appears on: -ChannelableCombinedSpec, -ChannelableSpec, +ChannelableCombinedSpec, +ChannelableSpec, SubscribableType)

                                        @@ -1379,8 +1379,8 @@ Subscribable

                                        (Appears on: -ChannelableCombinedStatus, -ChannelableStatus, +ChannelableCombinedStatus, +ChannelableStatus, SubscribableType)

                                        @@ -1610,8 +1610,8 @@ ChannelableStatus

                                        (Appears on: -ChannelSpec, -Channelable, +ChannelSpec, +Channelable, InMemoryChannelSpec)

                                        @@ -1660,8 +1660,8 @@ DeliverySpec

                                        (Appears on: -ChannelStatus, -Channelable, +ChannelStatus, +Channelable, InMemoryChannelStatus)

                                        @@ -1740,14 +1740,14 @@ Failed messages are delivered here.

                                        (Appears on: -BrokerSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriberSpec, +BrokerSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriberSpec, SubscriptionSpec)

                                        @@ -1929,8 +1929,8 @@ configured as to be compatible with Subscribable contract.

                                        (Appears on: -ChannelableCombinedSpec, -ChannelableSpec, +ChannelableCombinedSpec, +ChannelableSpec, Subscribable)

                                        @@ -1963,8 +1963,8 @@ configured as to be compatible with Subscribable contract.

                                        (Appears on: -ChannelableCombinedStatus, -ChannelableStatus, +ChannelableCombinedStatus, +ChannelableStatus, Subscribable)

                                        @@ -2080,7 +2080,7 @@ DeliverySpec

                                        (Appears on: -SubscribableStatus, +SubscribableStatus, SubscribableStatus)

                                        @@ -2388,7 +2388,7 @@ ParallelSubscriptionStatus

                                        (Appears on: -ParallelBranchStatus, +ParallelBranchStatus, ParallelStatus)

                                        @@ -7116,8 +7116,8 @@ knative.dev/pkg/apis/duck/v1.KReference

                                        (Appears on: -ChannelSpec, -ParallelSpec, +ChannelSpec, +ParallelSpec, SequenceSpec)

                                        @@ -7934,8 +7934,8 @@ knative.dev/pkg/apis/duck/v1.KReference

                                        (Appears on: -ChannelSpec, -ParallelSpec, +ChannelSpec, +ParallelSpec, SequenceSpec)

                                        @@ -8818,7 +8818,7 @@ ParallelSubscriptionStatus

                                        (Appears on: -ParallelBranchStatus, +ParallelBranchStatus, ParallelStatus)

                                        @@ -9915,7 +9915,7 @@ SinkBindingStatus

                                        (Appears on: -ApiServerSourceSpec, +ApiServerSourceSpec, ApiServerSourceSpec)

                                        diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index 2e3ac53adc..366e623d4f 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -1131,7 +1131,7 @@ ServiceStatus

                                        (Appears on: -Configuration, +Configuration, ServiceSpec)

                                        @@ -1212,7 +1212,7 @@ ConfigurationStatusFields

                                        (Appears on: -ConfigurationStatus, +ConfigurationStatus, ServiceStatus)

                                        @@ -1299,7 +1299,7 @@ string

                                        (Appears on: -Revision, +Revision, RevisionTemplateSpec)

                                        @@ -1557,7 +1557,7 @@ be provided.

                                        (Appears on: -Route, +Route, ServiceSpec)

                                        @@ -1639,7 +1639,7 @@ RouteStatusFields

                                        (Appears on: -RouteStatus, +RouteStatus, ServiceStatus)

                                        @@ -1834,7 +1834,7 @@ specific to RouteStatus.

                                        (Appears on: -RouteSpec, +RouteSpec, RouteStatusFields)

                                        From 4032aacf3145730713637b4867cfed22ae8a6bdf Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 18 Nov 2020 10:56:07 -0800 Subject: [PATCH 7/9] Update docs/reference/api/README.md Co-authored-by: Mike Petersen --- docs/reference/api/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index d14c5aa1a6..644327c509 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -87,7 +87,7 @@ To generate a version of the API: https://github.com/ahmetb/gen-crd-api-reference-docs/tags The script is kept up-to-date with changes that go into the Kubernetes API. - As Knative adds support for those APIs, you might need make sure the + As Knative adds support for those APIs, you might need to make sure the corresponding [script `gen-crd-api-reference-docs` version](https://github.com/knative/docs/blob/master/hack/gen-api-reference-docs.sh#L26) is used. From 4e5ef877022bf781db0b9c56e38625780dd08c34 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 18 Nov 2020 14:13:17 -0800 Subject: [PATCH 8/9] add more detail --- docs/reference/api/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index 644327c509..862e5ed80e 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -94,8 +94,9 @@ To generate a version of the API: * If you get the `F0807 13:58:20.621526 168834 main.go:444] type invalid type has kind=Unsupported which is unhandled` - error, the import target might have moved. For more details and an example, - see [#2054](https://github.com/knative/docs/pull/2054) (and the linked Issues). + error, the import target might have moved. There might be other causes for that error buy see + [#2054](https://github.com/knative/docs/pull/2054) (and the linked Issues) for details about how we handled that error + in the past. 1. Copy the generated API files into the `docs/reference` directory of your knative/docs clone. From 3c17341fda797f7fba658e21f750f3ccf21a2031 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 18 Nov 2020 14:15:40 -0800 Subject: [PATCH 9/9] and now fix my typo --- docs/reference/api/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index 862e5ed80e..64775c8b8f 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -94,7 +94,7 @@ To generate a version of the API: * If you get the `F0807 13:58:20.621526 168834 main.go:444] type invalid type has kind=Unsupported which is unhandled` - error, the import target might have moved. There might be other causes for that error buy see + error, the import target might have moved. There might be other causes for that error but view [#2054](https://github.com/knative/docs/pull/2054) (and the linked Issues) for details about how we handled that error in the past.