diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index 61f9f9327..eea887d18 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -85,6 +85,9 @@ To generate a version of the API: 1. Copy the generated API files into the `docs/reference` directory of your knative/docs clone. +1. The linter now fails for content with trailing whitespaces. Use a tool of your choice to + remove all trailing whitespace. For example, search for and remove: `\s+$` + You can now perform the necessary steps to open a PR, complete a review, and merge the new API files into the appropriate branch of the `knative/docs` repo. See the [contributor flow](https://github.com/knative/community/blob/master/docs/DOCS-CONTRIBUTING.md) for details @@ -92,19 +95,18 @@ about requesting changes in the `knative/docs` repo. ### Example - -To build a set of Knative API docs for v0.3, you can use the `v0.3.0` the tags +To build a set of Knative API docs for v0.18, you can use the `v0.18.0` the tags from each of the Knative component repositories, like -[Serving v0.3.0](https://github.com/knative/serving/tree/v0.3.0). If you want to -use a commit for Serving v0.3.0, you would use -[4d198d](https://github.com/knative/serving/commit/4d198db8756db2f8a3c228302a97fb3a216a9475). +[Serving v0.18.0](https://github.com/knative/serving/tree/v0.18.0). If you want to +use a commit for Serving v0.18.0, you would use +[850b7c](https://github.com/knative/serving/commit/850b7cca7d7701b052420a030f2308d19938d45e). Using tags from each repo, you would run the following command to generate the -v0.3.0 API source files: +v0.18.0 API source files: ``` -KNATIVE_SERVING_COMMIT=v0.3.0 \ -KNATIVE_EVENTING_COMMIT=v0.3.0 \ -KNATIVE_EVENTING_CONTRIB_COMMIT=v0.3.0 \ +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/_index.md b/docs/reference/api/_index.md index 25b21f007..9c3c73ee9 100644 --- a/docs/reference/api/_index.md +++ b/docs/reference/api/_index.md @@ -1,11 +1,6 @@ --- title: "Knative API Reference Documentation" linkTitle: "API" -weight: 100 +weight: 50 type: "docs" -aliases: -aliases: - - /docs/reference/ --- - -{{% readfile file="README.md" %}} diff --git a/docs/reference/api/eventing/eventing-contrib.md b/docs/reference/api/eventing/eventing-contrib.md index a8cb795b1..9c483372d 100644 --- a/docs/reference/api/eventing/eventing-contrib.md +++ b/docs/reference/api/eventing/eventing-contrib.md @@ -1,24 +1,372 @@

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.

@@ -26,8 +374,6 @@ Resource Types:

KafkaChannel

@@ -141,96 +487,6 @@ date.

-

NatssChannel -

-

-

NatssChannel is a resource representing a NATSS Channel.

-

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

Spec defines the desired state of the Channel.

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

NatssChannel conforms to Duck type Subscribable.

-
-
-status
- - -NatssChannelStatus - - -
-(Optional) -

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

-

KafkaChannelSpec

@@ -349,102 +605,6 @@ knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus -

NatssChannelSpec -

-

-(Appears on: -NatssChannel) -

-

-

NatssChannelSpec defines the specification for a NatssChannel.

-

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

NatssChannel conforms to Duck type Subscribable.

-
-

NatssChannelStatus -

-

-(Appears on: -NatssChannel) -

-

-

NatssChannelStatus represents the current state of a NatssChannel.

-

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

-

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

-

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

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

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

-

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

-

messaging.knative.dev/v1beta1

@@ -658,6 +818,420 @@ knative.dev/eventing/pkg/apis/duck/v1.ChannelableStatus


+

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

@@ -668,7 +1242,7 @@ Resource Types:

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

@@ -1042,7 +1616,7 @@ SecretValueFromSource

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

@@ -1072,2056 +1646,12 @@ Kubernetes core/v1.SecretKeySelector


-

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.

-
-

sources.knative.dev/v1alpha1

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

Resource Types: - -

AwsSqsSource -

-

-

AwsSqsSource is the Schema for the AWS SQS API

-

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

QueueURL of the SQS queue that we will poll from.

-
-awsCredsSecret
- - -Kubernetes core/v1.SecretKeySelector - - -
-(Optional) -

AwsCredsSecret is the credential to use to poll the AWS SQS

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

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

-
-sink
- - -Kubernetes core/v1.ObjectReference - - -
-(Optional) -

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

-
-serviceAccountName
- -string - -
-

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

-
-
-status
- - -AwsSqsSourceStatus - - -
-
-

CamelSource -

-

-

CamelSource is the Schema for the camelsources API

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string
- -sources.knative.dev/v1alpha1 - -
-kind
-string -
CamelSource
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -CamelSourceSpec - - -
-
-
- - - - - - - - - - - - - -
-source
- - -CamelSourceOriginSpec - - -
-

Source is the reference to the integration flow to run.

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

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

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

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

-
-
-status
- - -CamelSourceStatus - - -
-
-

CouchDbSource -

-

-

CouchDbSource is the Schema for the githubsources API

-

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

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

-
-credentials
- - -Kubernetes core/v1.ObjectReference - - -
-

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

-
-feed
- - -FeedType - - -
-

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

-
-database
- -string - -
-

Database is the database to watch for changes

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

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

-
-
-status
- - -CouchDbSourceStatus - - -
-
-

GitHubSource -

-

-

GitHubSource is the Schema for the githubsources API

-

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

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

-
-ownerAndRepository
- -string - -
-

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

-
-eventTypes
- -[]string - -
-

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

-
-accessToken
- - -SecretValueFromSource - - -
-

AccessToken is the Kubernetes secret containing the GitHub -access token

-
-secretToken
- - -SecretValueFromSource - - -
-

SecretToken is the Kubernetes secret containing the GitHub -secret token

-
-githubAPIURL
- -string - -
-(Optional) -

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

-
-secure
- -bool - -
-(Optional) -

Secure can be set to true to configure the webhook to use https, -or false to use http. Omitting it relies on the scheme of the -Knative Service created (e.g. if auto-TLS is enabled it should -do the right thing).

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

GitLabSource -

-

-

GitLabSource is the Schema for the gitlabsources API

-

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

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

-
-projectUrl
- -string - -
-

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

-
-eventTypes
- -[]string - -
-

EventType is the type of event to receive from Gitlab. These -correspond to supported events to the add project hook -https://docs.gitlab.com/ee/api/projects.html#add-project-hook

-
-accessToken
- - -SecretValueFromSource - - -
-

AccessToken is the Kubernetes secret containing the GitLab -access token

-
-secretToken
- - -SecretValueFromSource - - -
-

SecretToken is the Kubernetes secret containing the GitLab -secret token

-
-sslverify
- -bool - -
-

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

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

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

-
-
-status
- - -GitLabSourceStatus - - -
-
-

PrometheusSource -

-

-

PrometheusSource is the Schema for the prometheussources API

-

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

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

-
-serverURL
- -string - -
-

ServerURL is the URL of the Prometheus server

-
-promQL
- -string - -
-

PromQL is the Prometheus query for this source

-
-authTokenFile
- -string - -
-(Optional) -

The name of the file containing the authenication token

-
-caCertConfigMap
- -string - -
-(Optional) -

The name of the config map containing the CA certificate of the -Prometheus service’s signer.

-
-schedule
- -string - -
-

A crontab-formatted schedule for running the PromQL query

-
-step
- -string - -
-(Optional) -

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

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

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

-
-
-status
- - -PrometheusSourceStatus - - -
-
-

AwsSqsSourceSpec -

-

-(Appears on: -AwsSqsSource) -

-

-

AwsSqsSourceSpec defines the desired state of the source.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-queueUrl
- -string - -
-

QueueURL of the SQS queue that we will poll from.

-
-awsCredsSecret
- - -Kubernetes core/v1.SecretKeySelector - - -
-(Optional) -

AwsCredsSecret is the credential to use to poll the AWS SQS

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

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

-
-sink
- - -Kubernetes core/v1.ObjectReference - - -
-(Optional) -

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

-
-serviceAccountName
- -string - -
-

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

-
-

AwsSqsSourceStatus -

-

-(Appears on: -AwsSqsSource) -

-

-

AwsSqsSourceStatus defines the observed state of the source.

-

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

-
-

CamelSourceOriginSpec -

-

-(Appears on: -CamelSourceSpec) -

-

-

CamelSourceOriginSpec is the integration flow to run

-

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

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

-
-flow
- - -Flow - - -
-

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

-
-

CamelSourceSpec -

-

-(Appears on: -CamelSource) -

-

-

CamelSourceSpec defines the desired state of CamelSource

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-source
- - -CamelSourceOriginSpec - - -
-

Source is the reference to the integration flow to run.

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

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

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

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

-
-

CamelSourceStatus -

-

-(Appears on: -CamelSource) -

-

-

CamelSourceStatus defines the observed state of CamelSource

-

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

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

-

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

-
-sinkUri
- -string - -
-(Optional) -

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

-
-

CouchDbSourceSpec -

-

-(Appears on: -CouchDbSource) -

-

-

CouchDbSourceSpec defines the desired state of CouchDbSource

-

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

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

-
-credentials
- - -Kubernetes core/v1.ObjectReference - - -
-

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

-
-feed
- - -FeedType - - -
-

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

-
-database
- -string - -
-

Database is the database to watch for changes

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

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

-
-

CouchDbSourceStatus -

-

-(Appears on: -CouchDbSource) -

-

-

CouchDbSourceStatus defines the observed state of CouchDbSource

-

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

-
-

FeedType -(string alias)

-

-(Appears on: -CouchDbSourceSpec) -

-

-

FeedType is the type of Feed

-

-

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

-

-(Appears on: -CamelSourceOriginSpec) -

-

-

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

-

-

GitHubSourceSpec -

-

-(Appears on: -GitHubSource) -

-

-

GitHubSourceSpec defines the desired state of GitHubSource

-

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

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

-
-ownerAndRepository
- -string - -
-

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

-
-eventTypes
- -[]string - -
-

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

-
-accessToken
- - -SecretValueFromSource - - -
-

AccessToken is the Kubernetes secret containing the GitHub -access token

-
-secretToken
- - -SecretValueFromSource - - -
-

SecretToken is the Kubernetes secret containing the GitHub -secret token

-
-githubAPIURL
- -string - -
-(Optional) -

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

-
-secure
- -bool - -
-(Optional) -

Secure can be set to true to configure the webhook to use https, -or false to use http. Omitting it relies on the scheme of the -Knative Service created (e.g. if auto-TLS is enabled it should -do the right thing).

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

-
-

GitHubSourceStatus -

-

-(Appears on: -GitHubSource) -

-

-

GitHubSourceStatus defines the observed state of GitHubSource

-

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

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

-

inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

-
-webhookIDKey
- -string - -
-

WebhookIDKey is the ID of the webhook registered with GitHub

-
-

GitLabSourceSpec -

-

-(Appears on: -GitLabSource) -

-

-

GitLabSourceSpec defines the desired state of GitLabSource

-

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

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

-
-projectUrl
- -string - -
-

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

-
-eventTypes
- -[]string - -
-

EventType is the type of event to receive from Gitlab. These -correspond to supported events to the add project hook -https://docs.gitlab.com/ee/api/projects.html#add-project-hook

-
-accessToken
- - -SecretValueFromSource - - -
-

AccessToken is the Kubernetes secret containing the GitLab -access token

-
-secretToken
- - -SecretValueFromSource - - -
-

SecretToken is the Kubernetes secret containing the GitLab -secret token

-
-sslverify
- -bool - -
-

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

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

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

-
-

GitLabSourceStatus -

-

-(Appears on: -GitLabSource) -

-

-

GitLabSourceStatus defines the observed state of GitLabSource

-

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

-
-Id
- -string - -
-

ID of the project hook registered with GitLab

-
+

KafkaLimitsSpec

@@ -3509,1079 +2039,8 @@ Source.

-

PrometheusSourceSpec -

-

-(Appears on: -PrometheusSource) -

-

-

PrometheusSourceSpec defines the desired state of PrometheusSource

-

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

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

-
-serverURL
- -string - -
-

ServerURL is the URL of the Prometheus server

-
-promQL
- -string - -
-

PromQL is the Prometheus query for this source

-
-authTokenFile
- -string - -
-(Optional) -

The name of the file containing the authenication token

-
-caCertConfigMap
- -string - -
-(Optional) -

The name of the config map containing the CA certificate of the -Prometheus service’s signer.

-
-schedule
- -string - -
-

A crontab-formatted schedule for running the PromQL query

-
-step
- -string - -
-(Optional) -

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

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

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

-
-

PrometheusSourceStatus -

-

-(Appears on: -PrometheusSource) -

-

-

PrometheusSourceStatus defines the observed state of PrometheusSource

-

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

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

-

inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

-
-

SecretValueFromSource -

-

-(Appears on: -GitHubSourceSpec) -

-

-

SecretValueFromSource represents the source of a secret value

-

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

The Secret key to select from.

-
-

SecretValueFromSource -

-

-(Appears on: -GitLabSourceSpec) -

-

-

SecretValueFromSource represents the source of a secret value

-

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

The Secret key to select from.

-
-
-

bindings.knative.dev/v1alpha1

-

-

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

-

-Resource Types: - -

GitHubBinding -

-

-

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

-

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

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

-
-accessToken
- - -SecretValueFromSource - - -
-

AccessToken is the Kubernetes secret containing the GitHub -access token

-
-
-status
- - -GitHubBindingStatus - - -
-
-

GitLabBinding -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string
- -bindings.knative.dev/v1alpha1 - -
-kind
-string -
GitLabBinding
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -GitLabBindingSpec - - -
-
-
- - - - - - - - - -
-BindingSpec
- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -
-

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

-
-accessToken
- - -SecretValueFromSource - - -
-

AccessToken is the Kubernetes secret containing the GitLab -access token

-
-
-status
- - -GitLabBindingStatus - - -
-
-

GitHubBindingSpec -

-

-(Appears on: -GitHubBinding) -

-

-

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

-

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

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

-
-accessToken
- - -SecretValueFromSource - - -
-

AccessToken is the Kubernetes secret containing the GitHub -access token

-
-

GitHubBindingStatus -

-

-(Appears on: -GitHubBinding) -

-

-

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

-

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

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

-
-

GitLabBindingSpec -

-

-(Appears on: -GitLabBinding) -

-

-

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

-

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

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

-
-accessToken
- - -SecretValueFromSource - - -
-

AccessToken is the Kubernetes secret containing the GitLab -access token

-
-

GitLabBindingStatus -

-

-(Appears on: -GitLabBinding) -

-

-

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

-

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

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

-
-

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

-

-

SecretValueFromSource represents the source of a secret value

-

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

The Secret key to select from.

-
-

SecretValueFromSource -

-

-(Appears on: -GitHubBindingSpec) -

-

-

SecretValueFromSource represents the source of a secret value

-

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

The Secret key to select from.

-
-

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.

-

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

diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index c0bfeab9c..7447acb08 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -1,18 +1,6 @@

Packages:

-

messaging.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 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.

-

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

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.

-
-

InMemoryChannel -

-

-

InMemoryChannel is a resource representing an in memory channel

-

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

Spec defines the desired state of the Channel.

-
-
- - - - - -
-ChannelableSpec
- - -ChannelableSpec - - -
-

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

-

Channel conforms to Duck type Channelable.

-
-
-status
- - -InMemoryChannelStatus - - -
-(Optional) -

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

-
-

Subscription -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string
- -messaging.knative.dev/v1beta1 - -
-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 - - -
-

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

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

-
-

ChannelStatus -

-

-(Appears on: -Channel) -

-

-

ChannelStatus represents the current state of a Channel.

-

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

-
-

ChannelTemplateSpec -

-

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

-

-

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

-
-
- -
-
-

ChannelTemplateSpecInternal -

-

-

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

-

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

-

-(Appears on: -InMemoryChannel) -

-

-

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

-

- - - - - - - - - - - - - -
FieldDescription
-ChannelableSpec
- - -ChannelableSpec - - -
-

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

-

Channel conforms to Duck type Channelable.

-
-

InMemoryChannelStatus -

-

-(Appears on: -InMemoryChannel) -

-

-

ChannelStatus represents the current state of a Channel.

-

- - - - - - - - - - - - - -
FieldDescription
-ChannelableStatus
- - -ChannelableStatus - - -
-

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

-

Channel conforms to Duck type Channelable.

-
-

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

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

-

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

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

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

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

-
-

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

-

-

ApiServerSource is the Schema for the apiserversources API

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string
- -sources.knative.dev/v1alpha1 - -
-kind
-string -
ApiServerSource
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ApiServerSourceSpec - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-resources
- - -[]ApiServerResource - - -
-

Resources is the list of resources to watch

-
-serviceAccountName
- -string - -
-(Optional) -

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

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

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

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

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

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

-
-
-status
- - -ApiServerSourceStatus - - -
-
-

SinkBinding -

-

-

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

-

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

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

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

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

-
-
-status
- - -SinkBindingStatus - - -
-
-

ApiServerResource -

-

-(Appears on: -ApiServerSourceSpec) -

-

-

ApiServerResource defines the resource to watch

-

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

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

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

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

ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. -Deprecated: Per-resource owner refs will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

-
-controller
- -bool - -
-

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

-
-

ApiServerSourceSpec -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceSpec defines the desired state of ApiServerSource

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-resources
- - -[]ApiServerResource - - -
-

Resources is the list of resources to watch

-
-serviceAccountName
- -string - -
-(Optional) -

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

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

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

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

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

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

-
-

ApiServerSourceStatus -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceStatus defines the observed state of ApiServerSource

-

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

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

-

inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

-
-

SinkBindingSpec -

-

-(Appears on: -SinkBinding) -

-

-

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

-

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

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

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

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

-
-

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

-
-
-

sources.knative.dev/v1alpha2

-

-

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

-

-Resource Types: - -

ApiServerSource -

-

-

ApiServerSource is the Schema for the apiserversources API

-

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

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

-

inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

-
-resources
- - -[]APIVersionKindSelector - - -
-

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

-
-owner
- - -APIVersionKind - - -
-(Optional) -

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

-
-mode
- -string - -
-(Optional) -

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

-
-serviceAccountName
- -string - -
-(Optional) -

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

-
-
-status
- - -ApiServerSourceStatus - - -
-
-

ContainerSource -

-

-

ContainerSource is the Schema for the containersources API

-

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

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

-

inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

-
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -
-

Template describes the pods that will be created

-
-
-status
- - -ContainerSourceStatus - - -
-
-

PingSource -

-

-

PingSource is the Schema for the PingSources API.

-

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

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

-

inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

-
-schedule
- -string - -
-(Optional) -

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

-
-jsonData
- -string - -
-(Optional) -

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

-
-
-status
- - -PingSourceStatus - - -
-
-

SinkBinding -

-

-

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

-

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

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

-

inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

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

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

-

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

-
-
-status
- - -SinkBindingStatus - - -
-
-

APIVersionKind -

-

-(Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) -

-

-

APIVersionKind is an APIVersion and Kind tuple.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
- -string - -
-

APIVersion - the API version of the resource to watch.

-
-kind
- -string - -
-

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

-
-

APIVersionKindSelector -

-

-(Appears on: -ApiServerSourceSpec) -

-

-

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
- -string - -
-

APIVersion - the API version of the resource to watch.

-
-kind
- -string - -
-

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

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

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

-
-

ApiServerSourceSpec -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceSpec defines the desired state of ApiServerSource

-

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

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

-

inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

-
-resources
- - -[]APIVersionKindSelector - - -
-

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

-
-owner
- - -APIVersionKind - - -
-(Optional) -

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

-
-mode
- -string - -
-(Optional) -

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

-
-serviceAccountName
- -string - -
-(Optional) -

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

-
-

ApiServerSourceStatus -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceStatus defines the observed state of ApiServerSource

-

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

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

-

inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

-
-

ContainerSourceSpec -

-

-(Appears on: -ContainerSource) -

-

-

ContainerSourceSpec defines the desired state of ContainerSource

-

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

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

-

inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

-
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -
-

Template describes the pods that will be created

-
-

ContainerSourceStatus -

-

-(Appears on: -ContainerSource) -

-

-

ContainerSourceStatus defines the observed state of ContainerSource

-

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

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

-

inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

-
-

PingSourceSpec -

-

-(Appears on: -PingSource) -

-

-

PingSourceSpec defines the desired state of the PingSource.

-

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

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

-

inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

-
-schedule
- -string - -
-(Optional) -

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

-
-jsonData
- -string - -
-(Optional) -

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

-
-

PingSourceStatus -

-

-(Appears on: -PingSource) -

-

-

PingSourceStatus defines the observed state of PingSource.

-

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

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

-

inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

-
-

SinkBindingSpec -

-

-(Appears on: -SinkBinding) -

-

-

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

-

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

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

-

inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

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

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

-

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

-
-

SinkBindingStatus -

-

-(Appears on: -SinkBinding) -

-

-

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

-

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

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

-

inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

-
-
-

configs.internal.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

ConfigMapPropagation -

-

-

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

-

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

Spec defines the desired state of the ConfigMapPropagation

-
-
- - - - - - - - - -
-originalNamespace
- -string - -
-

OriginalNamespace is the namespace where the original configMaps are in

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

Selector only selects original configMaps with corresponding labels

-
-
-status
- - -ConfigMapPropagationStatus - - -
-(Optional) -

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

-
-

ConfigMapPropagationSpec -

-

-(Appears on: -ConfigMapPropagation) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-originalNamespace
- -string - -
-

OriginalNamespace is the namespace where the original configMaps are in

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

Selector only selects original configMaps with corresponding labels

-
-

ConfigMapPropagationStatus -

-

-(Appears on: -ConfigMapPropagation) -

-

-

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

-

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

-
-copyConfigmaps
- - -[]ConfigMapPropagationStatusCopyConfigMap - - -
-(Optional) -

CopyConfigMaps is the status for each copied configmap.

-
-

ConfigMapPropagationStatusCopyConfigMap -

-

-(Appears on: -ConfigMapPropagationStatus) -

-

-

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-name
- -string - -
-

Name is copy configmap’s name

-
-source
- -string - -
-

Source is “originalNamespace/originalConfigMapName”

-
-operation
- -string - -
-

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

-
-ready
- -string - -
-

Ready represents the operation is ready or not

-
-reason
- -string - -
-

Reason indicates reasons if the operation is not ready

-
-resourceVersionFromSource
- -string - -
-

ResourceVersion is the resourceVersion of original configmap

-
-

duck.knative.dev/v1

Package v1 is the v1 version of the API.

@@ -2847,8 +148,8 @@ ChannelableStatus

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

@@ -2897,8 +198,8 @@ DeliverySpec

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

@@ -2977,13 +278,11 @@ Failed messages are delivered here.

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

@@ -3165,8 +464,7 @@ configured as to be compatible with Subscribable contract.

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

@@ -3199,8 +497,7 @@ configured as to be compatible with Subscribable contract.

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

@@ -3316,8 +613,7 @@ DeliverySpec

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

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

@@ -3490,8 +786,8 @@ ChannelableStatus

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

@@ -3540,8 +836,8 @@ DeliverySpec

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

@@ -3620,14 +916,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)

@@ -3809,8 +1105,8 @@ configured as to be compatible with Subscribable contract.

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

@@ -3843,8 +1139,8 @@ configured as to be compatible with Subscribable contract.

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

@@ -3960,8 +1256,8 @@ DeliverySpec

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

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

@@ -4510,1767 +1806,6 @@ knative.dev/pkg/apis.URL
-

flows.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

Parallel -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -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
- - -ParallelStatus - - -
-(Optional) -

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

-
-

ParallelBranch -

-

-(Appears on: -ParallelSpec) -

-

-

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

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

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

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

-
-

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

SubscriptionStatus corresponds to the subscriber subscription status.

-
-

ParallelChannelStatus -

-

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

-

-

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

-
-

ParallelSpec -

-

-(Appears on: -Parallel) -

-

-

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

-
-

ParallelStatus -

-

-(Appears on: -Parallel) -

-

-

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.

-
-ingressChannelStatus
- - -ParallelChannelStatus - - -
-

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}

-
-

ParallelSubscriptionStatus -

-

-(Appears on: -ParallelBranchStatus) -

-

-

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

-

-

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

-

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

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.

-
-

SequenceChannelStatus -

-

-(Appears on: -SequenceStatus) -

-

-

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

-
-

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

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

-
-

SequenceStatus -

-

-(Appears on: -Sequence) -

-

-

SequenceStatus represents the current state of a Sequence.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
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
- - -[]SequenceSubscriptionStatus - - -
-

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.

-
-
-

duck.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

Channelable -

-

-

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

-

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

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

-
-
- - - - - - - - - -
-SubscribableTypeSpec
- - -SubscribableTypeSpec - - -
-

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

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

DeliverySpec contains options controlling the event delivery

-
-
-status
- - -ChannelableStatus - - -
-
-

ChannelableCombined -

-

-

ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of -v1alpha1, v1beta1 and v1 duck types. This is not to be used by resource writers and is -only used by Subscription Controller to synthesize patches and read the Status -of the Channelable Resources. -This is not a real resource.

-

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

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

-
-
- - - - - - - - - - - - - - - - - - - - - -
-SubscribableTypeSpec
- - -SubscribableTypeSpec - - -
-

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

DeliverySpec contains options controlling the event delivery -for the v1beta1 spec compatibility.

-
-SubscribableSpecv1
- - -SubscribableSpec - - -
-

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

-

SubscribableSpecv1 is for the v1 spec compatibility.

-
-deliveryv1
- - -DeliverySpec - - -
-(Optional) -

DeliverySpecv1 contains options controlling the event delivery -for the v1 spec compatibility.

-
-
-status
- - -ChannelableCombinedStatus - - -
-
-

ChannelableCombinedSpec -

-

-(Appears on: -ChannelableCombined) -

-

-

ChannelableSpec contains Spec of the Channelable object

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-SubscribableTypeSpec
- - -SubscribableTypeSpec - - -
-

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

DeliverySpec contains options controlling the event delivery -for the v1beta1 spec compatibility.

-
-SubscribableSpecv1
- - -SubscribableSpec - - -
-

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

-

SubscribableSpecv1 is for the v1 spec compatibility.

-
-deliveryv1
- - -DeliverySpec - - -
-(Optional) -

DeliverySpecv1 contains options controlling the event delivery -for the v1 spec compatibility.

-
-

ChannelableCombinedStatus -

-

-(Appears on: -ChannelableCombined) -

-

-

ChannelableStatus contains the Status of a Channelable object.

-

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

-

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

-
-SubscribableTypeStatus
- - -SubscribableTypeStatus - - -
-

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

-
-SubscribableStatusv1
- - -SubscribableStatus - - -
-

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

-

SubscribableStatusv1 is the v1 part of the Subscribers status.

-
-errorChannel
- - -Kubernetes core/v1.ObjectReference - - -
-(Optional) -

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

-
-

ChannelableSpec -

-

-(Appears on: -Channelable) -

-

-

ChannelableSpec contains Spec of the Channelable object

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-SubscribableTypeSpec
- - -SubscribableTypeSpec - - -
-

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

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

DeliverySpec contains options controlling the event delivery

-
-

ChannelableStatus -

-

-(Appears on: -Channelable) -

-

-

ChannelableStatus contains the Status of a Channelable object.

-

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

-

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

-
-SubscribableTypeStatus
- - -SubscribableTypeStatus - - -
-

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

-

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

-
-errorChannel
- - -Kubernetes core/v1.ObjectReference - - -
-(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.

-

- - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-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
-subscribers
- - -[]SubscriberSpec - - -
-

This is the list of subscriptions for this subscribable.

-
-

SubscribableStatus -

-

-(Appears on: -SubscribableTypeStatus) -

-

-

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

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-subscribers
- - -[]SubscriberStatus - - -
-

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

-
-subscribersv1
- - -[]SubscriberStatus - - -
-

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

-
-

SubscribableType -

-

-

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.

-

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

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

-
-
- - - - - -
-subscribable
- - -Subscribable - - -
-
-
-status
- - -SubscribableTypeStatus - - -
-

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

-
-

SubscribableTypeSpec -

-

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

-

-

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

-

- - - - - - - - - - - - - -
FieldDescription
-subscribable
- - -Subscribable - - -
-
-

SubscribableTypeStatus -

-

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

-

-

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

-

- - - - - - - - - - - - - -
FieldDescription
-subscribableStatus
- - -SubscribableStatus - - -
-
-

SubscriberSpec -

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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 - -
-(Optional) -
-replyURI
- -knative.dev/pkg/apis.URL - -
-(Optional) -
-deadLetterSink
- -knative.dev/pkg/apis.URL - -
-(Optional) -
-delivery
- - -DeliverySpec - - -
-(Optional) -
-deliveryv1
- - -DeliverySpec - - -
-(Optional) -
-

eventing.knative.dev/v1beta1

Package v1beta1 is the v1beta1 version of the API.

@@ -7042,839 +2577,6 @@ knative.dev/pkg/apis.URL
-

flows.knative.dev/v1

-

-

Package v1 is the v1 version of the API.

-

-Resource Types: - -

Parallel -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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
- - -ParallelStatus - - -
-(Optional) -

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

-
-

ParallelBranch -

-

-(Appears on: -ParallelSpec) -

-

-

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

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

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

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

-
-

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

SubscriptionStatus corresponds to the subscriber subscription status.

-
-

ParallelChannelStatus -

-

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

-

-

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

-
-

ParallelSpec -

-

-(Appears on: -Parallel) -

-

-

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

-
-

ParallelStatus -

-

-(Appears on: -Parallel) -

-

-

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.

-
-ingressChannelStatus
- - -ParallelChannelStatus - - -
-

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}

-
-

ParallelSubscriptionStatus -

-

-(Appears on: -ParallelBranchStatus) -

-

-

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

-

-

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

-

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

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.

-
-

SequenceChannelStatus -

-

-(Appears on: -SequenceStatus) -

-

-

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

-
-

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

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

-
-

SequenceStatus -

-

-(Appears on: -Sequence) -

-

-

SequenceStatus represents the current state of a Sequence.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
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
- - -[]SequenceSubscriptionStatus - - -
-

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.

-
-

messaging.knative.dev/v1

Package v1 is the v1 version of the API.

@@ -8340,8 +3042,8 @@ knative.dev/pkg/apis/duck/v1.KReference

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

@@ -8693,6 +3395,576 @@ knative.dev/pkg/apis.URL


+

sources.knative.dev/v1alpha1

+

+

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

+

+Resource Types: + +

ApiServerSource +

+

+

ApiServerSource is the Schema for the apiserversources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +sources.knative.dev/v1alpha1 + +
+kind
+string +
ApiServerSource
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ApiServerSourceSpec + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+resources
+ + +[]ApiServerResource + + +
+

Resources is the list of resources to watch

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

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

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

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

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

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

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

+
+
+status
+ + +ApiServerSourceStatus + + +
+
+

SinkBinding +

+

+

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

+

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

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

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

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

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

ApiServerResource +

+

+(Appears on: +ApiServerSourceSpec) +

+

+

ApiServerResource defines the resource to watch

+

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

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

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

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

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

+
+controller
+ +bool + +
+

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

+
+

ApiServerSourceSpec +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceSpec defines the desired state of ApiServerSource

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+resources
+ + +[]ApiServerResource + + +
+

Resources is the list of resources to watch

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

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

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

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

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

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

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

+
+

ApiServerSourceStatus +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

+

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

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

+

inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.

+
+

SinkBindingSpec +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

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

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

+
+

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

+
+

sources.knative.dev/v1beta1

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

@@ -9741,7 +5013,4624 @@ 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

+

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

Spec defines the desired state of the ConfigMapPropagation

+
+
+ + + + + + + + + +
+originalNamespace
+ +string + +
+

OriginalNamespace is the namespace where the original configMaps are in

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

Selector only selects original configMaps with corresponding labels

+
+
+status
+ + +ConfigMapPropagationStatus + + +
+(Optional) +

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

+
+

ConfigMapPropagationSpec +

+

+(Appears on: +ConfigMapPropagation) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+originalNamespace
+ +string + +
+

OriginalNamespace is the namespace where the original configMaps are in

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

Selector only selects original configMaps with corresponding labels

+
+

ConfigMapPropagationStatus +

+

+(Appears on: +ConfigMapPropagation) +

+

+

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

+

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

+
+copyConfigmaps
+ + +[]ConfigMapPropagationStatusCopyConfigMap + + +
+(Optional) +

CopyConfigMaps is the status for each copied configmap.

+
+

ConfigMapPropagationStatusCopyConfigMap +

+

+(Appears on: +ConfigMapPropagationStatus) +

+

+

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +
+

Name is copy configmap’s name

+
+source
+ +string + +
+

Source is “originalNamespace/originalConfigMapName”

+
+operation
+ +string + +
+

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

+
+ready
+ +string + +
+

Ready represents the operation is ready or not

+
+reason
+ +string + +
+

Reason indicates reasons if the operation is not ready

+
+resourceVersionFromSource
+ +string + +
+

ResourceVersion is the resourceVersion of original configmap

+
+
+

duck.knative.dev/v1alpha1

+

+

Package v1alpha1 is the v1alpha1 version of the API.

+

+Resource Types: + +

Channelable +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ChannelableSpec + + +
+

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

+
+
+ + + + + + + + + +
+SubscribableTypeSpec
+ + +SubscribableTypeSpec + + +
+

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

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

DeliverySpec contains options controlling the event delivery

+
+
+status
+ + +ChannelableStatus + + +
+
+

ChannelableCombined +

+

+

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.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ChannelableCombinedSpec + + +
+

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

+
+
+ + + + + + + + + + + + + +
+SubscribableTypeSpec
+ + +SubscribableTypeSpec + + +
+

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

DeliverySpec contains options controlling the event delivery

+
+
+status
+ + +ChannelableCombinedStatus + + +
+
+

ChannelableCombinedSpec +

+

+(Appears on: +ChannelableCombined) +

+

+

ChannelableSpec contains Spec of the Channelable object

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+SubscribableTypeSpec
+ + +SubscribableTypeSpec + + +
+

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

DeliverySpec contains options controlling the event delivery

+
+

ChannelableCombinedStatus +

+

+(Appears on: +ChannelableCombined) +

+

+

ChannelableStatus contains the Status of a Channelable object.

+

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

+

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

+
+SubscribableTypeStatus
+ + +SubscribableTypeStatus + + +
+

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

+
+errorChannel
+ + +Kubernetes core/v1.ObjectReference + + +
+(Optional) +

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

+
+

ChannelableSpec +

+

+(Appears on: +Channelable) +

+

+

ChannelableSpec contains Spec of the Channelable object

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+SubscribableTypeSpec
+ + +SubscribableTypeSpec + + +
+

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

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

DeliverySpec contains options controlling the event delivery

+
+

ChannelableStatus +

+

+(Appears on: +Channelable) +

+

+

ChannelableStatus contains the Status of a Channelable object.

+

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

+

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

+
+SubscribableTypeStatus
+ + +SubscribableTypeStatus + + +
+

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

+

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

+
+errorChannel
+ + +Kubernetes core/v1.ObjectReference + + +
+(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.

+

+ + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+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
+subscribers
+ + +[]SubscriberSpec + + +
+

This is the list of subscriptions for this subscribable.

+
+

SubscribableStatus +

+

+(Appears on: +SubscribableTypeStatus) +

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+subscribers
+ + +[]SubscriberStatus + + +
+

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

+
+

SubscribableType +

+

+

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.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +SubscribableTypeSpec + + +
+

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

+
+
+ + + + + +
+subscribable
+ + +Subscribable + + +
+
+
+status
+ + +SubscribableTypeStatus + + +
+

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

+
+

SubscribableTypeSpec +

+

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

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+subscribable
+ + +Subscribable + + +
+
+

SubscribableTypeStatus +

+

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

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+subscribableStatus
+ + +SubscribableStatus + + +
+
+

SubscriberSpec +

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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 + +
+(Optional) +
+replyURI
+ +knative.dev/pkg/apis.URL + +
+(Optional) +
+deadLetterSink
+ +knative.dev/pkg/apis.URL + +
+(Optional) +
+delivery
+ + +DeliverySpec + + +
+(Optional) +
+
+

flows.knative.dev/v1

+

+

Package v1 is the v1 version of the API.

+

+Resource Types: + +

Parallel +

+

+

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

+

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

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

+
+

ParallelBranch +

+

+(Appears on: +ParallelSpec) +

+

+

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

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

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

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

+
+

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

SubscriptionStatus corresponds to the subscriber subscription status.

+
+

ParallelChannelStatus +

+

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

+

+

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

+
+

ParallelSpec +

+

+(Appears on: +Parallel) +

+

+

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

+
+

ParallelStatus +

+

+(Appears on: +Parallel) +

+

+

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.

+
+ingressChannelStatus
+ + +ParallelChannelStatus + + +
+

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}

+
+

ParallelSubscriptionStatus +

+

+(Appears on: +ParallelBranchStatus) +

+

+

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

+

+

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

+

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

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.

+
+

SequenceChannelStatus +

+

+(Appears on: +SequenceStatus) +

+

+

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

+
+

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

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

+
+

SequenceStatus +

+

+(Appears on: +Sequence) +

+

+

SequenceStatus represents the current state of a Sequence.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
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
+ + +[]SequenceSubscriptionStatus + + +
+

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.

+
+
+

flows.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

Parallel +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +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
+ + +ParallelStatus + + +
+(Optional) +

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

+
+

ParallelBranch +

+

+(Appears on: +ParallelSpec) +

+

+

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

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

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

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

+
+

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

SubscriptionStatus corresponds to the subscriber subscription status.

+
+

ParallelChannelStatus +

+

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

+

+

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

+
+

ParallelSpec +

+

+(Appears on: +Parallel) +

+

+

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

+
+

ParallelStatus +

+

+(Appears on: +Parallel) +

+

+

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.

+
+ingressChannelStatus
+ + +ParallelChannelStatus + + +
+

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}

+
+

ParallelSubscriptionStatus +

+

+(Appears on: +ParallelBranchStatus) +

+

+

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

+

+

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

+

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

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.

+
+

SequenceChannelStatus +

+

+(Appears on: +SequenceStatus) +

+

+

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

+
+

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

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

+
+

SequenceStatus +

+

+(Appears on: +Sequence) +

+

+

SequenceStatus represents the current state of a Sequence.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
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
+ + +[]SequenceSubscriptionStatus + + +
+

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.

+
+
+

messaging.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 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.

+

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

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.

+
+

InMemoryChannel +

+

+

InMemoryChannel is a resource representing an in memory channel

+

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

Spec defines the desired state of the Channel.

+
+
+ + + + + +
+ChannelableSpec
+ + +ChannelableSpec + + +
+

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

+

Channel conforms to Duck type Channelable.

+
+
+status
+ + +InMemoryChannelStatus + + +
+(Optional) +

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

+
+

Subscription +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +messaging.knative.dev/v1beta1 + +
+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 + + +
+

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

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

+
+

ChannelStatus +

+

+(Appears on: +Channel) +

+

+

ChannelStatus represents the current state of a Channel.

+

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

+
+

ChannelTemplateSpec +

+

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

+

+

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

+
+
+ +
+
+

ChannelTemplateSpecInternal +

+

+

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

+

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

+

+(Appears on: +InMemoryChannel) +

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+ChannelableSpec
+ + +ChannelableSpec + + +
+

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

+

Channel conforms to Duck type Channelable.

+
+

InMemoryChannelStatus +

+

+(Appears on: +InMemoryChannel) +

+

+

ChannelStatus represents the current state of a Channel.

+

+ + + + + + + + + + + + + +
FieldDescription
+ChannelableStatus
+ + +ChannelableStatus + + +
+

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

+

Channel conforms to Duck type Channelable.

+
+

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

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

+

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

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

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

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

+
+

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
+ + +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 fully resolved URI for spec.subscriber.

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

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

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

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

+
+
+

sources.knative.dev/v1alpha2

+

+

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

+

+Resource Types: + +

ApiServerSource +

+

+

ApiServerSource is the Schema for the apiserversources API

+

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

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

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

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

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

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

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

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

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

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

+
+
+status
+ + +ApiServerSourceStatus + + +
+
+

ContainerSource +

+

+

ContainerSource is the Schema for the containersources API

+

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

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

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

Template describes the pods that will be created

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

PingSource +

+

+

PingSource is the Schema for the PingSources API.

+

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

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

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

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

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

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

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

SinkBinding +

+

+

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

+

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

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

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

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

+

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

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

APIVersionKind +

+

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

+

+

APIVersionKind is an APIVersion and Kind tuple.

+

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

APIVersion - the API version of the resource to watch.

+
+kind
+ +string + +
+

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

+
+

APIVersionKindSelector +

+

+(Appears on: +ApiServerSourceSpec) +

+

+

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

+

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

APIVersion - the API version of the resource to watch.

+
+kind
+ +string + +
+

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

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

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

+
+

ApiServerSourceSpec +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceSpec defines the desired state of ApiServerSource

+

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

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

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

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

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

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

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

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

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

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

+
+

ApiServerSourceStatus +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

+

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

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

+

inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.

+
+

ContainerSourceSpec +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceSpec defines the desired state of ContainerSource

+

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

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

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

Template describes the pods that will be created

+
+

ContainerSourceStatus +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceStatus defines the observed state of ContainerSource

+

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

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

+

inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.

+
+

PingSourceSpec +

+

+(Appears on: +PingSource) +

+

+

PingSourceSpec defines the desired state of the PingSource.

+

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

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

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

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

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

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

+
+

PingSourceStatus +

+

+(Appears on: +PingSource) +

+

+

PingSourceStatus defines the observed state of PingSource.

+

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

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

+

inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.

+
+

SinkBindingSpec +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

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

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

+

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

+
+

SinkBindingStatus +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

+

inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.

+
+

Generated with gen-crd-api-reference-docs -on git commit 9f3fb3ff. +on git commit 74b9bed2.

diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index e93953bf9..2d4b730a9 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -1,468 +1,15 @@

Packages:

-

serving.knative.dev/v1beta1

-

-

-Resource Types: - -

Configuration -

-

-

Configuration represents the “floating HEAD” of a linear history of Revisions. -Users create new Revisions by updating the Configuration’s spec. -The “latest created” revision’s name is available under status, as is the -“latest ready” revision’s name. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string
- -serving.knative.dev/v1beta1 - -
-kind
-string -
Configuration
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ConfigurationSpec - - -
-(Optional) -
-
- - - - - -
-template
- - -RevisionTemplateSpec - - -
-(Optional) -

Template holds the latest specification for the Revision to be stamped out.

-
-
-status
- - -ConfigurationStatus - - -
-(Optional) -
-

Revision -

-

-

Revision is an immutable snapshot of code and configuration. A revision -references a container image. Revisions are created by updates to a -Configuration.

-

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string
- -serving.knative.dev/v1beta1 - -
-kind
-string -
Revision
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -RevisionSpec - - -
-(Optional) -
-
- - - - - - - - - - - - - -
-PodSpec
- - -Kubernetes core/v1.PodSpec - - -
-

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

-
-containerConcurrency
- -int64 - -
-(Optional) -

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) -requests per container of the Revision. Defaults to 0 which means -concurrency to the application is not limited, and the system decides the -target concurrency for the autoscaler.

-
-timeoutSeconds
- -int64 - -
-(Optional) -

TimeoutSeconds holds the max duration the instance is allowed for -responding to a request. If unspecified, a system default will -be provided.

-
-
-status
- - -RevisionStatus - - -
-(Optional) -
-

Route -

-

-

Route is responsible for configuring ingress over a collection of Revisions. -Some of the Revisions a Route distributes traffic over may be specified by -referencing the Configuration responsible for creating them; in these cases -the Route is additionally responsible for monitoring the Configuration for -“latest ready revision” changes, and smoothly rolling out latest revisions. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

-

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

Spec holds the desired state of the Route (from the client).

-
-
- - - - - -
-traffic
- - -[]TrafficTarget - - -
-(Optional) -

Traffic specifies how to distribute traffic over a collection of -revisions and configurations.

-
-
-status
- - -RouteStatus - - -
-(Optional) -

Status communicates the observed state of the Route (from the controller).

-
-

Service -

-

-

Service acts as a top-level container that manages a Route and Configuration -which implement a network service. Service exists to provide a singular -abstraction which can be access controlled, reasoned about, and which -encapsulates software lifecycle decisions such as rollout policy and -team resource ownership. Service acts only as an orchestrator of the -underlying Routes and Configurations (much as a kubernetes Deployment -orchestrates ReplicaSets), and its usage is optional but recommended.

-

The Service’s controller will track the statuses of its owned Configuration -and Route, reflecting their statuses and conditions as its own.

-

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service

-

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

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

-

ServiceSpec inlines an unrestricted ConfigurationSpec.

-
-RouteSpec
- - -RouteSpec - - -
-

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

-

ServiceSpec inlines RouteSpec and restricts/defaults its fields -via webhook. In particular, this spec can only reference this -Service’s configuration and revisions (which also influences -defaults).

-
-
-status
- - -ServiceStatus - - -
-(Optional) -
-

serving.knative.dev/v1

@@ -919,8 +466,8 @@ ServiceStatus

(Appears on: -Configuration, Configuration, +Configuration, ServiceSpec)

@@ -954,8 +501,8 @@ RevisionTemplateSpec

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

ConfigurationStatus communicates the observed state of the Configuration (from the controller).

@@ -1002,7 +549,7 @@ ConfigurationStatusFields

(Appears on: -ConfigurationStatus, +ConfigurationStatus, ServiceStatus)

@@ -1046,14 +593,14 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.< -

ContainerStatuses +

ContainerStatus

(Appears on: RevisionStatus)

-

ContainerStatuses holds the information of container name and image digest value

+

ContainerStatus holds the information of container name and image digest value

@@ -1089,9 +636,9 @@ string

(Appears on: -Revision, +Revision, Revision, -RevisionSpec, +RevisionSpec, RevisionTemplateSpec)

@@ -1155,8 +702,8 @@ be provided.

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

RevisionStatus communicates the observed state of the Revision (from the controller).

@@ -1233,8 +780,8 @@ ref @@ -1350,8 +897,8 @@ be provided.

(Appears on: -Route, Route, +Route, ServiceSpec)

@@ -1434,7 +981,7 @@ RouteStatusFields

(Appears on: -RouteStatus, +RouteStatus, ServiceStatus)

@@ -1503,8 +1050,8 @@ LatestReadyRevisionName that we last observed.

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

ServiceSpec represents the configuration for the Service object. @@ -1564,8 +1111,8 @@ defaults).

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

ServiceStatus represents the Status stanza of the Service resource.

@@ -1631,8 +1178,8 @@ specific to RouteStatus.

(Appears on: -RouteSpec, -RouteStatusFields, +RouteSpec, +RouteStatusFields, TrafficTarget)

@@ -2116,7 +1663,7 @@ RouteSpec

containerStatuses
- -[]ContainerStatuses + +[]ContainerStatus
-generation
+DeprecatedGeneration
int64 @@ -2400,10 +1947,10 @@ string

(Appears on: -Configuration, -PinnedType, -ReleaseType, -RunLatestType, +Configuration, +PinnedType, +ReleaseType, +RunLatestType, ServiceSpec)

@@ -2532,7 +2079,7 @@ ConfigurationStatusFields

(Appears on: -ConfigurationStatus, +ConfigurationStatus, ServiceStatus)

@@ -2576,14 +2123,14 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.<

-

ContainerStatuses +

ContainerStatus

(Appears on: RevisionStatus)

-

ContainerStatuses holds the information of container name and image digest value

+

ContainerStatus holds the information of container name and image digest value

@@ -2748,7 +2295,7 @@ come from a single configuration.

(Appears on: -Revision, +Revision, RevisionTemplateSpec)

@@ -2912,8 +2459,8 @@ ref

@@ -3052,7 +2599,7 @@ environment:

(Appears on: -Route, +Route, ServiceSpec)

@@ -3068,7 +2615,7 @@ environment:

containerStatuses
- -[]ContainerStatuses + +[]ContainerStatus
-generation
+DeprecatedGeneration
int64 @@ -3149,7 +2696,7 @@ RouteStatusFields

(Appears on: -RouteStatus, +RouteStatus, ServiceStatus)

@@ -3471,7 +3018,7 @@ ConfigurationStatusFields

(Appears on: -RouteSpec, +RouteSpec, RouteStatusFields)

@@ -3518,7 +3065,460 @@ Ultimately all non-v1 fields will be deprecated.


+

serving.knative.dev/v1beta1

+

+

+Resource Types: + +

Configuration +

+

+

Configuration represents the “floating HEAD” of a linear history of Revisions. +Users create new Revisions by updating the Configuration’s spec. +The “latest created” revision’s name is available under status, as is the +“latest ready” revision’s name. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +serving.knative.dev/v1beta1 + +
+kind
+string +
Configuration
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ConfigurationSpec + + +
+(Optional) +
+
+ + + + + +
+template
+ + +RevisionTemplateSpec + + +
+(Optional) +

Template holds the latest specification for the Revision to be stamped out.

+
+
+status
+ + +ConfigurationStatus + + +
+(Optional) +
+

Revision +

+

+

Revision is an immutable snapshot of code and configuration. A revision +references a container image. Revisions are created by updates to a +Configuration.

+

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +serving.knative.dev/v1beta1 + +
+kind
+string +
Revision
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +RevisionSpec + + +
+(Optional) +
+
+ + + + + + + + + + + + + +
+PodSpec
+ + +Kubernetes core/v1.PodSpec + + +
+

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

+
+containerConcurrency
+ +int64 + +
+(Optional) +

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) +requests per container of the Revision. Defaults to 0 which means +concurrency to the application is not limited, and the system decides the +target concurrency for the autoscaler.

+
+timeoutSeconds
+ +int64 + +
+(Optional) +

TimeoutSeconds holds the max duration the instance is allowed for +responding to a request. If unspecified, a system default will +be provided.

+
+
+status
+ + +RevisionStatus + + +
+(Optional) +
+

Route +

+

+

Route is responsible for configuring ingress over a collection of Revisions. +Some of the Revisions a Route distributes traffic over may be specified by +referencing the Configuration responsible for creating them; in these cases +the Route is additionally responsible for monitoring the Configuration for +“latest ready revision” changes, and smoothly rolling out latest revisions. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

+

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

Spec holds the desired state of the Route (from the client).

+
+
+ + + + + +
+traffic
+ + +[]TrafficTarget + + +
+(Optional) +

Traffic specifies how to distribute traffic over a collection of +revisions and configurations.

+
+
+status
+ + +RouteStatus + + +
+(Optional) +

Status communicates the observed state of the Route (from the controller).

+
+

Service +

+

+

Service acts as a top-level container that manages a Route and Configuration +which implement a network service. Service exists to provide a singular +abstraction which can be access controlled, reasoned about, and which +encapsulates software lifecycle decisions such as rollout policy and +team resource ownership. Service acts only as an orchestrator of the +underlying Routes and Configurations (much as a kubernetes Deployment +orchestrates ReplicaSets), and its usage is optional but recommended.

+

The Service’s controller will track the statuses of its owned Configuration +and Route, reflecting their statuses and conditions as its own.

+

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service

+

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

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

+

ServiceSpec inlines an unrestricted ConfigurationSpec.

+
+RouteSpec
+ + +RouteSpec + + +
+

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

+

ServiceSpec inlines RouteSpec and restricts/defaults its fields +via webhook. In particular, this spec can only reference this +Service’s configuration and revisions (which also influences +defaults).

+
+
+status
+ + +ServiceStatus + + +
+(Optional) +
+

Generated with gen-crd-api-reference-docs -on git commit 427b2bf86. +on git commit 0a890efa0.

diff --git a/docs/reference/relnotes/_index.md b/docs/reference/relnotes/_index.md index 11509de2f..6bcab09f5 100644 --- a/docs/reference/relnotes/_index.md +++ b/docs/reference/relnotes/_index.md @@ -3,6 +3,7 @@ title: "Knative Release Notes" linkTitle: "Release notes" weight: 10 type: "docs" +showlandingtoc: "false" --- For details about the Knative releases, see the following pages: