Packages:
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+Package v1alpha1 is the v1alpha1 version of the API.
Resource Types:-
AwsSqsSource is the Schema for the AWS SQS API
+KafkaChannel is a resource representing a Kafka Channel.
-sources.knative.dev/v1alpha1
+messaging.knative.dev/v1alpha1
|
@@ -51,7 +45,7 @@ sources.knative.dev/v1alpha1
AwsSqsSource |
+KafkaChannel |
|||||||||||
| @@ -63,6 +57,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -71,64 +66,47 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-AwsSqsSourceSpec
+
+KafkaChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-AwsSqsSourceStatus
+
+KafkaChannelStatus
|
+(Optional)
+ Status represents the current state of the KafkaChannel. This data may be out of +date. |
-
CamelSource is the Schema for the camelsources API
+NatssChannel is a resource representing a NATSS Channel.
-sources.knative.dev/v1alpha1
+messaging.knative.dev/v1alpha1
|
@@ -176,7 +157,7 @@ sources.knative.dev/v1alpha1
CamelSource |
+NatssChannel |
|||||||||
| @@ -188,6 +169,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -196,51 +178,25 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-CamelSourceSpec
+
+NatssChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-CamelSourceStatus
+
+NatssChannelStatus
|
+(Optional)
+ Status represents the current state of the NatssChannel. This data may be out of +date. |
-
CouchDbSource is the Schema for the githubsources API
+(Appears on: +KafkaChannel) + ++
KafkaChannelSpec defines the specification for a KafkaChannel.
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
+numPartitions
+
+int32
+
|
-
-kind
-string
+NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1. |
-CouchDbSource |
-metadata
+replicationFactor
-
-Kubernetes meta/v1.ObjectMeta
-
+int16
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1. |
-spec
+subscribable
-
-CouchDbSourceSpec
-
+knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
- - + KafkaChannel conforms to Duck type Subscribable. + |
+
+(Appears on: +KafkaChannel) +
++
KafkaChannelStatus represents the current state of a KafkaChannel.
+| Field | +Description | +
|---|---|
-serviceAccountName
+Status
-string
+knative.dev/pkg/apis/duck/v1beta1.Status
|
-(Optional)
- ServiceAccountName holds the name of the Kubernetes service account -as which the underlying K8s resources should be run. If unspecified -this will default to the “default” service account for the namespace -in which the CouchDbSource exists. +
+(Members of inherits duck/v1beta1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-credentials
+AddressStatus
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
- CouchDbCredentials is the credential to use to access CouchDb. -Must be a secret. Only Name and Namespace are used. +
+(Members of KafkaChannel is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster. +It generally has the form {channel}.{namespace}.svc.{cluster domain name} |
-feed
+SubscribableTypeStatus
-
-FeedType
-
+knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
|
- Feed changes how CouchDB sends the response. -More information: https://docs.couchdb.org/en/stable/api/database/changes.html#changes-feeds +
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
+(Appears on: +NatssChannel) +
++
NatssChannelSpec defines the specification for a NatssChannel.
+ +| Field | +Description | +
|---|---|
-database
+subscribable
-string
+knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
|
- Database is the database to watch for changes +NatssChannel conforms to Duck type Subscribable. |
+(Appears on: +NatssChannel) +
++
NatssChannelStatus represents the current state of a NatssChannel.
+ +| Field | +Description | +
|---|---|
-sink
+Status
-knative.dev/pkg/apis/duck/v1beta1.Destination
+knative.dev/pkg/apis/duck/v1beta1.Status
|
-(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +
+(Members of inherits duck/v1beta1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
AddressStatus
+
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+
+(Members of AddressStatus are embedded into this type.)
+
NatssChannel is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster.
+It generally has the form {channel}.{namespace}.svc.{cluster domain name}
status
+SubscribableTypeStatus
-
-CouchDbSourceStatus
-
+knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
+(Members of SubscribableTypeStatus are embedded into this type.)
+
Subscribers is populated with the statuses of each of the Channelable’s subscribers.
+
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+ +Resource Types: +-
GitHubSource is the Schema for the githubsources API
+AwsSqsSource is the Schema for the AWS SQS API
GitHubSource |
+AwsSqsSource |
||||||||||
| @@ -448,8 +500,8 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-GitHubSourceSpec
+
+AwsSqsSourceSpec
|
@@ -459,112 +511,178 @@ GitHubSourceSpec
-serviceAccountName
+queueUrl
string
|
+ QueueURL of the SQS queue that we will poll from. + |
+
+awsCredsSecret
+
+
+Kubernetes core/v1.SecretKeySelector
+
+
+ |
+
(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. +AwsCredsSecret is the credential to use to poll the AWS SQS |
-ownerAndRepository
+annotations
-string
+map[string]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 +(Optional) +Annotations to add to the pod, mostly used for Kube2IAM role |
-eventTypes
+sink
-[]string
+
+Kubernetes core/v1.ObjectReference
+
|
- 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” +(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. |
-accessToken
+serviceAccountName
-
-SecretValueFromSource
+string
+
+ |
+
+ ServiceAccoutName is the name of the ServiceAccount that will be used to +run the Receive Adapter Deployment. + |
+
status
+
+
+AwsSqsSourceStatus
AccessToken is the Kubernetes secret containing the GitHub -access token
++
CamelSource is the Schema for the camelsources API
+ +| Field | +Description | +|||||||
|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
|
|||||||
-secretToken
+kind
+string
+ |
+CamelSource |
+|||||||
+metadata
-
-SecretValueFromSource
+
+Kubernetes meta/v1.ObjectMeta
|
- SecretToken is the Kubernetes secret containing the GitHub -secret token +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|||||||
-sink
+spec
-knative.dev/pkg/apis/duck/v1beta1.Destination
+
+CamelSourceSpec
+
|
-(Optional)
- Sink is a reference to an object that will resolve to a domain -name to use as the sink. ++ +
|
status
-
-GitHubSourceStatus
+
+CamelSourceStatus
|
@@ -584,10 +702,10 @@ GitHubSourceStatus
-
PrometheusSource is the Schema for the prometheussources API
+CouchDbSource is the Schema for the githubsources API
PrometheusSource |
+CouchDbSource |
| @@ -632,8 +750,8 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-PrometheusSourceSpec
+
+CouchDbSourceSpec
|
@@ -653,23 +771,517 @@ string
-serverURL
+credentials
-string
+
+Kubernetes core/v1.ObjectReference
+
|
- ServerURL is the URL of the Prometheus server +CouchDbCredentials is the credential to use to access CouchDb. +Must be a secret. Only Name and Namespace are used. |
-promQL
+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 is the Schema for the githubsources API
+ +| Field | +Description | +||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
+ |
+||||||||||||||||
+kind
+string
+ |
+GitHubSource |
+||||||||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||
+spec
+
+
+GitHubSourceSpec
+
+
+ |
+
+ + +
|
+||||||||||||||||
+status
+
+
+GitHubSourceStatus
+
+
+ |
++ | +
+
GitLabSource is the Schema for the gitlabsources API
+ +| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
+ |
+||||||||||||||
+kind
+string
+ |
+GitLabSource |
+||||||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec
+
+
+GitLabSourceSpec
+
+
+ |
+
+ + +
|
+||||||||||||||
+status
+
+
+GitLabSourceStatus
+
+
+ |
++ | +
+
PrometheusSource is the Schema for the prometheussources API
+ +| Field | +Description | +||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
+ |
+||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+kind
+string
+ |
+PrometheusSource |
+||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+spec
+
+
+PrometheusSourceSpec
+
+
+ |
+
+ + +
GitHubSourceStatus ---(Appears on: -GitHubSource) - -- GitHubSourceStatus defines the observed state of GitHubSource - -
KafkaLimitsSpec ---(Appears on: -KafkaResourceSpec) - -- -
KafkaRequestsSpec
+ |
-cpu
+SourceStatus
-string
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
+
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
-memory
+webhookIDKey
string
|
+ WebhookIDKey is the ID of the webhook registered with GitHub |
(Appears on: -KafkaSourceSpec) +GitLabSource)
+
GitLabSourceSpec defines the desired state of GitLabSource
-requests
+serviceAccountName
-
-KafkaRequestsSpec
-
+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. |
-limits
+projectUrl
-
-KafkaLimitsSpec
-
+string
|
+ ProjectUrl is the url of the GitLab project which we are interested +in receiving events from. +Examples: +https://github.com/knative/eventing-contrib/tree/{{% branch %}}/gitlab/samples |
-
KafkaSource is the Schema for the kafkasources API.
- -| Field | -Description | -||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-metadata
+eventTypes
-
-Kubernetes meta/v1.ObjectMeta
-
+[]string
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+EventType is the type of event to receive from Gitlab. These +correspond to supported events to the add project hook +https://docs.gitlab.com/ee/api/projects.html#add-project-hook |
||||||||||||||||||
-spec
+accessToken
-
-KafkaSourceSpec
+
+SecretValueFromSource
|
- - -
GitLabSourceStatus +++(Appears on: +GitLabSource) + ++ GitLabSourceStatus defines the observed state of GitLabSource + +
KafkaLimitsSpec +++(Appears on: +KafkaResourceSpec) + ++ +
|
||||||||||||||||||
-status
+memory
-
-KafkaSourceStatus
-
+string
|
@@ -1609,11 +2163,11 @@ KafkaSourceStatus |
(Appears on: -KafkaSourceSpec) +KafkaResourceSpec)
@@ -1627,11 +2181,9 @@ KafkaSourceStatus
sasl
+cpu
-
-KafkaSourceSASLSpec
-
+string
tls
+memory
-
-KafkaSourceTLSSpec
-
+string
(Appears on: -KafkaSourceNetSpec) +KafkaSourceSpec)
@@ -1669,52 +2219,34 @@ KafkaSourceTLSSpec
enable
-
-bool
-
-user
+requests
-
-SecretValueFromSource
+
+KafkaRequestsSpec
User is the Kubernetes secret containing the SASL username.
password
+limits
-
-SecretValueFromSource
+
+KafkaLimitsSpec
Password is the Kubernetes secret containing the SASL password.
-(Appears on: -KafkaSource) -
--
KafkaSourceSpec defines the desired state of the KafkaSource.
+KafkaSource is the Schema for the kafkasources API.
| Field | Description | - - + + +|||
|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+|||
+spec
+
+
+KafkaSourceSpec
+
+
+ |
+
+ + +
|
+|||
+status
+
+
+KafkaSourceStatus
+
+
+ |
++ | +
(Appears on: -KafkaSource) +KafkaSourceSpec)
-
KafkaSourceStatus defines the observed state of KafkaSource.
-Status
+sasl
-knative.dev/pkg/apis/duck/v1.Status
+
+KafkaSourceSASLSpec
+
|
-
-(Members of inherits duck/v1alpha1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. |
-sinkUri
+tls
-string
+
+KafkaSourceTLSSpec
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the KafkaSource. |
(Appears on: @@ -1883,21 +2452,7 @@ bool
cert
-
-
-SecretValueFromSource
-
-
-Cert is the Kubernetes secret containing the client certificate.
-key
+user
SecretValueFromSource
@@ -1906,12 +2461,12 @@ SecretValueFromSource
Key is the Kubernetes secret containing the client key.
+User is the Kubernetes secret containing the SASL username.
caCert
+password
SecretValueFromSource
@@ -1920,19 +2475,19 @@ SecretValueFromSource
CACert is the Kubernetes secret containing the server CA cert.
+Password is the Kubernetes secret containing the SASL password.
(Appears on: -PrometheusSource) +KafkaSource)
-
PrometheusSourceSpec defines the desired state of PrometheusSource
+KafkaSourceSpec defines the desired state of the KafkaSource.
-serviceAccountName
+bootstrapServers
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. +Bootstrap servers are the Kafka servers the consumer will connect to. |
-serverURL
+topics
string
|
- ServerURL is the URL of the Prometheus server +Topic topics to consume messages from |
-promQL
+consumerGroup
string
|
- PromQL is the Prometheus query for this source +ConsumerGroupID is the consumer group ID. |
-authTokenFile
+net
-string
+
+KafkaSourceNetSpec
+
|
-(Optional)
- The name of the file containing the authenication token |
-caCertConfigMap
+sink
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
(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 +Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-step
+serviceAccountName
string
|
-(Optional)
- Query resolution step width in duration format or float number of seconds. -Prometheus duration strings are of the form [0-9]+[smhdwy]. +ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. |
-sink
+resources
-knative.dev/pkg/apis/duck/v1beta1.Destination
+
+KafkaResourceSpec
+
|
-(Optional)
- Sink is a reference to an object that will resolve to a host -name to use as the sink. +Resource limits and Request specifications of the Receive Adapter Deployment |
(Appears on: -PrometheusSource) +KafkaSource)
-
PrometheusSourceStatus defines the observed state of PrometheusSource
+KafkaSourceStatus defines the observed state of KafkaSource.
-Status
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-sinkUri
-
-string
-
- |
-
-(Optional)
- SinkURI is the current active sink URI that has been configured -for the PrometheusSource. +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. |
@@ -2156,21 +2688,14 @@ Kubernetes core/v1.SecretKeySelector -
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +KafkaSourceNetSpec) -Resource Types: --
KafkaChannel is a resource representing a Kafka Channel.
-apiVersion
-string |
-
-
-messaging.knative.dev/v1alpha1
-
- |
-||||||
-kind
-string
- |
-KafkaChannel |
-||||||
-metadata
+enable
-
-Kubernetes meta/v1.ObjectMeta
-
+bool
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
|
||||||
-spec
+cert
-
-KafkaChannelSpec
+
+SecretValueFromSource
|
- Spec defines the desired state of the Channel. -- -
Key is the Kubernetes secret containing the client key. |
||||||
-status
+caCert
-
-KafkaChannelStatus
+
+SecretValueFromSource
|
(Optional)
- Status represents the current state of the KafkaChannel. This data may be out of -date. +CACert is the Kubernetes secret containing the server CA cert. |
-
NatssChannel is a resource representing a NATSS Channel.
+(Appears on: +PrometheusSource) + ++
PrometheusSourceSpec defines the desired state of PrometheusSource
-apiVersion
-string |
-
-
-messaging.knative.dev/v1alpha1
-
+serviceAccountName
+
+string
+
|
-||
-kind
-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. |
-NatssChannel |
||
-metadata
+serverURL
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+ServerURL is the URL of the Prometheus server |
||
-spec
+promQL
-
-NatssChannelSpec
-
+string
|
- Spec defines the desired state of the Channel. -- -
The name of the file containing the authenication token |
||
-status
+caCertConfigMap
-
-NatssChannelStatus
-
+string
|
(Optional)
- Status represents the current state of the NatssChannel. This data may be out of -date. +The name of the config map containing the CA certificate of the +Prometheus service’s signer. |
-(Appears on: -KafkaChannel) -
--
KafkaChannelSpec defines the specification for a KafkaChannel.
- -| Field | -Description | -
|---|---|
-numPartitions
+schedule
-int32
+string
|
- NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1. +A crontab-formatted schedule for running the PromQL query |
-replicationFactor
+step
-int16
+string
|
- ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1. +(Optional) +Query resolution step width in duration format or float number of seconds. +Prometheus duration strings are of the form [0-9]+[smhdwy]. |
-subscribable
+sink
-knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
+knative.dev/pkg/apis/duck/v1.Destination
|
- KafkaChannel conforms to Duck type Subscribable. +(Optional) +Sink is a reference to an object that will resolve to a host +name to use as the sink. |
(Appears on: -KafkaChannel) +PrometheusSource)
-
KafkaChannelStatus represents the current state of a KafkaChannel.
+PrometheusSourceStatus defines the observed state of PrometheusSource
-Status
-
-knative.dev/pkg/apis/duck/v1beta1.Status
-
- |
-
-
-(Members of inherits duck/v1beta1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-AddressStatus
-
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
-
- |
-
-
-(Members of KafkaChannel is Addressable. It currently exposes the endpoint as a -fully-qualified DNS name which will distribute traffic over the -provided targets from inside the cluster. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-SubscribableTypeStatus
+SourceStatus
-knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
(Appears on: -NatssChannel) +KafkaSourceSASLSpec, +KafkaSourceTLSSpec)
-
NatssChannelSpec defines the specification for a NatssChannel.
+SecretValueFromSource represents the source of a secret value
-subscribable
+secretKeyRef
-knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
+
+Kubernetes core/v1.SecretKeySelector
+
|
- NatssChannel conforms to Duck type Subscribable. +The Secret key to select from. |
(Appears on: -NatssChannel) +GitHubSourceSpec)
-
NatssChannelStatus represents the current state of a NatssChannel.
+SecretValueFromSource represents the source of a secret value
-Status
+secretKeyRef
-knative.dev/pkg/apis/duck/v1beta1.Status
+
+Kubernetes core/v1.SecretKeySelector
+
|
-
-(Members of inherits duck/v1beta1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +The Secret key to select from. |
-AddressStatus
-
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
-
- |
-+ |
-(Members of AddressStatus are embedded into this type.)
+(Appears on:
+GitLabSourceSpec)
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}
- ++
SecretValueFromSource represents the source of a secret value
+ +| Field | +Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
-SubscribableTypeStatus
+secretKeyRef
-knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
+
+Kubernetes core/v1.SecretKeySelector
+
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +The Secret key to select from. |
-apiVersion
-string |
-
-
-configs.internal.knative.dev/v1alpha1
-
- |
-|||||||||
-kind
-string
- |
-ConfigMapPropagation |
-|||||||||
metadata
@@ -94,39 +73,55 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-ConfigMapPropagationSpec
+
+ParallelSpec
- | Spec defines the desired state of the ConfigMapPropagation +Spec defines the desired state of the Parallel.
|
status
-
-ConfigMapPropagationStatus
+
+ParallelStatus
(Optional)
- |
Status represents the current state of the EventType. -This data may be out of date. +Status represents the current state of the Parallel. This data may be out of +date. |
(Appears on: -ConfigMapPropagation) +ParallelSpec)
@@ -167,39 +162,49 @@ This data may be out of date.
originalNamespace
+filter
-string
+knative.dev/pkg/apis/duck/v1.Destination
OriginalNamespace is the namespace where the original configMaps are in
+Filter is the expression guarding the branch
selector
+subscriber
-
-Kubernetes meta/v1.LabelSelector
-
+knative.dev/pkg/apis/duck/v1.Destination
+
+Subscriber receiving the event when the filter passes
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
Selector only selects original configMaps with corresponding labels
+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
(Appears on: -ConfigMapPropagation) +ParallelStatus)
-
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
+ParallelBranchStatus represents the current state of a Parallel branch
-Status
+filterSubscriptionStatus
-knative.dev/pkg/apis/duck/v1.Status
+
+ParallelSubscriptionStatus
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +FilterSubscriptionStatus corresponds to the filter subscription status. |
-copyConfigmaps
+filterChannelStatus
-
-[]ConfigMapPropagationStatusCopyConfigMap
+
+ParallelChannelStatus
|
-(Optional)
- CopyConfigMaps is the status for each copied configmap. +FilterChannelStatus corresponds to the filter channel status. + |
+
+subscriberSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
+ |
+
+ SubscriptionStatus corresponds to the subscriber subscription status. |
(Appears on: -ConfigMapPropagationStatus) +ParallelBranchStatus, +ParallelStatus)
-
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
-name
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
- Name is copy configmap’s name +Channel is the reference to the underlying channel. |
-source
+ready
-string
+knative.dev/pkg/apis.Condition
|
- Source is “originalNamespace/originalConfigMapName” +ReadyCondition indicates whether the Channel is ready or not. |
+(Appears on: +Parallel) +
++
+
-operation
-
-string
-
- |
-
- Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop - |
+Field | +Description |
|---|---|---|---|
-ready
+branches
-string
+
+[]ParallelBranch
+
|
- Ready represents the operation is ready or not +Branches is the list of Filter/Subscribers pairs. |
||
-reason
+channelTemplate
-string
+
+ChannelTemplateSpec
+
|
- Reason indicates reasons if the operation is not ready +(Optional) +ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace). |
||
-resourceVersionFromSource
+reply
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
- ResourceVersion is the resourceVersion of original configmap +(Optional) +Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply |
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +Parallel) -Resource Types: - --
Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
+ParallelStatus represents the current state of a Parallel.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
- |
-||||||||
-kind
-string
- |
-Broker |
-||||||||
-metadata
+Status
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
||||||||
-spec
+ingressChannelStatus
-
-BrokerSpec
+
+ParallelChannelStatus
|
- Spec defines the desired state of the Broker. -- -
ParallelSubscriptionStatus +++(Appears on: +ParallelBranchStatus) + ++ +
Subscription is the reference to the underlying Subscription. |
||||||||
-status
+ready
-
-BrokerStatus
-
+knative.dev/pkg/apis.Condition
|
-(Optional)
- Status represents the current state of the Broker. This data may be out of -date. +ReadyCondition indicates whether the Subscription is ready or not. |
+
Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
- |
-|||||||
-kind
-string
- |
-EventType |
-|||||||
metadata
@@ -518,99 +510,126 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-EventTypeSpec
+
+SequenceSpec
- |
Spec defines the desired state of the EventType. +Spec defines the desired state of the Sequence.
| ||||||
-broker
+status
-string
+
+SequenceStatus
+
|
- Broker refers to the Broker that can provide the EventType. +(Optional) +Status represents the current state of the Sequence. This data may be out of +date. |
+(Appears on: +SequenceStatus) +
++
+| Field | +Description | +
|---|---|
-description
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
-(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. - |
-
Channel is the reference to the underlying channel.
status
+ready
-
-EventTypeStatus
-
+knative.dev/pkg/apis.Condition
Status represents the current state of the EventType. -This data may be out of date.
+ReadyCondition indicates whether the Channel is ready or not.
-
Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.
+(Appears on: +Sequence) + +
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
+steps
+
+
+[]SequenceStep
+
+
|
-
-kind
-string
+Steps is the list of Destinations (processors / functions) that will be called in the order +provided. |
-Trigger |
-metadata
+channelTemplate
-
-Kubernetes meta/v1.ObjectMeta
+
+ChannelTemplateSpec
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace). |
-spec
+reply
-
-TriggerSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- Spec defines the desired state of the Trigger. -- +(Optional) + Reply is a Reference to where the result of the last Subscriber gets sent to. + |
+
+(Appears on: +Sequence) +
++
SequenceStatus represents the current state of a Sequence.
+| Field | +Description | +
|---|---|
-broker
+Status
-string
+knative.dev/pkg/apis/duck/v1.Status
|
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. +
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-filter
+subscriptionStatuses
-
-TriggerFilter
+
+[]SequenceSubscriptionStatus
|
-(Optional)
- Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events. +SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order. |
-subscriber
+channelStatuses
-knative.dev/pkg/apis/duck/v1.Destination
+
+[]SequenceChannelStatus
+
|
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. - |
-
ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order.
status
+AddressStatus
-
-TriggerStatus
-
+knative.dev/pkg/apis/duck/v1.AddressStatus
Status represents the current state of the Trigger. This data may be out of -date.
+
+(Members of AddressStatus are embedded into this type.)
+
AddressStatus is the starting point to this Sequence. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name}
(Appears on: -Broker) +SequenceSpec)
@@ -743,35 +779,16 @@ date.
channelTemplateSpec
-
-
-ChannelTemplateSpec
-
-
-ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the
-Broker. 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).
-Deprecated: See spec.config to configure aditional broker options.
-Unless class is
config
+Destination
-knative.dev/pkg/apis/duck/v1.KReference
+knative.dev/pkg/apis/duck/v1.Destination
Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap. -NOTE: this is for backwards compatibility with v1alpha1 <-> v1beta1 conversions.
+
+(Members of Destination are embedded into this type.)
+
Subscriber receiving the step event
Delivery is the delivery specification to be used internally by the broker to -create subscriptions.
+Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. +Needed for Roundtripping v1alpha1 <-> v1beta1.
(Appears on: -Broker) +SequenceStatus)
-
BrokerStatus represents the current state of a Broker.
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-address
+subscription
-knative.dev/pkg/apis/duck/v1alpha1.Addressable
+
+Kubernetes core/v1.ObjectReference
+
|
- Broker 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 {broker}-router.{namespace}.svc.{cluster domain name} +Subscription is the reference to the underlying Subscription. |
-triggerChannel
+ready
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis.Condition
|
- TriggerChannel is an objectref to the object for the TriggerChannel +ReadyCondition indicates whether the Subscription is ready or not. |
-(Appears on: -EventType) +
Package v1beta1 is the v1beta1 version of the API.
+Resource Types: ++
Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
-type
+metadata
-string
+
+Kubernetes meta/v1.ObjectMeta
+
|
- Type represents the CloudEvents type. It is authoritative. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-source
+spec
-string
+
+ParallelSpec
+
|
- Source is a URI, it represents the CloudEvents source. +Spec defines the desired state of the Parallel. ++ +
|
||||||
-description
+status
-string
+
+ParallelStatus
+
|
(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. +Status represents the current state of the Parallel. This data may be out of +date. |
(Appears on: -EventType) +ParallelSpec)
-
EventTypeStatus represents the current state of a EventType.
-Status
+filter
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +(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
+
+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
+(Appears on: -TriggerSpec) +ParallelStatus)
+
ParallelBranchStatus represents the current state of a Parallel branch
-sourceAndType
+filterSubscriptionStatus
-
-TriggerFilterSourceAndType
+
+ParallelSubscriptionStatus
|
-(Optional)
- DeprecatedSourceAndType filters events based on exact matches on the -CloudEvents type and source attributes. This field has been replaced by the -Attributes field. +FilterSubscriptionStatus corresponds to the filter subscription status. |
-attributes
+filterChannelStatus
-
-TriggerFilterAttributes
+
+ParallelChannelStatus
|
-(Optional)
- Attributes filters events by exact match on event context attributes. -Each key in the map is compared with the equivalent key in the event -context. An event passes the filter if all values are equal to the -specified values. -Nested context attributes are not supported as keys. Only string values are supported. +FilterChannelStatus corresponds to the filter channel status. + |
+
+subscriberSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
+ |
+
+ SubscriptionStatus corresponds to the subscriber subscription status. |
map[string]string alias)-(Appears on: -TriggerFilter) -
--
TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.
- -(Appears on: -TriggerFilter) +ParallelBranchStatus, +ParallelStatus)
-
TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and -source attributes. Only exact matches will pass the filter. Either or both type and source can -use the value “ to indicate all strings match.
-type
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
+ Channel is the reference to the underlying channel. |
-source
+ready
-string
+knative.dev/pkg/apis.Condition
|
+ ReadyCondition indicates whether the Channel is ready or not. |
(Appears on: -Trigger) +Parallel)
@@ -1086,53 +1135,55 @@ string
broker
+branches
-string
+
+[]ParallelBranch
+
Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.
+Branches is the list of Filter/Subscribers pairs.
filter
+channelTemplate
-
-TriggerFilter
+
+ChannelTemplateSpec
Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.
+ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).
subscriber
+reply
knative.dev/pkg/apis/duck/v1.Destination
Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.
+(Optional) +Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply
(Appears on: -Trigger) +Parallel)
-
TriggerStatus represents the current state of a Trigger.
+ParallelStatus represents the current state of a Parallel.
-subscriberURI
+ingressChannelStatus
-knative.dev/pkg/apis.URL
+
+ParallelChannelStatus
+
|
- SubscriberURI is the resolved URI of the receiver for this Trigger. +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 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} |
-
Package v1beta1 is the v1beta1 version of the API.
+(Appears on: +ParallelBranchStatus) -Resource Types: - --
Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
-apiVersion
-string |
+
-
-eventing.knative.dev/v1beta1
-
+Subscription is the reference to the underlying Subscription. |
|
-kind
-string
+ready
+
+knative.dev/pkg/apis.Condition
+
|
-Broker |
+
+ ReadyCondition indicates whether the Subscription is ready or not. + |
+
+
Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
+ +| Field | +Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
metadata
@@ -1237,43 +1329,55 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-BrokerSpec
+
+SequenceSpec
|
- Spec defines the desired state of the Broker. +Spec defines the desired state of the Sequence.
|
status
-
-BrokerStatus
+
+SequenceStatus
|
(Optional)
- Status represents the current state of the Broker. This data may be out of + Status represents the current state of the Sequence. This data may be out of date. |
+(Appears on: +SequenceStatus) +
+
-apiVersion
-string |
-
-
-eventing.knative.dev/v1beta1
-
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
|
-
-kind
-string
+Channel is the reference to the underlying channel. |
-EventType |
-metadata
+ready
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis.Condition
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+ReadyCondition indicates whether the Channel is ready or not. |
+(Appears on: +Sequence) +
++
+| Field | +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-spec
+steps
-
-EventTypeSpec
+
+[]SequenceStep
|
- Spec defines the desired state of the EventType. -- -
SequenceStatus +++(Appears on: +Sequence) + ++ SequenceStatus represents the current state of a Sequence. + +
ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order. |
||||||||||||
-status
+AddressStatus
-
-EventTypeStatus
-
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
-(Optional)
- Status represents the current state of the EventType. -This data may be out of date. +
+(Members of 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} |
-
Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.
+(Appears on: +SequenceSpec) + +
-apiVersion
-string |
-
-
-eventing.knative.dev/v1beta1
-
+Destination
+
+knative.dev/pkg/apis/duck/v1.Destination
+
|
-
-kind
-string
+
+(Members of Subscriber receiving the step event |
-Trigger |
-metadata
+delivery
-
-Kubernetes meta/v1.ObjectMeta
+
+DeliverySpec
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. |
+(Appears on: +SequenceStatus) +
++
+| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
-spec
+subscription
-
-TriggerSpec
+
+Kubernetes core/v1.ObjectReference
|
- Spec defines the desired state of the Trigger. -- -
|
-||||||
-status
-
-
-TriggerStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Trigger. This data may be out of -date. - |
-
-(Appears on: -Broker) -
--
-| Field | -Description | -
|---|---|
-config
-
-knative.dev/pkg/apis/duck/v1.KReference
-
- |
-
-(Optional)
- Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap. - |
-
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc. - |
-
-(Appears on: -Broker) -
--
BrokerStatus represents the current state of a Broker.
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-address
-
-knative.dev/pkg/apis/duck/v1.Addressable
-
- |
-
- Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh. - |
-
-(Appears on: -EventType) -
--
-| Field | -Description | -
|---|---|
-type
-
-string
-
- |
-
- Type represents the CloudEvents type. It is authoritative. - |
-
-source
-
-knative.dev/pkg/apis.URL
-
- |
-
- Source is a URI, it represents the CloudEvents source. - |
-
-schema
-
-knative.dev/pkg/apis.URL
-
- |
-
-(Optional)
- Schema is a URI, it represents the CloudEvents schemaurl extension attribute. -It may be a JSON schema, a protobuf schema, etc. It is optional. - |
-
-broker
-
-string
-
- |
-
- Broker refers to the Broker that can provide the EventType. - |
-
-description
-
-string
-
- |
-
-(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. - |
-
-(Appears on: -EventType) -
--
EventTypeStatus represents the current state of a EventType.
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-(Appears on: -TriggerSpec) -
--
-| Field | -Description | -
|---|---|
-attributes
-
-
-TriggerFilterAttributes
-
-
- |
-
-(Optional)
- Attributes filters events by exact match on event context attributes. -Each key in the map is compared with the equivalent key in the event -context. An event passes the filter if all values are equal to the -specified values. -Nested context attributes are not supported as keys. Only string values are supported. - |
-
map[string]string alias)-(Appears on: -TriggerFilter) -
--
TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.
- --(Appears on: -Trigger) -
--
-| Field | -Description | -
|---|---|
-broker
-
-string
-
- |
-
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. - |
-
-filter
-
-
-TriggerFilter
-
-
- |
-
-(Optional)
- Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events. - |
-
-subscriber
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. - |
-
-(Appears on: -Trigger) -
--
TriggerStatus represents the current state of a Trigger.
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-subscriberUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- SubscriberURI is the resolved URI of the receiver for this Trigger. - |
-
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
- -| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-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. -- -
|
-||||||
-status
-
-
-ParallelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. - |
-
-(Appears on: -ParallelSpec) -
--
-| Field | -Description | -
|---|---|
-filter
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
- 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 - |
-
-(Appears on: -ParallelStatus) -
--
ParallelBranchStatus represents the current state of a Parallel branch
- -| Field | -Description | -
|---|---|
-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. - |
-
-(Appears on: -ParallelBranchStatus, -ParallelStatus) -
--
-| Field | -Description | -
|---|---|
-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. - |
-
-(Appears on: -Parallel) -
--
-| Field | -Description | -
|---|---|
-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 - |
-
-(Appears on: -Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-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 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} - |
-
-(Appears on: -ParallelBranchStatus) -
--
-| Field | -Description | -
|---|---|
-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 defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
- -| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-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. -- -
|
-||||||
-status
-
-
-SequenceStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. - |
-
-(Appears on: -SequenceStatus) -
--
-| Field | -Description | -
|---|---|
-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. - |
-
-(Appears on: -Sequence) -
--
-| Field | -Description | -
|---|---|
-steps
-
-
-[]SequenceStep
-
-
- |
-
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. - |
-
-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. - |
-
-(Appears on: -Sequence) -
--
SequenceStatus represents the current state of a Sequence.
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-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 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} - |
-
-(Appears on: -SequenceSpec) -
--
-| Field | -Description | -
|---|---|
-Destination
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-
-(Members of 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. -Needed for Roundtripping v1alpha1 <-> v1beta1. - |
-
-(Appears on: -SequenceStatus) -
--
-| Field | -Description | -
|---|---|
-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. - |
-
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
- -| Field | -Description | -||||||||
|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.eventing.knative.dev/v1alpha1
-
- |
-||||||||
-kind
-string
- |
-ApiServerSource |
-||||||||
-Deprecated
-
-
-Deprecated
-
-
- |
-
- Deprecated allows ApiServerSource to have a deprecated message. - |
-||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec
-
-
-ApiServerSourceSpec
-
-
- |
-
- - -
|
-||||||||
-status
-
-
-ApiServerSourceStatus
-
-
- |
-- | -
-
ContainerSource is the Schema for the containersources API
- -| Field | -Description | -||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.eventing.knative.dev/v1alpha1
-
- |
-||||||||||||
-kind
-string
- |
-ContainerSource |
-||||||||||||
-Deprecated
-
-
-Deprecated
-
-
- |
-
- Deprecated allows ContainerSource to have a deprecated message. - |
-||||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||||
-spec
-
-
-ContainerSourceSpec
-
-
- |
-
- - -
|
-||||||||||||
-status
-
-
-ContainerSourceStatus
-
+knative.dev/pkg/apis.Condition
|
+ ReadyCondition indicates whether the Subscription is ready or not. |
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: +-
CronJobSource is the Schema for the cronjobsources API.
+Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-sources.eventing.knative.dev/v1alpha1
+messaging.knative.dev/v1alpha1
|
@@ -3075,20 +1710,7 @@ sources.eventing.knative.dev/v1alpha1
CronJobSource |
-
-||||||||||||||
-Deprecated
-
-
-Deprecated
-
-
- |
-
- Deprecated allows CronJobSource to have a deprecated message. - |
+Channel |
|||||||||||||
| @@ -3100,6 +1722,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -3108,71 +1731,54 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-CronJobSourceSpec
+
+ChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-CronJobSourceStatus
+
+ChannelStatus
|
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. |
-
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.
InMemoryChannel is a resource representing an in memory channel
-sources.eventing.knative.dev/v1alpha1
+messaging.knative.dev/v1alpha1
|
@@ -3225,20 +1829,7 @@ sources.eventing.knative.dev/v1alpha1
SinkBinding |
-
-||||||||
-Deprecated
-
-
-Deprecated
-
-
- |
-
- Deprecated allows ApiServerSource to have a deprecated message. - |
+InMemoryChannel |
|||||||
| @@ -3250,6 +1841,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -3258,39 +1850,40 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SinkBindingSpec
+
+InMemoryChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-SinkBindingStatus
+
+InMemoryChannelStatus
|
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. |
-(Appears on: -ApiServerSourceSpec) -
--
ApiServerResource defines the resource to watch
+Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
apiVersion
-
-string
-
- |
+string
- API version of the resource to watch. +
+messaging.knative.dev/v1alpha1
+
|
|
kind
-
string
-
- |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
+Subscription |
-labelSelector
+metadata
-
-Kubernetes meta/v1.LabelSelector
+
+Kubernetes meta/v1.ObjectMeta
|
- LabelSelector restricts this source to objects with the selected labels -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|
-controllerSelector
+spec
-
-Kubernetes meta/v1.OwnerReference
+
+SubscriptionSpec
|
- ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. - |
-
-controller
+generation
-bool
+int64
|
- If true, send an event referencing the object controlling the resource - |
-
-(Appears on: -ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- -| Field | -Description | +(Optional) +
|---|---|
-resources
+channel
-
-[]ApiServerResource
+
+Kubernetes core/v1.ObjectReference
|
- Resources is the list of resources to watch +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.) |
-serviceAccountName
+subscriber
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. +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. |
-sink
+reply
-knative.dev/pkg/apis/duck/v1beta1.Destination
+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. +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-mode
+delivery
-string
+
+DeliverySpec
+
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- Delivery configuration |
-(Appears on: -ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. |
-sinkUri
+status
-string
+
+SubscriptionStatus
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the ApiServerSource. |
(Appears on: -ContainerSource) +Channel)
-
ContainerSourceSpec defines the desired state of ContainerSource
+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.
-template
+channelTemplate
-
-Kubernetes core/v1.PodTemplateSpec
+
+ChannelTemplateSpec
|
-(Optional)
- Template describes the pods that will be created - |
-
-image
-
-string
-
- |
-
- DeprecatedImage is the image to run inside of the container.
-This field is to be deprecated. Use |
-
-args
-
-[]string
-
- |
-
- DeprecatedArgs are passed to the ContainerSpec as they are.
-This field is to be deprecated. Use 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. |
-env
+subscribable
-
-[]Kubernetes core/v1.EnvVar
+
+Subscribable
|
-(Optional)
- DeprecatedEnv is the list of environment variables to set in the container.
-Cannot be updated.
-This field is to be deprecated. Use |
-
-serviceAccountName
-
-string
-
- |
-
-(Optional)
- DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this
-source.
-This field is to be deprecated. Use Channel conforms to Duck type Subscribable. |
-sink
+delivery
-knative.dev/pkg/apis/duck/v1beta1.Destination
+
+DeliverySpec
+
|
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +Delivery options. |
(Appears on: -ContainerSource) +Channel)
-
ContainerSourceStatus defines the observed state of ContainerSource
+ChannelStatus represents the current state of a Channel.
-sinkUri
+AddressStatus
-string
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the ContainerSource. - |
-
-(Appears on: -CronJobResourceSpec) -
+(Members of AddressStatus are embedded into this type.)
| Field | -Description | +
|---|---|
-cpu
+SubscribableTypeStatus
-string
+
+SubscribableTypeStatus
+
|
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
-memory
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
+ Channel is an ObjectReference to the Channel CRD backing this Channel. |
(Appears on: -CronJobResourceSpec) +InMemoryChannel)
+
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
-cpu
+subscribable
-string
+
+Subscribable
+
|
+ Channel conforms to Duck type Subscribable. |
-memory
+delivery
-string
+
+DeliverySpec
+
|
+ For round tripping (v1beta1 <-> v1alpha1> |
(Appears on: -CronJobSourceSpec) +InMemoryChannel)
+
ChannelStatus represents the current state of a Channel.
-requests
+Status
-
-CronJobRequestsSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-limits
+AddressStatus
+
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+ |
+
+
+(Members of InMemoryChannel 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
-
-CronJobLimitsSpec
+
+SubscribableTypeStatus
|
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
(Appears on: -CronJobSource) +Subscription)
-
CronJobSourceSpec defines the desired state of the CronJobSource.
+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
-schedule
+generation
-string
+int64
|
- Schedule is the cronjob schedule. +(Optional) +TODO By enabling the status subresource metadata.generation should increment +thus making this property obsolete. +We should be able to drop this property with a CRD conversion webhook +in the future |
-data
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
- Data is the data posted to the target function. +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.) |
-sink
+subscriber
-knative.dev/pkg/apis/duck/v1beta1.Destination
+knative.dev/pkg/apis/duck/v1.Destination
|
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +(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. |
-serviceAccountName
+reply
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
- ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. +(Optional) +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-resources
+delivery
-
-CronJobResourceSpec
+
+DeliverySpec
|
- Resource limits and Request specifications of the Receive Adapter Deployment +(Optional) +Delivery configuration |
(Appears on: -CronJobSource) +Subscription)
-
CronJobSourceStatus defines the observed state of CronJobSource.
+SubscriptionStatus (computed) for a subscription
-sinkUri
+physicalSubscription
-string
+
+SubscriptionStatusPhysicalSubscription
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the CronJobSource. +PhysicalSubscription is the fully resolved values that this Subscription represents. |
-(Appears on: -ApiServerSource, -ContainerSource, -CronJobSource, -SinkBinding) -
--
-(Appears on: -SinkBinding) +SubscriptionStatus)
-
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-SourceSpec
+subscriberURI
-knative.dev/pkg/apis/duck/v1.SourceSpec
+knative.dev/pkg/apis.URL
|
-
-(Members of SubscriberURI is the fully resolved URI for spec.subscriber. |
-BindingSpec
+replyURI
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+knative.dev/pkg/apis.URL
|
-
-(Members of ReplyURI is the fully resolved URI for the spec.reply. |
-(Appears on: -SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -| Field | -Description | -
|---|---|
-SourceStatus
+deadLetterSinkURI
-knative.dev/pkg/apis/duck/v1.SourceStatus
+knative.dev/pkg/apis.URL
|
-
-(Members of ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
-
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
+Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Resource Types: -
ApiServerSource is the Schema for the apiserversources API
@@ -4019,7 +2550,7 @@ Resource Types: string
-sources.knative.dev/v1alpha2
+sources.knative.dev/v1alpha1
spec
-
+
ApiServerSourceSpec
@@ -4059,94 +2590,82 @@ ApiServerSourceSpec
-SourceSpec
+resources
-knative.dev/pkg/apis/duck/v1.SourceSpec
+
+[]ApiServerResource
+
|
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. +Resources is the list of resources to watch |
-resources
+serviceAccountName
-
-[]APIVersionKind
-
+string
|
- Resource is the resource this source will track and send related -lifecycle events from the Kubernetes ApiServer. +(Optional) +ServiceAccountName is the name of the ServiceAccount to use to run this +source. |
-selector
+sink
-
-Kubernetes meta/v1.LabelSelector
-
+knative.dev/pkg/apis/duck/v1beta1.Destination
|
(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 +Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-owner
+ceOverrides
-
-APIVersionKind
-
+knative.dev/pkg/apis/duck/v1.CloudEventOverrides
|
(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. +CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink. |
-mode
+owner
-string
+
+APIVersionKind
+
|
(Optional)
- EventMode controls the format of the event.
- 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. |
-serviceAccountName
+mode
string
|
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set. +Mode is the mode the receive adapter controller runs under: Ref or Resource.
+ |
status
-
+
ApiServerSourceStatus
@@ -4166,7 +2685,7 @@ ApiServerSourceStatus
PingSource is the Schema for the PingSources API.
@@ -4185,7 +2704,7 @@ ApiServerSourceStatus string
-sources.knative.dev/v1alpha2
+sources.knative.dev/v1alpha1
spec
-
+
PingSourceSpec
@@ -4225,46 +2744,75 @@ PingSourceSpec
-SourceSpec
+schedule
-knative.dev/pkg/apis/duck/v1.SourceSpec
+string
|
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. +Schedule is the cronjob schedule. |
-schedule
+data
string
|
+ Data is the data posted to the target function. + |
+
+sink
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Sink is a reference to an object that will resolve to a uri to use as the sink. + |
+
+ceOverrides
+
+knative.dev/pkg/apis/duck/v1.CloudEventOverrides
+
+ |
+
(Optional)
- Schedule is the cronjob schedule. Defaults to CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink. |
-jsonData
+serviceAccountName
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”. +ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. +Deprecated: v1beta1 drops this field. + |
+
+resources
+
+
+PingResourceSpec
+
+
+ |
+
+ Resource limits and Request specifications of the Receive Adapter Deployment +Deprecated: v1beta1 drops this field. |
status
-
+
PingSourceStatus
@@ -4284,7 +2832,7 @@ PingSourceStatus
-
SinkBinding describes a Binding that is also a Source. @@ -4308,7 +2856,7 @@ cloud events.
string
-sources.knative.dev/v1alpha2
+sources.knative.dev/v1alpha1
spec
-
+
SinkBindingSpec
@@ -4357,11 +2905,6 @@ 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.
(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
@@ -4397,15 +2937,14 @@ SinkBindingStatus
-(Appears on: -ApiServerSourceSpec, ApiServerSourceSpec)
-
APIVersionKind is an APIVersion and Kind tuple.
+ApiServerResource defines the resource to watch
|
-(Optional)
- APIVersion - the API version of the resource to watch. +API version of the resource to watch. |
|
|
-(Optional)
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. + |
+
(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceSpec defines the desired state of ApiServerSource
@@ -4461,103 +3041,91 @@ More info: +[]ApiServerResource +
-(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 is the list of resources to watch
resources
+serviceAccountName
-
-[]APIVersionKind
-
+string
Resource is the resource this source will track and send related -lifecycle events from the Kubernetes ApiServer.
+(Optional) +ServiceAccountName is the name of the ServiceAccount to use to run this +source.
selector
+sink
-
-Kubernetes meta/v1.LabelSelector
-
+knative.dev/pkg/apis/duck/v1beta1.Destination
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
+Sink is a reference to an object that will resolve to a domain name to use as the sink.
owner
+ceOverrides
-
-APIVersionKind
-
+knative.dev/pkg/apis/duck/v1.CloudEventOverrides
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.
+CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.
mode
+owner
-string
+
+APIVersionKind
+
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
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.
serviceAccountName
+mode
string
ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set.
+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.
(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceStatus defines the observed state of ApiServerSource
@@ -4592,11 +3160,129 @@ Source. -+(Appears on: +PingResourceSpec) +
++
+| Field | +Description | +
|---|---|
+cpu
+
+string
+
+ |
++ | +
+memory
+
+string
+
+ |
++ | +
+(Appears on: +PingResourceSpec) +
++
+| Field | +Description | +
|---|---|
+cpu
+
+string
+
+ |
++ | +
+memory
+
+string
+
+ |
++ | +
+(Appears on: +PingSourceSpec) +
++
+| Field | +Description | +
|---|---|
+requests
+
+
+PingRequestsSpec
+
+
+ |
++ | +
+limits
+
+
+PingLimitsSpec
+
+
+ |
++ | +
(Appears on: -PingSource) +PingSource)
PingSourceSpec defines the desired state of the PingSource.
@@ -4611,55 +3297,84 @@ Source.SourceSpec
+schedule
-knative.dev/pkg/apis/duck/v1.SourceSpec
+string
-(Members of SourceSpec are embedded into this type.)
-
inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.
+Schedule is the cronjob schedule.
schedule
+data
string
Data is the data posted to the target function.
+sink
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+Sink is a reference to an object that will resolve to a uri to use as the sink.
+ceOverrides
+
+knative.dev/pkg/apis/duck/v1.CloudEventOverrides
+
+Schedule is the cronjob schedule. Defaults to * * * * *.
CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.
jsonData
+serviceAccountName
string
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”.
+ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. +Deprecated: v1beta1 drops this field.
+resources
+
+
+PingResourceSpec
+
+
+Resource limits and Request specifications of the Receive Adapter Deployment +Deprecated: v1beta1 drops this field.
(Appears on: -PingSource) +PingSource)
PingSourceStatus defines the observed state of PingSource.
@@ -4694,11 +3409,11 @@ Source. -(Appears on: -SinkBinding) +SinkBinding)
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
@@ -4722,11 +3437,6 @@ 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.
(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.
(Appears on: -SinkBinding) +SinkBinding)
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
@@ -4775,30 +3482,29 @@ 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.
-
Package v1alpha1 is the v1alpha1 version of the API.
+Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
Resource Types: --
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.
+ApiServerSource is the Schema for the apiserversources API
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
+ |
+||||||||||||
+kind
+string
+ |
+ApiServerSource |
+||||||||||||
metadata
@@ -4826,43 +3549,90 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-ChannelableSpec
+
+ApiServerSourceSpec
- | Spec is the part where the Channelable fulfills the Subscribable contract.
|
@@ -4882,14 +3652,10 @@ ChannelableStatus
status
-
-ChannelableStatus
+
+ApiServerSourceStatus
|
-
ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of both -v1alpha1 and v1beta1 duck types. This is not to be used by resource writers and is -only used by Subscription Controller to synthesize patches and read the Status -of the Channelable Resources. -This is not a real resource.
+ContainerSource is the Schema for the containersources API
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
+ |
+||||||||
+kind
+string
+ |
+ContainerSource |
+||||||||
metadata
@@ -4917,60 +3700,44 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-ChannelableCombinedSpec
+
+ContainerSourceSpec
- | Spec is the part where the Channelable fulfills the Subscribable contract.
|
@@ -4990,14 +3757,10 @@ ChannelableCombinedStatus
status
-
-ChannelableCombinedStatus
+
+ContainerSourceStatus
|
-(Appears on: -ChannelableCombined) -
--
ChannelableSpec contains Spec of the Channelable object
+PingSource is the Schema for the PingSources API.
-SubscribableTypeSpec
-
-
-SubscribableTypeSpec
-
-
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
|
+
|
-
-(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. +kind
+string
|
+PingSource |
-SubscribableSpec
+metadata
-
-SubscribableSpec
+
+Kubernetes meta/v1.ObjectMeta
|
-
-(Members of SubscribableSpec is for the v1beta1 spec compatibility. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-delivery
+spec
-
-DeliverySpec
+
+PingSourceSpec
|
-(Optional)
- DeliverySpec contains options controlling the event delivery - |
-
-(Appears on: -ChannelableCombined) -
--
ChannelableStatus contains the Status of a Channelable object.
- +| Field | -Description | -
|---|---|
-Status
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. |
-AddressStatus
+schedule
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+string
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +(Optional) +Schedule is the cronjob schedule. Defaults to |
-SubscribableTypeStatus
+jsonData
-
-SubscribableTypeStatus
-
+string
|
-
-(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status +(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”. |
-SubscribableStatus
-
-
-SubscribableStatus
-
-
- |
-
-
-(Members of SubscribableStatus is the v1beta1 part of the Subscribers status. + |
errorChannel
+status
-
-Kubernetes core/v1.ObjectReference
+
+PingSourceStatus
ErrorChannel is set by the channel when it supports native error handling via a channel
-(Appears on: -Channelable) -
--
ChannelableSpec contains Spec of the Channelable object
+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.
-SubscribableTypeSpec
-
-
-SubscribableTypeSpec
-
-
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
|
+
|
-
-(Members of kind
+string
|
+SinkBinding |
-delivery
+metadata
-
-DeliverySpec
+
+Kubernetes meta/v1.ObjectMeta
|
-(Optional)
- DeliverySpec contains options controlling the event delivery +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -Channelable) -
--
ChannelableStatus contains the Status of a Channelable object.
- -| Field | -Description | -
|---|---|
-Status
+spec
-knative.dev/pkg/apis/duck/v1.Status
+
+SinkBindingSpec
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-AddressStatus
+SourceSpec
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +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. |
-SubscribableTypeStatus
+BindingSpec
-
-SubscribableTypeStatus
-
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations. + |
+
errorChannel
+status
-
-Kubernetes core/v1.ObjectReference
+
+SinkBindingStatus
ErrorChannel is set by the channel when it supports native error handling via a channel
-
Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch -arbitrary other resources (such as any Source or Addressable). This is not a real resource.
+(Appears on: +ApiServerSourceSpec, +ApiServerSourceSpec) + ++
APIVersionKind is an APIVersion and Kind tuple.
-metadata
+apiVersion
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+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 |
(Appears on: -ChannelSpec, -InMemoryChannelSpec, -SubscribableTypeSpec) +ApiServerSourceSpec)
-
Subscribable is the schema for the subscribable portion of the spec -section of the resource.
+APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
-subscribers
+apiVersion
-
-[]SubscriberSpec
+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
|
- This is the list of subscriptions for this subscribable. +(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 |
(Appears on: -SubscribableTypeStatus) +ApiServerSource)
-
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
+ApiServerSourceSpec defines the desired state of ApiServerSource
-subscribers
+SourceSpec
-
-[]SubscriberStatus
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
- This is the list of subscription’s statuses for this channel. - |
-
-
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.
+(Members ofSourceSpec are embedded into this type.)
-| Field | -Description | +||
|---|---|---|---|
-metadata
+resources
-
-Kubernetes meta/v1.ObjectMeta
+
+[]APIVersionKindSelector
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+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. |
||
-spec
+owner
-
-SubscribableTypeSpec
+
+APIVersionKind
|
- SubscribableTypeSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. -- -
| ||
+serviceAccountName
+
+string
+
+ |
+
+(Optional)
+ ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set. |
+(Appears on: +ApiServerSource) +
++
ApiServerSourceStatus defines the observed state of ApiServerSource
+ +| Field | +Description | +
|---|---|
-status
+SourceStatus
-
-SubscribableTypeStatus
-
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
- SubscribableTypeStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. +
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) +ContainerSource)
-
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+ContainerSourceSpec defines the desired state of ContainerSource
-subscribable
+SourceSpec
-
-Subscribable
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. + |
+
+template
+
+
+Kubernetes core/v1.PodTemplateSpec
|
+ Template describes the pods that will be created |
(Appears on: -ChannelStatus, -ChannelableCombinedStatus, -ChannelableStatus, -InMemoryChannelStatus, -SubscribableType) +ContainerSource)
-
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+ContainerSourceStatus defines the observed state of ContainerSource
-subscribableStatus
+SourceStatus
-
-SubscribableStatus
-
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
+
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
(Appears on: -Subscribable) +PingSource)
-
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
+PingSourceSpec defines the desired state of the PingSource.
-uid
-
-k8s.io/apimachinery/pkg/types.UID
-
- |
-
-(Optional)
- UID is used to understand the origin of the subscriber. - |
-
-generation
+SourceSpec
-int64
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +
+(Members of inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. |
-subscriberURI
+schedule
-knative.dev/pkg/apis.URL
+string
|
(Optional)
+ Schedule is the cronjob schedule. Defaults to |
-replyURI
+jsonData
-knative.dev/pkg/apis.URL
+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”. |
+(Appears on: +PingSource) +
++
PingSourceStatus defines the observed state of PingSource.
+ +
-deadLetterSink
-
-knative.dev/pkg/apis.URL
-
- |
--(Optional) - | +Field | +Description |
|---|---|---|---|
-delivery
+SourceStatus
-
-DeliverySpec
-
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Optional)
+
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
(Appears on: -SubscribableStatus) +SinkBinding)
-
SubscriberStatus defines the status of a single subscriber to a Channel.
+SinkBindingSpec holds the desired state of the SinkBinding (from the client).
-uid
+SourceSpec
-k8s.io/apimachinery/pkg/types.UID
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Optional)
- UID is used to understand the origin of the subscriber. +
+(Members of inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. |
-observedGeneration
+BindingSpec
-int64
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +
+(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations. |
+(Appears on: +SinkBinding) +
++
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
+ +
-ready
-
-
-Kubernetes core/v1.ConditionStatus
-
-
- |
-
-(Optional)
- Status of the subscriber. - |
+Field | +Description |
|---|---|---|---|
-message
+SourceStatus
-string
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Optional)
- A human readable message indicating details of Ready status. +
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
-
Package v1beta1 is the v1beta1 version of the API.
+Package v1alpha1 is the v1alpha1 version of the API.
Resource Types:string alias)-(Appears on: -DeliverySpec) -
--
BackoffPolicyType is the type for backoff policies
- -
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers @@ -5729,7 +4547,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ChannelableSpec
@@ -5741,16 +4559,16 @@ ChannelableSpec
-SubscribableSpec
+SubscribableTypeSpec
-
-SubscribableSpec
+
+SubscribableTypeSpec
|
-(Members of |
status
-
+
ChannelableStatus
@@ -5785,66 +4603,14 @@ ChannelableStatus
|
-(Appears on: -ChannelSpec, -Channelable, -InMemoryChannelSpec) -
--
ChannelableSpec contains Spec of the Channelable object
- -| Field | -Description | -
|---|---|
-SubscribableSpec
-
-
-SubscribableSpec
-
-
- |
-
-
-(Members of |
-
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- DeliverySpec contains options controlling the event delivery - |
-
-(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) -
--
ChannelableStatus contains the Status of a Channelable object.
+ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of both +v1alpha1 and v1beta1 duck types. This is not to be used by resource writers and is +only used by Subscription Controller to synthesize patches and read the Status +of the Channelable Resources. +This is not a real resource.
-Status
+metadata
-knative.dev/pkg/apis/duck/v1.Status
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-AddressStatus
+spec
-knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ChannelableCombinedSpec
+
+
+ |
+
+ Spec is the part where the Channelable fulfills the Subscribable contract. ++ +
|
+||||||
+status
+
+
+ChannelableCombinedStatus
+
+
+ |
+
(Appears on: -BrokerSpec, -BrokerSpec, -ChannelSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ChannelableSpec, -InMemoryChannelSpec, -SequenceStep, -SequenceStep, -SubscriberSpec, -SubscriberSpec, -SubscriptionSpec, -SubscriptionSpec) +ChannelableCombined)
-
DeliverySpec contains the delivery options for event senders, -such as channelable and source.
+ChannelableSpec contains Spec of the Channelable object
-deadLetterSink
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- DeadLetterSink is the sink receiving event that couldn’t be sent to -a destination. - |
-
-retry
+SubscribableTypeSpec
-int32
+
+SubscribableTypeSpec
+
|
-(Optional)
- Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink. +
+(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. |
-backoffPolicy
+SubscribableSpec
-
-BackoffPolicyType
+
+SubscribableSpec
|
-(Optional)
- BackoffPolicy is the retry backoff policy (linear, exponential) +
+(Members of SubscribableSpec is for the v1beta1 spec compatibility. |
-backoffDelay
+delivery
-string
+
+DeliverySpec
+
|
(Optional)
- BackoffDelay is the delay before retrying. -More information on Duration format: https://www.ietf.org/rfc/rfc3339.txt -For linear policy, backoff delay is the time interval between retries.
-For exponential policy , backoff delay is backoffDelay*2^ DeliverySpec contains options controlling the event delivery |
-
DeliveryStatus contains the Status of an object supporting delivery options.
+(Appears on: +ChannelableCombined) + ++
ChannelableStatus contains the Status of a Channelable object.
-deadLetterChannel
+Status
-knative.dev/pkg/apis/duck/v1.KReference
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- DeadLetterChannel is a KReference that is the reference to the native, platform specific channel -where failed events are sent to. - |
-
-
Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
+(Members ofStatus are embedded into this type.)
-| Field | -Description | +||
|---|---|---|---|
-metadata
+AddressStatus
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
||
-spec
-
-
-SubscribableSpec
-
-
- |
-
- SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. -- -
+(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status |
||
-status
+SubscribableStatus
SubscribableStatus
@@ -6100,57 +4849,36 @@ SubscribableStatus
|
- SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. - |
-
-(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -Subscribable) -
-
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
+(Members ofSubscribableStatus are embedded into this type.)
-| Field | -Description | +
|---|---|
-subscribers
+errorChannel
-
-[]SubscriberSpec
+
+Kubernetes core/v1.ObjectReference
|
- This is the list of subscriptions for this subscribable. +(Optional) +ErrorChannel is set by the channel when it supports native error handling via a channel |
(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -Subscribable) +Channelable)
-
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
+ChannelableSpec contains Spec of the Channelable object
-subscribers
+SubscribableTypeSpec
-
-[]SubscriberStatus
+
+SubscribableTypeSpec
|
- This is the list of subscription’s statuses for this channel. +
+(Members of |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ DeliverySpec contains options controlling the event delivery |
(Appears on: -SubscribableSpec) +Channelable)
-
SubscriberSpec defines a single subscriber to a Subscribable.
-At least one of SubscriberURI and ReplyURI must be present
+ChannelableStatus contains the Status of a Channelable object.
-uid
+Status
-k8s.io/apimachinery/pkg/types.UID
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- UID is used to understand the origin of the subscriber. +
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-generation
+AddressStatus
-int64
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
-subscriberUri
+SubscribableTypeStatus
-knative.dev/pkg/apis.URL
+
+SubscribableTypeStatus
+
|
-(Optional)
- SubscriberURI is the endpoint for the subscriber +
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
-replyUri
+errorChannel
-knative.dev/pkg/apis.URL
+
+Kubernetes core/v1.ObjectReference
+
|
(Optional)
- ReplyURI is the endpoint for the reply +ErrorChannel is set by the channel when it supports native error handling via a channel |
+
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.
+ +| Field | +Description | +
|---|---|
-delivery
+metadata
-
-DeliverySpec
+
+Kubernetes meta/v1.ObjectMeta
|
-(Optional)
- DeliverySpec contains options controlling the event delivery +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
(Appears on: -SubscribableStatus) +ChannelSpec, +InMemoryChannelSpec, +SubscribableTypeSpec)
-
SubscriberStatus defines the status of a single subscriber to a Channel.
+Subscribable is the schema for the subscribable portion of the spec +section of the resource.
-uid
+subscribers
-k8s.io/apimachinery/pkg/types.UID
+
+[]SubscriberSpec
+
|
-(Optional)
- UID is used to understand the origin of the subscriber. +This is the list of subscriptions for this subscribable. |
+(Appears on: +SubscribableTypeStatus) +
++
SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
+ +
-observedGeneration
-
-int64
-
- |
-
-(Optional)
- Generation of the origin of the subscriber with uid:UID. - |
+Field | +Description |
|---|---|---|---|
-ready
+subscribers
-
-Kubernetes core/v1.ConditionStatus
+
+[]SubscriberStatus
|
- Status of the subscriber. - |
-||
-message
-
-string
-
- |
-
-(Optional)
- A human readable message indicating details of Ready status. +This is the list of subscription’s statuses for this channel. |
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -6365,84 +5129,128 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ParallelSpec
+
+SubscribableTypeSpec
|
- Spec defines the desired state of the Parallel. +SubscribableTypeSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.
|
-channelTemplate
+status
-
-ChannelTemplateSpec
+
+SubscribableTypeStatus
|
-(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). +SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract. |
+(Appears on: +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType) +
++
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+ +| Field | +Description | +
|---|---|
-reply
+subscribable
-knative.dev/pkg/apis/duck/v1.Destination
+
+Subscribable
+
|
-(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply |
+(Appears on: +ChannelStatus, +ChannelableCombinedStatus, +ChannelableStatus, +InMemoryChannelStatus, +SubscribableType) +
++
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+ +| Field | +Description |
|---|---|
-status
+subscribableStatus
-
-ParallelStatus
+
+SubscribableStatus
|
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. |
(Appears on: -ParallelSpec) +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
-filter
+uid
-knative.dev/pkg/apis/duck/v1.Destination
+k8s.io/apimachinery/pkg/types.UID
|
(Optional)
- Filter is the expression guarding the branch +UID is used to understand the origin of the subscriber. |
-subscriber
+generation
-knative.dev/pkg/apis/duck/v1.Destination
+int64
|
- Subscriber receiving the event when the filter passes +(Optional) +Generation of the origin of the subscriber with uid:UID. |
-reply
+subscriberURI
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis.URL
|
(Optional)
- Reply is a Reference to where the result of Subscriber of this case gets sent to. -If not specified, sent the result to the Parallel Reply |
-(Appears on: -ParallelStatus) -
--
ParallelBranchStatus represents the current state of a Parallel branch
- -| Field | -Description | -
|---|---|
-filterSubscriptionStatus
+replyURI
-
-ParallelSubscriptionStatus
-
+knative.dev/pkg/apis.URL
|
- FilterSubscriptionStatus corresponds to the filter subscription status. +(Optional) |
-filterChannelStatus
+deadLetterSink
-
-ParallelChannelStatus
-
+knative.dev/pkg/apis.URL
|
- FilterChannelStatus corresponds to the filter channel status. +(Optional) |
-subscriberSubscriptionStatus
+delivery
-
-ParallelSubscriptionStatus
+
+DeliverySpec
|
- SubscriptionStatus corresponds to the subscriber subscription status. +(Optional) |
(Appears on: -ParallelBranchStatus, -ParallelStatus) +SubscribableStatus)
+
SubscriberStatus defines the status of a single subscriber to a Channel.
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Channel is the reference to the underlying channel. - |
-
-ready
+uid
-knative.dev/pkg/apis.Condition
+k8s.io/apimachinery/pkg/types.UID
|
- ReadyCondition indicates whether the Channel is ready or not. +(Optional) +UID is used to understand the origin of the subscriber. |
-(Appears on: -Parallel) -
--
-| Field | -Description | -
|---|---|
-branches
+observedGeneration
-
-[]ParallelBranch
-
+int64
|
- Branches is the list of Filter/Subscribers pairs. +(Optional) +Generation of the origin of the subscriber with uid:UID. |
-channelTemplate
+ready
-
-ChannelTemplateSpec
+
+Kubernetes core/v1.ConditionStatus
|
(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). +Status of the subscriber. |
-reply
+message
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply +A human readable message indicating details of Ready status. |
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: +string alias)(Appears on: -Parallel) +DeliverySpec)
-
ParallelStatus represents the current state of a Parallel.
+BackoffPolicyType is the type for backoff policies
+ ++
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.
-Status
+metadata
-knative.dev/pkg/apis/duck/v1.Status
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||
-ingressChannelStatus
+spec
-
-ParallelChannelStatus
+
+ChannelableSpec
|
- IngressChannelStatus corresponds to the ingress channel status. +Spec is the part where the Channelable fulfills the Subscribable contract. ++ +
|
||||
-AddressStatus
+status
-knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ChannelableStatus
+
|
-
-(Members of 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} |
(Appears on: -ParallelBranchStatus) +ChannelSpec, +Channelable, +InMemoryChannelSpec)
+
ChannelableSpec contains Spec of the Channelable object
-subscription
+SubscribableSpec
-
-Kubernetes core/v1.ObjectReference
+
+SubscribableSpec
|
- Subscription is the reference to the underlying Subscription. +
+(Members of |
-ready
+delivery
-knative.dev/pkg/apis.Condition
+
+DeliverySpec
+
|
- ReadyCondition indicates whether the Subscription is ready or not. +(Optional) +DeliverySpec contains options controlling the event delivery |
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
+(Appears on: +ChannelStatus, +Channelable, +InMemoryChannelStatus) + ++
ChannelableStatus contains the Status of a Channelable object.
-metadata
+Status
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
||||||
-spec
-
-
-SequenceSpec
-
-
- |
-
- Spec defines the desired state of the Sequence. -- -
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
||||||
-status
+deadLetterChannel
-
-SequenceStatus
-
+knative.dev/pkg/apis/duck/v1.KReference
|
(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. +DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel +Failed messages are delivered here. |
(Appears on: -SequenceStatus) +BrokerSpec, +BrokerSpec, +ChannelSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +InMemoryChannelSpec, +SequenceStep, +SequenceStep, +SubscriberSpec, +SubscriberSpec, +SubscriptionSpec, +SubscriptionSpec)
+
DeliverySpec contains the delivery options for event senders, +such as channelable and source.
-channel
+deadLetterSink
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- Channel is the reference to the underlying channel. +(Optional) +DeadLetterSink is the sink receiving event that couldn’t be sent to +a destination. |
-ready
+retry
-knative.dev/pkg/apis.Condition
+int32
|
- ReadyCondition indicates whether the Channel is ready or not. +(Optional) +Retry is the minimum number of retries the sender should attempt when +sending an event before moving it to the dead letter sink. |
-(Appears on: -Sequence) -
--
-| Field | -Description | -
|---|---|
-steps
+backoffPolicy
-
-[]SequenceStep
+
+BackoffPolicyType
|
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options +(Optional) +BackoffPolicy is the retry backoff policy (linear, exponential) |
-channelTemplate
+backoffDelay
-
-ChannelTemplateSpec
-
+string
|
(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). +BackoffDelay is the delay before retrying. +More information on Duration format: https://www.ietf.org/rfc/rfc3339.txt +For linear policy, backoff delay is the time interval between retries.
+For exponential policy , backoff delay is backoffDelay*2^ |
+
DeliveryStatus contains the Status of an object supporting delivery options.
+ +| Field | +Description | +
|---|---|
-reply
+deadLetterChannel
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.KReference
|
(Optional)
- Reply is a Reference to where the result of the last Subscriber gets sent to. +DeadLetterChannel is a KReference that is the reference to the native, platform specific channel +where failed events are sent to. |
-(Appears on: -Sequence) -
--
SequenceStatus represents the current state of a Sequence.
+Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
-Status
+metadata
-knative.dev/pkg/apis/duck/v1.Status
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-subscriptionStatuses
+spec
-
-[]SequenceSubscriptionStatus
+
+SubscribableSpec
|
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. - |
-
-channelStatuses
+subscribers
-
-[]SequenceChannelStatus
+
+[]SubscriberSpec
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. +This is the list of subscriptions for this subscribable. + |
+
AddressStatus
+status
-knative.dev/pkg/apis/duck/v1.AddressStatus
+
+SubscribableStatus
+
-(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}
+SubscribableStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract.
(Appears on: -SequenceSpec) +ChannelableCombinedSpec, +ChannelableSpec, +Subscribable)
+
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-Destination
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-
-(Members of Subscriber receiving the step event - |
-
-delivery
+subscribers
-
-DeliverySpec
+
+[]SubscriberSpec
|
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. +This is the list of subscriptions for this subscribable. |
(Appears on: -SequenceStatus) +ChannelableCombinedStatus, +ChannelableStatus, +Subscribable)
+
SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
-subscription
+subscribers
-
-Kubernetes core/v1.ObjectReference
+
+[]SubscriberStatus
|
- Subscription is the reference to the underlying Subscription. - |
-
-ready
-
-knative.dev/pkg/apis.Condition
-
- |
-
- ReadyCondition indicates whether the Subscription is ready or not. +This is the list of subscription’s statuses for this channel. |
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +SubscribableSpec) -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
+SubscriberSpec defines a single subscriber to a Subscribable.
+At least one of SubscriberURI and ReplyURI must be present
-apiVersion
-string |
+
-
-messaging.knative.dev/v1alpha1
-
+(Optional)
+UID is used to understand the origin of the subscriber. |
||||||||
-kind
-string
+generation
+
+int64
+
+ |
+
+(Optional)
+ Generation of the origin of the subscriber with uid:UID. |
-Channel |
|||||||
-metadata
+subscriberUri
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis.URL
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+SubscriberURI is the endpoint for the subscriber |
||||||||
-spec
+replyUri
-
-ChannelSpec
-
+knative.dev/pkg/apis.URL
|
- Spec defines the desired state of the Channel. -- -
SubscriberStatus +++(Appears on: +SubscribableStatus) + ++ SubscriberStatus defines the status of a single subscriber to a Channel. + +
| ||||||||
+ready
+
+
+Kubernetes core/v1.ConditionStatus
+
+
+ |
+
+ Status of the subscriber. |
||||||||
-status
+message
-
-ChannelStatus
-
+string
|
(Optional)
- Status represents the current state of the Channel. This data may be out of -date. +A human readable message indicating details of Ready status. |
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: + +-
InMemoryChannel is a resource representing an in memory channel
+Broker collects a pool of events that are consumable using Triggers. Brokers +provide a well-known endpoint for event delivery that senders can use with +minimal knowledge of the event routing strategy. Receivers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.
-messaging.knative.dev/v1alpha1
+eventing.knative.dev/v1alpha1
|
@@ -7303,7 +6091,7 @@ messaging.knative.dev/v1alpha1
InMemoryChannel |
+Broker |
|||||||||||||||||||||||||||||||||||||||||||
| @@ -7324,27 +6112,47 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-InMemoryChannelSpec
+
+BrokerSpec
+
+
+ |
+
+ Spec defines the desired state of the Broker. ++ +
Subscription
+ |
-messaging.knative.dev/v1alpha1
+eventing.knative.dev/v1alpha1
|
@@ -7409,7 +6217,7 @@ messaging.knative.dev/v1alpha1
Subscription |
+EventType |
|||||||||||||
| @@ -7421,6 +6229,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -7429,88 +6238,75 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SubscriptionSpec
+
+EventTypeSpec
|
+ Spec defines the desired state of the EventType.
|
status
-
-SubscriptionStatus
+
+EventTypeStatus
|
+(Optional)
+ Status represents the current state of the EventType. +This data may be out of date. +TODO might be removed https://github.com/knative/eventing/issues/2750 |
-(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.
+Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.
-channelTemplate
-
-
-ChannelTemplateSpec
-
-
+apiVersion
+string |
+
+
+eventing.knative.dev/v1alpha1
+
|
+
|
- 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. +kind
+string
|
+Trigger |
-subscribable
+metadata
-
-Subscribable
+
+Kubernetes meta/v1.ObjectMeta
|
- Channel conforms to Duck type Subscribable. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-delivery
+spec
-
-DeliverySpec
+
+TriggerSpec
|
- Delivery options. - |
-
-(Appears on: -Channel) -
--
ChannelStatus represents the current state of a Channel.
- +Spec defines the desired state of the Trigger.
+| Field | -Description | -
|---|---|
-Status
+broker
-knative.dev/pkg/apis/duck/v1.Status
+string
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’. |
-AddressStatus
+filter
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+TriggerFilter
+
|
-
-(Members of Channel 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} +(Optional) +Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events. |
-SubscribableTypeStatus
+subscriber
-
-SubscribableTypeStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required. + |
+
channel
+status
-
-Kubernetes core/v1.ObjectReference
+
+TriggerStatus
Channel is an ObjectReference to the Channel CRD backing this Channel.
+(Optional) +Status represents the current state of the Trigger. This data may be out of +date.
(Appears on: -InMemoryChannel) +Broker)
-
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
-subscribable
+channelTemplateSpec
-
-Subscribable
+
+ChannelTemplateSpec
|
- Channel conforms to Duck type Subscribable. +(Optional) +ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the
+Broker. 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).
+Deprecated: See spec.config to configure aditional broker options.
+Unless class is |
+
+config
+
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+(Optional)
+ Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap. +NOTE: this is for backwards compatibility with v1alpha1 <-> v1beta1 conversions. |
|
- For round tripping (v1beta1 <-> v1alpha1> +(Optional) +Delivery is the delivery specification to be used internally by the broker to +create subscriptions. |
(Appears on: -InMemoryChannel) +Broker)
-
ChannelStatus represents the current state of a Channel.
+BrokerStatus represents the current state of a Broker.
-AddressStatus
+address
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+knative.dev/pkg/apis/duck/v1alpha1.Addressable
|
-
-(Members of InMemoryChannel is Addressable. It currently exposes the endpoint as a + Broker 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} +It generally has the form {broker}-router.{namespace}.svc.{cluster domain name} |
-SubscribableTypeStatus
+triggerChannel
-
-SubscribableTypeStatus
+
+Kubernetes core/v1.ObjectReference
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +TriggerChannel is an objectref to the object for the TriggerChannel |
(Appears on: -Subscription) +EventType)
-
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
-generation
+type
-int64
+string
|
-(Optional)
- TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete. -We should be able to drop this property with a CRD conversion webhook -in the future +Type represents the CloudEvents type. It is authoritative. |
-channel
+source
-
-Kubernetes core/v1.ObjectReference
-
+string
|
- This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.) +(Optional) +Source is a URI, it represents the CloudEvents source. |
-subscriber
+schema
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
(Optional)
- Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply. +Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional. |
-reply
+broker
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. +TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType. |
-delivery
+description
-
-DeliverySpec
-
+string
|
(Optional)
- Delivery configuration +Description is an optional field used to describe the EventType, in any meaningful way. |
(Appears on: -Subscription) +EventType)
-
SubscriptionStatus (computed) for a subscription
+EventTypeStatus represents the current state of a EventType.
+(Appears on: +TriggerSpec) +
++
+| Field | +Description | +
|---|---|
-physicalSubscription
+sourceAndType
-
-SubscriptionStatusPhysicalSubscription
+
+TriggerFilterSourceAndType
|
- PhysicalSubscription is the fully resolved values that this Subscription represents. +(Optional) +DeprecatedSourceAndType filters events based on exact matches on the +CloudEvents type and source attributes. This field has been replaced by the +Attributes field. + |
+
+attributes
+
+
+TriggerFilterAttributes
+
+
+ |
+
+(Optional)
+ Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values. +Nested context attributes are not supported as keys. Only string values are supported. |
map[string]string alias)+(Appears on: +TriggerFilter) +
++
TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.
+ +(Appears on: -SubscriptionStatus) +TriggerFilter)
-
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
+TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and +source attributes. Only exact matches will pass the filter. Either or both type and source can +use the value “ to indicate all strings match.
-subscriberURI
-
-knative.dev/pkg/apis.URL
-
- |
-
- SubscriberURI is the fully resolved URI for spec.subscriber. - |
-
-replyURI
+type
-knative.dev/pkg/apis.URL
+string
|
- ReplyURI is the fully resolved URI for the spec.reply. |
-deadLetterSinkURI
+source
-knative.dev/pkg/apis.URL
+string
|
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
-
Package v1beta1 is the v1beta1 version of the API.
+(Appears on: +Trigger) -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
+broker
+
+string
+
|
-
-kind
-string
+Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’. |
-Channel |
-metadata
+filter
-
-Kubernetes meta/v1.ObjectMeta
+
+TriggerFilter
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events. |
-spec
+subscriber
-
-ChannelSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- Spec defines the desired state of the Channel. -- + Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required. + |
+
+(Appears on: +Trigger) +
++
TriggerStatus represents the current state of a Trigger.
+
-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. - |
+Field | +Description |
|---|---|---|---|
-ChannelableSpec
+Status
-
-ChannelableSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of Channel conforms to ChannelableSpec - |
-
inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
status
+subscriberURI
-
-ChannelStatus
-
+knative.dev/pkg/apis.URL
Status represents the current state of the Channel. This data may be out of -date.
+SubscriberURI is the resolved URI of the receiver for this Trigger.
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: + +-
InMemoryChannel is a resource representing an in memory channel
+Broker collects a pool of events that are consumable using Triggers. Brokers +provide a well-known endpoint for event delivery that senders can use with +minimal knowledge of the event routing strategy. Receivers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.
-messaging.knative.dev/v1beta1
+eventing.knative.dev/v1beta1
|
@@ -8142,7 +6943,7 @@ messaging.knative.dev/v1beta1
InMemoryChannel |
+Broker |
||||||
| @@ -8163,30 +6964,43 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-InMemoryChannelSpec
+
+BrokerSpec
|
- Spec defines the desired state of the Channel. +Spec defines the desired state of the Broker.
|
status
-
-InMemoryChannelStatus
+
+BrokerStatus
|
(Optional)
- Status represents the current state of the Channel. This data may be out of + Status represents the current state of the Broker. This data may be out of date. |
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
-messaging.knative.dev/v1beta1
+eventing.knative.dev/v1beta1
|
@@ -8238,7 +7050,7 @@ messaging.knative.dev/v1beta1
Subscription |
+EventType |
|||||||||
| @@ -8250,6 +7062,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -8258,248 +7071,117 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SubscriptionSpec
+
+EventTypeSpec
|
+ Spec defines the desired state of the EventType.
|
-||||||||
-status
-
-
-SubscriptionStatus
-
-
- |
-- | -
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- --(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.
- -| Field | -Description | -
|---|---|
-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 Channel conforms to ChannelableSpec +SchemaData allows the CloudEvents schema to be stored directly in the +EventType. Content is dependent on the encoding. Optional attribute. +The contents are not validated or manipulated by the system. |
-
-(Appears on: -Channel) -
--
ChannelStatus represents the current state of a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableStatus
+broker
-
-ChannelableStatus
-
+string
|
-
-(Members of Channel conforms to ChannelableStatus +(Optional) +TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType. |
-channel
+description
-knative.dev/pkg/apis/duck/v1.KReference
+string
|
- Channel is an KReference to the Channel CRD backing this Channel. +(Optional) +Description is an optional field used to describe the EventType, in any meaningful way. |
-(Appears on: -BrokerSpec, -ChannelSpec, -ChannelSpec, -ParallelSpec, -ParallelSpec, -SequenceSpec, -SequenceSpec) -
--
-| Field | -Description | +
|---|---|
-spec
+status
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+EventTypeStatus
+
|
(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - Status represents the current state of the EventType. +This data may be out of date. +TODO might be removed https://github.com/knative/eventing/issues/2750 |
-
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.
+Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.
+apiVersion
+string |
+
+
+eventing.knative.dev/v1beta1
+
+ |
+|||||||
+kind
+string
+ |
+Trigger |
+|||||||
metadata
@@ -8528,31 +7227,82 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+TriggerSpec
+
-(Optional)
- |
Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. +Spec defines the desired state of the Trigger.
| ||||||
+status
+
+
+TriggerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Trigger. This data may be out of +date. + |
+
(Appears on: -InMemoryChannel) +Broker)
-
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
-ChannelableSpec
+config
-
-ChannelableSpec
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+(Optional)
+ Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap. + |
+
+delivery
+
+
+DeliverySpec
|
-
-(Members of Channel conforms to Duck type Channelable. +(Optional) +Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc. |
(Appears on: -InMemoryChannel) +Broker)
-
ChannelStatus represents the current state of a Channel.
+BrokerStatus represents the current state of a Broker.
-ChannelableStatus
+Status
-
-ChannelableStatus
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of Channel conforms to Duck type Channelable. +inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+address
+
+knative.dev/pkg/apis/duck/v1.Addressable
+
+ |
+
+ Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh. |
(Appears on: -Subscription) +EventType)
-
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
-channel
+type
-
-Kubernetes core/v1.ObjectReference
-
+string
|
- Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status. -This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.) +Type represents the CloudEvents type. It is authoritative. + |
+
+source
+
+knative.dev/pkg/apis.URL
+
+ |
+
+(Optional)
+ Source is a URI, it represents the CloudEvents source. + |
+
+schema
+
+knative.dev/pkg/apis.URL
+
+ |
+
+(Optional)
+ Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional. |
-subscriber
+schemaData
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
(Optional)
- Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply. +SchemaData allows the CloudEvents schema to be stored directly in the +EventType. Content is dependent on the encoding. Optional attribute. +The contents are not validated or manipulated by the system. |
-reply
+broker
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. +TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType. |
-delivery
+description
-
-DeliverySpec
-
+string
|
(Optional)
- Delivery configuration +Description is an optional field used to describe the EventType, in any meaningful way. |
(Appears on: -Subscription) +EventType)
-
SubscriptionStatus (computed) for a subscription
+EventTypeStatus represents the current state of a EventType.
+(Appears on: +TriggerSpec) +
++
+| Field | +Description | +
|---|---|
-physicalSubscription
+attributes
-
-SubscriptionStatusPhysicalSubscription
+
+TriggerFilterAttributes
|
- PhysicalSubscription is the fully resolved values that this Subscription represents. +(Optional) +Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values. +Nested context attributes are not supported as keys. Only string values are supported. |
map[string]string alias)+(Appears on: +TriggerFilter) +
++
TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.
+ +(Appears on: -SubscriptionStatus) +Trigger)
-
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
-subscriberUri
+broker
-knative.dev/pkg/apis.URL
+string
|
- SubscriberURI is the fully resolved URI for spec.subscriber. +Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’. |
-replyUri
+filter
-knative.dev/pkg/apis.URL
+
+TriggerFilter
+
|
- ReplyURI is the fully resolved URI for the spec.reply. +(Optional) +Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events. |
-deadLetterSinkUri
+subscriber
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required. + |
+
+(Appears on: +Trigger) +
++
TriggerStatus represents the current state of a Trigger.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+subscriberUri
knative.dev/pkg/apis.URL
|
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. +SubscriberURI is the resolved URI of the receiver for this Trigger. |
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+Package v1beta1 is the v1beta1 version of the API.
Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-sources.knative.dev/v1alpha1
+messaging.knative.dev/v1beta1
|
@@ -8855,7 +7709,7 @@ sources.knative.dev/v1alpha1
ApiServerSource |
+Channel |
|||||||||||||||||
| @@ -8867,6 +7721,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -8875,109 +7730,44 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ApiServerSourceSpec
+
+ChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-ApiServerSourceStatus
+
+ChannelStatus
|
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. |
-
PingSource is the Schema for the PingSources API.
+InMemoryChannel is a resource representing an in memory channel
-sources.knative.dev/v1alpha1
+messaging.knative.dev/v1beta1
|
@@ -9025,7 +7818,7 @@ sources.knative.dev/v1alpha1
PingSource |
+InMemoryChannel |
|||||||||||||||
| @@ -9037,6 +7830,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -9045,86 +7839,30 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-PingSourceSpec
+
+InMemoryChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-PingSourceStatus
+
+InMemoryChannelStatus
|
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. |
-
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.
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
-sources.knative.dev/v1alpha1
+messaging.knative.dev/v1beta1
|
@@ -9177,7 +7914,7 @@ sources.knative.dev/v1alpha1
SinkBinding |
+Subscription |
||||||||
| @@ -9197,8 +7934,8 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-SinkBindingSpec
+
+SubscriptionSpec
|
@@ -9208,28 +7945,70 @@ SinkBindingSpec
-SourceSpec
+channel
-knative.dev/pkg/apis/duck/v1.SourceSpec
+
+Kubernetes core/v1.ObjectReference
+
|
-
-(Members of 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.) |
-BindingSpec
+subscriber
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of 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
-
-SinkBindingStatus
+
+SubscriptionStatus
+
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ +(Appears on: -ApiServerSourceSpec) +Channel)
-
ApiServerResource defines the resource to watch
+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.
-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 -Deprecated: Per-resource label selectors will no longer be supported in -v1alpha2, please use Spec.LabelSelector. - |
-|
-controllerSelector
+channelTemplate
-
-Kubernetes meta/v1.OwnerReference
+
+ChannelTemplateSpec
|
-
- 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. - |
+
+ 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. + |
-controller
+ChannelableSpec
-bool
+
+ChannelableSpec
+
|
- 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. +
+(Members of Channel conforms to ChannelableSpec |
(Appears on: -ApiServerSource) +Channel)
-
ApiServerSourceSpec defines the desired state of ApiServerSource
+ChannelStatus represents the current state of a Channel.
-resources
+ChannelableStatus
-
-[]ApiServerResource
+
+ChannelableStatus
|
- Resources is the list of resources to watch +
+(Members of Channel conforms to ChannelableStatus |
-serviceAccountName
+channel
-string
+knative.dev/pkg/apis/duck/v1.KReference
|
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. +Channel is an KReference to the Channel CRD backing this Channel. |
+(Appears on: +BrokerSpec, +ChannelSpec, +ChannelSpec, +ParallelSpec, +ParallelSpec, +SequenceSpec, +SequenceSpec) +
++
+
-sink
-
-knative.dev/pkg/apis/duck/v1beta1.Destination
-
- |
-
-(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. - |
+Field | +Description |
|---|---|---|---|
-ceOverrides
+spec
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
(Optional)
- CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink. +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
+
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.
+ +| Field | +Description | +
|---|---|
-selector
+metadata
-
-Kubernetes meta/v1.LabelSelector
+
+Kubernetes meta/v1.ObjectMeta
|
(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 +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-owner
+spec
-
-APIVersionKind
-
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
(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. +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
+(Appears on: +InMemoryChannel) +
++
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
+ +| Field | +Description | +
|---|---|
-mode
+ChannelableSpec
-string
+
+ChannelableSpec
+
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
-
+(Members of Channel conforms to Duck type Channelable. |
(Appears on: -ApiServerSource) +InMemoryChannel)
-
ApiServerSourceStatus defines the observed state of ApiServerSource
+ChannelStatus represents the current state of a Channel.
-SourceStatus
+ChannelableStatus
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ChannelableStatus
+
|
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. +Channel conforms to Duck type Channelable. |
(Appears on: -PingResourceSpec) +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
-cpu
+channel
-string
+
+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.) |
-memory
+subscriber
-string
+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 |
(Appears on: -PingResourceSpec) +Subscription)
+
SubscriptionStatus (computed) for a subscription
-cpu
+Status
-string
+knative.dev/pkg/apis/duck/v1.Status
|
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-memory
+physicalSubscription
-string
+
+SubscriptionStatusPhysicalSubscription
+
|
+ PhysicalSubscription is the fully resolved values that this Subscription represents. |
(Appears on: -PingSourceSpec) +SubscriptionStatus)
+
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-requests
+subscriberUri
-
-PingRequestsSpec
-
+knative.dev/pkg/apis.URL
|
+ SubscriberURI is the fully resolved URI for spec.subscriber. |
-limits
+replyUri
-
-PingLimitsSpec
-
+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. |
-(Appears on: -PingSource) +
Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types: + +-
PingSourceSpec defines the desired state of the PingSource.
+ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
-schedule
-
-string
-
+apiVersion
+string |
+
+
+configs.internal.knative.dev/v1alpha1
+
|
+
|
- Schedule is the cronjob schedule. +kind
+string
|
+ConfigMapPropagation |
-data
+metadata
-string
+
+Kubernetes meta/v1.ObjectMeta
+
|
- Data is the data posted to the target function. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-sink
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+ConfigMapPropagationSpec
+
|
- Sink is a reference to an object that will resolve to a uri to use as the sink. - |
-
-ceOverrides
+originalNamespace
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides
+string
|
-(Optional)
- CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink. +OriginalNamespace is the namespace where the original configMaps are in |
-serviceAccountName
+selector
-string
+
+Kubernetes meta/v1.LabelSelector
+
|
- ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. -Deprecated: v1beta1 drops this field. +(Optional) +Selector only selects original configMaps with corresponding labels + |
+
resources
+status
-
-PingResourceSpec
+
+ConfigMapPropagationStatus
Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.
+(Optional) +Status represents the current state of the EventType. +This data may be out of date.
(Appears on: -PingSource) +ConfigMapPropagation)
-
PingSourceStatus defines the observed state of PingSource.
-Status
+originalNamespace
-knative.dev/pkg/apis/duck/v1.Status
+string
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +OriginalNamespace is the namespace where the original configMaps are in |
-sinkUri
+selector
-knative.dev/pkg/apis.URL
+
+Kubernetes meta/v1.LabelSelector
+
|
(Optional)
- SinkURI is the current active sink URI that has been configured for the PingSource. +Selector only selects original configMaps with corresponding labels |
(Appears on: -SinkBinding) +ConfigMapPropagation)
-
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
-SourceSpec
+Status
-knative.dev/pkg/apis/duck/v1.SourceSpec
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-BindingSpec
+copyConfigmaps
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+[]ConfigMapPropagationStatusCopyConfigMap
+
|
-
-(Members of CopyConfigMaps is the status for each copied configmap. |
(Appears on: -SinkBinding) +ConfigMapPropagationStatus)
-
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
+ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
-SourceStatus
+name
-knative.dev/pkg/apis/duck/v1.SourceStatus
+string
|
-
-(Members of 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 |
|
(Optional)
- Spec holds the desired state of the Configuration (from the client). +Spec holds the desired state of the PodAutoscaler (from the client).
|
status
-
-ConfigurationStatus
+
+PodAutoscalerStatus
|
(Optional)
- Status communicates the observed state of the Configuration (from the controller). +Status communicates the observed state of the PodAutoscaler (from the controller). |
-
Revision is an immutable snapshot of code and configuration. A revision -references a container image, and optionally a build that is responsible for -materializing that container image from source. Revisions are created by -updates to a Configuration.
-See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision
+Metric represents a resource to configure the metric collector with.
-apiVersion
-string |
-
-
-serving.knative.dev/v1alpha1
-
- |
-|||||||
-kind
-string
- |
-Revision |
-|||||||
metadata
@@ -228,158 +207,129 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-RevisionSpec
+
+MetricSpec
(Optional)
- |
Spec holds the desired state of the Revision (from the client). +Spec holds the desired state of the Metric (from the client).
| ||||||
-concurrencyModel
+status
-
-DeprecatedRevisionRequestConcurrencyModelType
+
+MetricStatus
|
(Optional)
- DeprecatedConcurrencyModel specifies the desired concurrency model -(Single or Multi) for the -Revision. Defaults to Multi. -Deprecated in favor of ContainerConcurrency. +Status communicates the observed state of the Metric (from the controller). |
+(Appears on: +Metric) +
++
MetricSpec contains all values a metric collector needs to operate.
+ +
-buildName
-
-string
-
- |
-
-(Optional)
- DeprecatedBuildName optionally holds the name of the Build responsible for -producing the container image for its Revision. -DEPRECATED: Use DeprecatedBuildRef instead. - |
+Field | +Description |
|---|---|---|---|
-buildRef
+stableWindow
-
-Kubernetes core/v1.ObjectReference
-
+time.Duration
|
-(Optional)
- DeprecatedBuildRef holds the reference to the build (if there is one) responsible -for producing the container image for this Revision. Otherwise, nil +StableWindow is the aggregation window for metrics in a stable state. |
||
-container
+panicWindow
-
-Kubernetes core/v1.Container
-
+time.Duration
|
-(Optional)
- Container defines the unit of execution for this Revision. -In the context of a Revision, we disallow a number of the fields of -this Container, including: name and lifecycle. -See also the runtime contract for more information about the execution -environment: -https://github.com/knative/serving/blob/master/docs/runtime-contract.md - |
-
PanicWindow is the aggregation window for metrics where quick reactions are needed.
status
+scrapeTarget
-
-RevisionStatus
-
+string
Status communicates the observed state of the Revision (from the controller).
+ScrapeTarget is the K8s service that publishes the metric endpoint.
-
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
+(Appears on: +Metric) + ++
MetricStatus reflects the status of metric collection for this specific entity.
-kind
-string
- |
-Route |
+Field | +Description | ||
|---|---|---|---|---|---|
-metadata
+generation
-
-Kubernetes meta/v1.ObjectMeta
-
+int64
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+DeprecatedGeneration was used prior in Kubernetes versions <1.11 +when metadata.generation was not being incremented by the api server +This property will be dropped in future Knative releases and should +not be used - use metadata.generation +Tracking issue: https://github.com/knative/serving/issues/643 |
||||
-spec
+containerConcurrency
-
-RouteSpec
-
+int64
|
(Optional)
- Spec holds the desired state of the Route (from the client). -- -
Reachable specifies whether or not the |
||||
-status
+protocolType
-
-RouteStatus
-
+knative.dev/serving/pkg/apis/networking.ProtocolType
|
-(Optional)
- Status communicates the observed state of the Route (from the controller). +The application-layer protocol. Matches |
-
Service acts as a top-level container that manages a set of Routes and -Configurations 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
+(Appears on: +PodAutoscaler) + ++
PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).
-apiVersion
-string |
-
-
-serving.knative.dev/v1alpha1
-
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
|
-||||||||||||||||||||||||||||||||||||||||||
-kind
-string
+
+(Members of |
-Service |
||||||||||||||||||||||||||||||||||||||||||
-metadata
+serviceName
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+ServiceName is the K8s Service name that serves the revision, scaled by this PA. +The service is created and owned by the ServerlessService object owned by this PA. |
||||||||||||||||||||||||||||||||||||||||||
-spec
+metricsServiceName
-
-ServiceSpec
-
+string
|
-(Optional)
- - -
PodScalable +++ PodScalable is a duck type that the resources referenced by the
+PodAutoscaler’s ScaleTargetRef must implement. They must also
+implement the
|
status
-
-ServiceStatus
+
+PodScalableStatus
-(Optional)
|
CannotConvertError
+ |
-Message
+replicas
-string
+int32
|
@@ -708,9 +646,23 @@ string |
-Field
+selector
-string
+
+Kubernetes meta/v1.LabelSelector
+
+
+ |
++ | +
+template
+
+
+Kubernetes core/v1.PodTemplateSpec
+
|
@@ -718,18 +670,15 @@ string |
(Appears on: -Configuration, -PinnedType, -ReleaseType, -RunLatestType, -ServiceSpec) +PodScalable)
-
ConfigurationSpec holds the desired state of the Configuration (from the client).
+PodScalableStatus is the observed state of a PodScalable (or at +least our shared portion).
-generation
+replicas
-int64
+int32
|
-(Optional)
- DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server -This property will be dropped in future Knative releases and should -not be used - use metadata.generation -Tracking issue: https://github.com/knative/serving/issues/643 |
string alias)+(Appears on: +PodAutoscalerSpec) +
++
ReachabilityType is the enumeration type for the different states of reachability
+to the ScaleTarget of a PodAutoscaler
+
+Resource Types: ++
Certificate is responsible for provisioning a SSL certificate for the +given hosts. It is a Knative abstraction for various SSL certificate +provisioning solutions (such as cert-manager or self-signed SSL certificate).
+ +| Field | +Description | +
|---|---|
-build
-
-k8s.io/apimachinery/pkg/runtime.RawExtension
-
+apiVersion
+string |
+
+
+networking.internal.knative.dev/v1alpha1
+
|
+
|
-(Optional)
- Build optionally holds the specification for the build to -perform to produce the Revision’s container image. +kind
+string
|
+Certificate |
-revisionTemplate
+metadata
-
-RevisionTemplateSpec
+
+Kubernetes meta/v1.ObjectMeta
|
(Optional)
- DeprecatedRevisionTemplate holds the latest specification for the Revision to -be stamped out. If a Build specification is provided, then the -DeprecatedRevisionTemplate’s BuildName field will be populated with the name of -the Build object created to produce the container for the Revision. -DEPRECATED Use Template instead. +Standard object’s metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-template
+spec
-
-RevisionTemplateSpec
+
+CertificateSpec
|
(Optional)
- Template holds the latest specification for the Revision to -be stamped out. - |
-
-(Appears on: -Configuration) -
--
ConfigurationStatus communicates the observed state of the Configuration (from the controller).
- +Spec is the desired state of the Certificate. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+| Field | -Description | +
+dnsNames
+
+[]string
+
+ |
+
+ DNSNames is a list of DNS names the Certificate could support. +The wildcard format of DNSNames (e.g. *.default.example.com) is supported. + |
|---|---|---|---|
-Status
+secretName
-knative.dev/pkg/apis/duck/v1.Status
+string
|
-
-(Members of SecretName is the name of the secret resource to store the SSL certificate in. + |
+
ConfigurationStatusFields
+status
-
-ConfigurationStatusFields
+
+CertificateStatus
-(Members of ConfigurationStatusFields are embedded into this type.)
-
Status is the current state of the Certificate. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
-(Appears on: -ConfigurationStatus, -ServiceStatus) -
--
ConfigurationStatusFields holds all of the non-duckv1.Status status fields of a Route. -These are defined outline so that we can also inline them into Service, and more easily -copy them.
+Ingress is a collection of rules that allow inbound connections to reach the endpoints defined +by a backend. An Ingress can be configured to give services externally-reachable URLs, load +balance traffic, offer name based virtual hosting, etc.
+This is heavily based on K8s Ingress https://godoc.org/k8s.io/api/networking/v1beta1#Ingress +which some highlighted modifications.
-latestReadyRevisionName
-
+apiVersion
+string |
+
+
+networking.internal.knative.dev/v1alpha1
+
+ |
+||||||||||||||
+kind
string
+ |
+Ingress |
+||||||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- LatestReadyRevisionName holds the name of the latest Revision stamped out -from this Configuration that has had its “Ready” condition become “True”. +Standard object’s metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||||||||
-latestCreatedRevisionName
+spec
-string
+
+IngressSpec
+
|
(Optional)
- LatestCreatedRevisionName is the last revision that was created from this -Configuration. It might not be ready yet, for that use LatestReadyRevisionName. +Spec is the desired state of the Ingress. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status ++ +
DeprecatedRevisionRequestConcurrencyModelType
-(
- |
| Field | -Description | -
|---|---|
-revisionName
+tls
-string
+
+[]IngressTLS
+
|
(Optional)
- The revision name to pin this service to until changed -to a different service type. +TLS configuration. Currently Ingress only supports a single TLS +port: 443. If multiple members of this list specify different hosts, they +will be multiplexed on the same port according to the hostname specified +through the SNI TLS extension, if the ingress controller fulfilling the +ingress supports SNI. |
-configuration
+rules
-
-ConfigurationSpec
+
+[]IngressRule
|
(Optional)
- The configuration for this service. +A list of host rules used to configure the Ingress. |
-(Appears on: -ServiceSpec) -
--
ReleaseType contains the options for slowly releasing revisions. See ServiceSpec for -more details.
- -| Field | -Description | -
|---|---|
-revisions
+visibility
-[]string
+
+IngressVisibility
+
|
-(Optional)
- Revisions is an ordered list of 1 or 2 revisions. The first will -have a TrafficTarget with a name of “current” and the second will have -a name of “candidate”. +Visibility setting. |
-rolloutPercent
-
-int
-
- |
-
-(Optional)
- RolloutPercent is the percent of traffic that should be sent to the “candidate” -revision. Valid values are between 0 and 99 inclusive. + |
configuration
+status
-
-ConfigurationSpec
+
+IngressStatus
The configuration for this service. All revisions from this service must -come from a single configuration.
+Status is the current state of the Ingress. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
-(Appears on: -Revision, -RevisionTemplateSpec) -
--
RevisionSpec holds the desired state of the Revision (from the client).
+ServerlessService is a proxy for the K8s service objects containing the +endpoints for the revision, whether those are endpoints of the activator or +revision pods. +See: https://knative.page.link/naxz for details.
-RevisionSpec
-
-
-RevisionSpec
-
-
+apiVersion
+string |
+
+
+networking.internal.knative.dev/v1alpha1
+
|
+||||||||
|
-
-(Members of kind
+string
|
+ServerlessService |
||||||||
-generation
+metadata
-int64
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server -This property will be dropped in future Knative releases and should -not be used - use metadata.generation -Tracking issue: https://github.com/knative/serving/issues/643 +Standard object’s metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||
-servingState
+spec
-
-DeprecatedRevisionServingStateType
+
+ServerlessServiceSpec
|
(Optional)
- DeprecatedServingState holds a value describing the desired state the Kubernetes -resources should be in for this Revision. -Users must not specify this when creating a revision. These values are no longer -updated by the system. +Spec is the desired state of the ServerlessService. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status ++ +
|
||||||||
-container
+status
-
-Kubernetes core/v1.Container
+
+ServerlessServiceStatus
|
(Optional)
- Container defines the unit of execution for this Revision. -In the context of a Revision, we disallow a number of the fields of -this Container, including: name and lifecycle. -See also the runtime contract for more information about the execution -environment: -https://github.com/knative/serving/blob/master/docs/runtime-contract.md +Status is the current state of the ServerlessService. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
(Appears on: -Revision) +Certificate)
-
RevisionStatus communicates the observed state of the Revision (from the controller).
+CertificateSpec defines the desired state of a Certificate.
-Status
+dnsNames
-knative.dev/pkg/apis/duck/v1.Status
+[]string
|
-
-(Members of DNSNames is a list of DNS names the Certificate could support. +The wildcard format of DNSNames (e.g. *.default.example.com) is supported. |
-serviceName
+secretName
string
|
-(Optional)
- ServiceName holds the name of a core Kubernetes Service resource that -load balances over the pods backing this Revision. +SecretName is the name of the secret resource to store the SSL certificate in. |
+(Appears on: +Certificate) +
++
CertificateStatus defines the observed state of a Certificate.
| Field | +Description | +
|---|---|
-logUrl
+Status
-string
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- LogURL specifies the generated logging url for this particular revision -based on the revision url template specified in the controller’s config. +
+(Members of When Certificate status is ready, it means: +- The target secret exists +- The target secret contains a certificate that has not expired +- The target secret contains a private key valid for the certificate |
-imageDigest
+notAfter
-string
+
+Kubernetes meta/v1.Time
+
|
(Optional)
- ImageDigest holds the resolved digest for the image specified -within .Spec.Container.Image. The digest is resolved during the creation -of Revision. This field holds the digest value regardless of whether -a tag or digest was originally specified in the Container object. It -may be empty if the image comes from a registry listed to skip resolution. +The expiration time of the TLS certificate stored in the secret named +by this resource in spec.secretName. + |
+
+http01Challenges
+
+
+[]HTTP01Challenge
+
+
+ |
+
+ HTTP01Challenges is a list of HTTP01 challenges that need to be fulfilled +in order to get the TLS certificate.. |
(Appears on: -ConfigurationSpec) +CertificateStatus)
-
RevisionTemplateSpec describes the data a revision should have when created from a template. -Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190
+HTTP01Challenge defines the status of a HTTP01 challenge that a certificate needs +to fulfill.
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+URL is the URL that the HTTP01 challenge is expected to serve on. |
|||||||||||||||||
-spec
+serviceName
-
-RevisionSpec
-
+string
|
-(Optional)
- - -
HTTPIngressPath +++(Appears on: +HTTPIngressRuleValue) + ++ HTTPIngressPath associates a path regex with a backend. Incoming URLs matching +the path are forwarded to the backend. + +
Retry policy for HTTP requests. +NOTE: This differs from K8s Ingress which doesn’t allow retry settings. |
(Appears on: -Route, -ServiceSpec) +IngressRule)
-
RouteSpec holds the desired state of the Route (from the client).
+HTTPIngressRuleValue is a list of http selectors pointing to backends.
+In the example: http://
-generation
-
-int64
-
- |
-
-(Optional)
- DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server -This property will be dropped in future Knative releases and should -not be used - use metadata.generation -Tracking issue: https://github.com/knative/serving/issues/643 - |
-
-traffic
+paths
-
-[]TrafficTarget
+
+[]HTTPIngressPath
|
-(Optional)
- Traffic specifies how to distribute traffic over a collection of Knative Serving Revisions and Configurations. +A collection of paths that map requests to backends. +If they are multiple matching paths, the first match takes precendent. |
(Appears on: -Route) +HTTPIngressPath)
-
RouteStatus communicates the observed state of the Route (from the controller).
+HTTPRetry describes the retry policy to use when a HTTP request fails.
-Status
+attempts
-knative.dev/pkg/apis/duck/v1.Status
+int
|
-
-(Members of Number of retries for a given request. |
-RouteStatusFields
+perTryTimeout
-
-RouteStatusFields
+
+Kubernetes meta/v1.Duration
|
-
-(Members of Timeout per retry attempt for a given request. format: 1h/1m/1s/1ms. MUST BE >=1ms. |
(Appears on: -RouteStatus, -ServiceStatus) +IngressBackendSplit)
-
RouteStatusFields holds all of the non-duckv1.Status status fields of a Route. -These are defined outline so that we can also inline them into Service, and more easily -copy them.
+IngressBackend describes all endpoints for a given service and port.
-url
+serviceNamespace
-knative.dev/pkg/apis.URL
+string
|
-(Optional)
- URL holds the url that will distribute traffic over the provided traffic targets. -It generally has the form http[s]://{route-name}.{route-namespace}.{cluster-level-suffix} +Specifies the namespace of the referenced service. +NOTE: This differs from K8s Ingress to allow routing to different namespaces. |
-domain
+serviceName
string
|
-(Optional)
- DeprecatedDomain holds the top-level domain that will distribute traffic over the provided targets. -It generally has the form {route-name}.{route-namespace}.{cluster-level-suffix} +Specifies the name of the referenced service. |
-domainInternal
+servicePort
-string
+k8s.io/apimachinery/pkg/util/intstr.IntOrString
|
-(Optional)
- DeprecatedDomainInternal holds the top-level domain that will distribute traffic over the provided -targets from inside the cluster. It generally has the form -{route-name}.{route-namespace}.svc.{cluster-domain-name} -DEPRECATED: Use Address instead. +Specifies the port of the referenced service. + |
+
+(Appears on: +HTTPIngressPath) +
++
IngressBackendSplit describes all endpoints for a given service and port.
+ +| Field | +Description | +
|---|---|
+IngressBackend
+
+
+IngressBackend
+
+
+ |
+
+
+(Members of Specifies the backend receiving the traffic split. |
-address
+percent
-knative.dev/pkg/apis/duck/v1alpha1.Addressable
+int
|
-(Optional)
- Address holds the information needed for a Route to be the target of an event. +Specifies the split percentage, a number between 0 and 100. If +only one split is specified, we default to 100. +NOTE: This differs from K8s Ingress to allow percentage split. |
-traffic
+appendHeaders
-
-[]TrafficTarget
-
+map[string]string
|
(Optional)
- Traffic holds the configured traffic distribution. -These entries will always contain RevisionName references. -When ConfigurationName appears in the spec, this will hold the -LatestReadyRevisionName that we last observed. +AppendHeaders allow specifying additional HTTP headers to add +before forwarding a request to the destination service. +NOTE: This differs from K8s Ingress which doesn’t allow header appending. |
(Appears on: -ServiceSpec) +IngressSpec)
-
RunLatestType contains the options for always having a route to the latest configuration. See -ServiceSpec for more details.
+IngressRule represents the rules mapping the paths under a specified host to +the related backend services. Incoming requests are first evaluated for a host +match, then routed to the backend associated with the matching IngressRuleValue.
-configuration
+hosts
-
-ConfigurationSpec
+[]string
+
+ |
+
+(Optional)
+ Host is the fully qualified domain name of a network host, as defined
+by RFC 3986. Note the following deviations from the “host” part of the
+URI as defined in the RFC:
+1. IPs are not allowed. Currently a rule value can only apply to the
+IP in the Spec of the parent .
+2. The |
+
+visibility
+
+
+IngressVisibility
|
(Optional)
- The configuration for this service. +Visibility signifies whether this rule should |
+
+http
+
+
+HTTPIngressRuleValue
+
+
+ |
+
+ HTTP represents a rule to apply against incoming requests. If the +rule is satisfied, the request is routed to the specified backend. |
(Appears on: -Service) +Ingress)
-
ServiceSpec represents the configuration for the Service object. Exactly one -of its members (other than Generation) must be specified. Services can either -track the latest ready revision of a configuration or be pinned to a specific -revision.
+IngressSpec describes the Ingress the user wishes to exist.
+In general this follows the same shape as K8s Ingress. +Some notable differences: +- Backends now can have namespace: +- Traffic can be split across multiple backends. +- Timeout & Retry can be configured. +- Headers can be appended.
-runLatest
+tls
-
-RunLatestType
+
+[]IngressTLS
|
(Optional)
- DeprecatedRunLatest defines a simple Service. It will automatically -configure a route that keeps the latest ready revision -from the supplied configuration running. +TLS configuration. Currently Ingress only supports a single TLS +port: 443. If multiple members of this list specify different hosts, they +will be multiplexed on the same port according to the hostname specified +through the SNI TLS extension, if the ingress controller fulfilling the +ingress supports SNI. |
-pinned
+rules
-
-PinnedType
+
+[]IngressRule
|
(Optional)
- DeprecatedPinned is DEPRECATED in favor of ReleaseType +A list of host rules used to configure the Ingress. |
-manual
+visibility
-
-ManualType
+
+IngressVisibility
|
-(Optional)
- DeprecatedManual mode enables users to start managing the underlying Route and Configuration -resources directly. This advanced usage is intended as a path for users to graduate -from the limited capabilities of Service to the full power of Route. +Visibility setting. |
+(Appears on: +Ingress) +
++
IngressStatus describe the current state of the Ingress.
+ +
-release
-
-
-ReleaseType
-
-
- |
-
-(Optional)
- Release enables gradual promotion of new revisions by allowing traffic -to be split between two revisions. This type replaces the deprecated Pinned type. - |
+Field | +Description |
|---|---|---|---|
-ConfigurationSpec
+Status
-
-ConfigurationSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of We are moving to a shape where the Configuration and Route specifications -are inlined into the Service, which gives them compatible shapes. We are -staging this change here as a path to this in v1beta1, which drops the -“mode” based specifications above. Ultimately all non-v1beta1 fields will -be deprecated, and then dropped in v1beta1. |
||
-RouteSpec
+loadBalancer
-
-RouteSpec
+
+LoadBalancerStatus
|
-
-(Members of LoadBalancer contains the current status of the load-balancer.
+This is to be superseded by the combination of |
+||
+publicLoadBalancer
+
+
+LoadBalancerStatus
+
+
+ |
+
+(Optional)
+ PublicLoadBalancer contains the current status of the load-balancer. + |
+||
+privateLoadBalancer
+
+
+LoadBalancerStatus
+
+
+ |
+
+(Optional)
+ PrivateLoadBalancer contains the current status of the load-balancer. |
(Appears on: -Service) +IngressSpec)
-
ServiceStatus represents the Status stanza of the Service resource.
+IngressTLS describes the transport layer security associated with an Ingress.
-Status
+hosts
-knative.dev/pkg/apis/duck/v1.Status
+[]string
|
-
-(Members of Hosts is a list of hosts included in the TLS certificate. The values in +this list must match the name/s used in the tlsSecret. Defaults to the +wildcard host setting for the loadbalancer controller fulfilling this +Ingress, if left unspecified. |
-RouteStatusFields
+secretName
-
-RouteStatusFields
-
+string
|
-
-(Members of SecretName is the name of the secret used to terminate SSL traffic. |
-ConfigurationStatusFields
+secretNamespace
-
-ConfigurationStatusFields
-
+string
|
-
-(Members of SecretNamespace is the namespace of the secret used to terminate SSL traffic. |
-(Appears on: -RouteSpec, -RouteStatusFields) -
--
TrafficTarget holds a single entry of the routing table for a Route.
- -| Field | -Description | -
|---|---|
-name
+serverCertificate
string
|
(Optional)
- Name is optionally used to expose a dedicated hostname for referencing this -target exclusively. It has the form: {name}.${route.status.domain} +ServerCertificate identifies the certificate filename in the secret.
+Defaults to |
-TrafficTarget
+privateKey
-
-TrafficTarget
-
+string
|
-
-(Members of We inherit most of our fields by inlining the v1 type. -Ultimately all non-v1 fields will be deprecated. +(Optional) +PrivateKey identifies the private key filename in the secret.
+Defaults to |
string alias)+(Appears on: +IngressRule, +IngressSpec)
-Resource Types: -+
IngressVisibility describes whether the Ingress should be exposed to +public gateways or not.
+ +-
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
+(Appears on: +LoadBalancerStatus) + ++
LoadBalancerIngressStatus represents the status of a load-balancer ingress point: +traffic intended for the service should be sent to an ingress point.
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Domain is set for load-balancer ingress points that are DNS based +(typically AWS load-balancers) |
||||||||||||||||||||||||||||||||||||||||||
-spec
+domainInternal
-
-ConfigurationSpec
-
+string
|
(Optional)
- - -
|
+
| Field | +Description |
|---|---|
-status
+ingress
-
-ConfigurationStatus
+
+[]LoadBalancerIngressStatus
|
(Optional)
+ Ingress is a list containing ingress points for the load-balancer. +Traffic intended for the service should be sent to these ingress points. |
string alias)+(Appears on: +ServerlessServiceSpec) +
++
ServerlessServiceOperationMode is an enumeration of the modes of operation +for the ServerlessService.
+ +-
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
+(Appears on: +ServerlessService) + ++
ServerlessServiceSpec describes the ServerlessService.
-apiVersion
-string |
+
-
-serving.knative.dev/v1beta1
+ |
+
+objectRef
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ ObjectRef defines the resource that this ServerlessService +is responsible for making “serverless”. + |
+
+ProtocolType
+
+knative.dev/serving/pkg/apis/networking.ProtocolType
+
+ |
+
+ The application-layer protocol. Matches |
+
+numActivators
+
+int32
+
+ |
+
+ NumActivators contains number of Activators that this revision should be +assigned. +O means — assign all. + |
+
+(Appears on: +ServerlessService) +
++
ServerlessServiceStatus describes the current state of the ServerlessService.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of |
+
+serviceName
+
+string
+
+ |
+
+(Optional)
+ ServiceName holds the name of a core K8s Service resource that +load balances over the pods backing this Revision (activator or revision). + |
+
+privateServiceName
+
+string
+
+ |
+
+(Optional)
+ PrivateServiceName holds the name of a core K8s Service resource that +load balances over the user service pods backing this Revision. + |
+
+
+Resource Types: ++
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
+ +| Field | +Description | +||
|---|---|---|---|
+apiVersion
+string |
+
+
+serving.knative.dev/v1
+
+ |
+||
+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)
+ + +
|
+||
+status
+
+
+ConfigurationStatus
+
+
+ |
++(Optional) + | +
+
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
+ +| Field | +Description | +
|---|---|
+apiVersion
+string |
+
+
+serving.knative.dev/v1
|
Route is responsible for configuring ingress over a collection of Revisions.
@@ -2137,7 +2407,7 @@ See also: Service
+
Service acts as a top-level container that manages a Route and Configuration
@@ -2240,7 +2510,7 @@ and Route, reflecting their statuses and conditions as its own.Service
-serving.knative.dev/v1beta1
+serving.knative.dev/v1
-
-Resource Types: - --
PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative -components instantiate autoscalers. This definition is an abstraction that may be backed -by multiple definitions. For more information, see the Knative Pluggability presentation: -https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit
+(Appears on: +Configuration, +Configuration, +ServiceSpec) + ++
ConfigurationSpec holds the desired state of the Configuration (from the client).
-apiVersion
-string |
+
-
-autoscaling.internal.knative.dev/v1alpha1
-
+(Optional)
+Template holds the latest specification for the Revision to be stamped out. |
+(Appears on: +Configuration, +Configuration) +
++
ConfigurationStatus communicates the observed state of the Configuration (from the controller).
+ +
-kind
-string
- |
-PodAutoscaler |
+Field | +Description |
|---|---|---|---|
-metadata
+Status
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of |
||
-spec
+ConfigurationStatusFields
-
-PodAutoscalerSpec
+
+ConfigurationStatusFields
|
-(Optional)
- Spec holds the desired state of the PodAutoscaler (from the client). -- +
+(Members of |
+
+(Appears on: +ConfigurationStatus, +ServiceStatus) +
++
ConfigurationStatusFields holds the fields of Configuration’s status that +are not generally shared. This is defined separately and inlined so that +other types can readily consume these fields via duck typing.
+| Field | +Description | +
|---|---|
-generation
+latestReadyRevisionName
-int64
+string
|
(Optional)
- DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server -This property will be dropped in future Knative releases and should -not be used - use metadata.generation -Tracking issue: https://github.com/knative/serving/issues/643 +LatestReadyRevisionName holds the name of the latest Revision stamped out +from this Configuration that has had its “Ready” condition become “True”. |
-containerConcurrency
+latestCreatedRevisionName
-int64
+string
|
(Optional)
- ContainerConcurrency specifies the maximum allowed
-in-flight (concurrent) requests per container of the Revision.
-Defaults to LatestCreatedRevisionName is the last revision that was created from this +Configuration. It might not be ready yet, for that use LatestReadyRevisionName. |
+(Appears on: +Revision, +Revision, +RevisionSpec, +RevisionTemplateSpec) +
++
RevisionSpec holds the desired state of the Revision (from the client).
+ +
-scaleTargetRef
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- ScaleTargetRef defines the /scale-able resource that this PodAutoscaler -is responsible for quickly right-sizing. - |
+Field | +Description |
|---|---|---|---|
-reachability
+PodSpec
-
-ReachabilityType
+
+Kubernetes core/v1.PodSpec
|
-(Optional)
- Reachable specifies whether or not the
+(Members of |
||
-protocolType
+containerConcurrency
-knative.dev/serving/pkg/apis/networking.ProtocolType
+int64
|
- The application-layer protocol. Matches |
-
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.
status
+timeoutSeconds
-
-PodAutoscalerStatus
-
+int64
Status communicates the observed state of the PodAutoscaler (from the controller).
+TimeoutSeconds holds the max duration the instance is allowed for +responding to a request. If unspecified, a system default will +be provided.
-
Metric represents a resource to configure the metric collector with.
+(Appears on: +Revision, +Revision) + ++
RevisionStatus communicates the observed state of the Revision (from the controller).
-metadata
+Status
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of |
||||||
-spec
+serviceName
-
-MetricSpec
-
+string
|
(Optional)
- Spec holds the desired state of the Metric (from the client). -- -
LogURL specifies the generated logging url for this particular revision +based on the revision url template specified in the controller’s config. |
||||||
-status
+imageDigest
-
-MetricStatus
-
+string
|
(Optional)
- Status communicates the observed state of the Metric (from the controller). +ImageDigest holds the resolved digest for the image specified +within .Spec.Container.Image. The digest is resolved during the creation +of Revision. This field holds the digest value regardless of whether +a tag or digest was originally specified in the Container object. It +may be empty if the image comes from a registry listed to skip resolution. |
(Appears on: -Metric) +ConfigurationSpec)
-
MetricSpec contains all values a metric collector needs to operate.
+RevisionTemplateSpec describes the data a revision should have when created from a template. +Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190
-stableWindow
+metadata
-time.Duration
+
+Kubernetes meta/v1.ObjectMeta
+
|
- StableWindow is the aggregation window for metrics in a stable state. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-panicWindow
+spec
-time.Duration
+
+RevisionSpec
+
|
- PanicWindow is the aggregation window for metrics where quick reactions are needed. +(Optional) ++ +
|
(Appears on: -Metric) +Route, +Route, +ServiceSpec)
-
MetricStatus reflects the status of metric collection for this specific entity.
+RouteSpec holds the desired state of the Route (from the client).
-Status
+traffic
-knative.dev/pkg/apis/duck/v1.Status
+
+[]TrafficTarget
+
|
-
-(Members of Traffic specifies how to distribute traffic over a collection of +revisions and configurations. |
(Appears on: -PodAutoscaler) +Route, +Route)
-
PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).
+RouteStatus communicates the observed state of the Route (from the controller).
-generation
+Status
-int64
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server -This property will be dropped in future Knative releases and should -not be used - use metadata.generation -Tracking issue: https://github.com/knative/serving/issues/643 +
+(Members of |
-containerConcurrency
+RouteStatusFields
-int64
+
+RouteStatusFields
+
|
-(Optional)
- ContainerConcurrency specifies the maximum allowed
-in-flight (concurrent) requests per container of the Revision.
-Defaults to
+(Members of |
+(Appears on: +RouteStatus, +ServiceStatus) +
++
RouteStatusFields holds the fields of Route’s status that +are not generally shared. This is defined separately and inlined so that +other types can readily consume these fields via duck typing.
+ +| Field | +Description | +
|---|---|
-scaleTargetRef
+url
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis.URL
|
- ScaleTargetRef defines the /scale-able resource that this PodAutoscaler -is responsible for quickly right-sizing. +(Optional) +URL holds the url that will distribute traffic over the provided traffic targets. +It generally has the form http[s]://{route-name}.{route-namespace}.{cluster-level-suffix} |
-reachability
+address
-
-ReachabilityType
-
+knative.dev/pkg/apis/duck/v1.Addressable
|
(Optional)
- Reachable specifies whether or not the Address holds the information needed for a Route to be the target of an event. |
-protocolType
+traffic
-knative.dev/serving/pkg/apis/networking.ProtocolType
+
+[]TrafficTarget
+
|
- The application-layer protocol. Matches Traffic holds the configured traffic distribution. +These entries will always contain RevisionName references. +When ConfigurationName appears in the spec, this will hold the +LatestReadyRevisionName that we last observed. |
(Appears on: -PodAutoscaler) +Service, +Service)
-
PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).
+ServiceSpec represents the configuration for the Service object. +A Service’s specification is the union of the specifications for a Route +and Configuration. The Service restricts what can be expressed in these +fields, e.g. the Route must reference the provided Configuration; +however, these limitations also enable friendlier defaulting, +e.g. Route never needs a Configuration name, and may be defaulted to +the appropriate “run latest” spec.
-Status
+ConfigurationSpec
-knative.dev/pkg/apis/duck/v1.Status
+
+ConfigurationSpec
+
|
-(Members of ServiceSpec inlines an unrestricted ConfigurationSpec. |
-serviceName
+RouteSpec
-string
+
+RouteSpec
+
|
- ServiceName is the K8s Service name that serves the revision, scaled by this PA. -The service is created and owned by the ServerlessService object owned by this PA. +
+(Members of 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). |
+(Appears on: +Service, +Service) +
++
ServiceStatus represents the Status stanza of the Service resource.
+ +| Field | +Description | +
|---|---|
-metricsServiceName
+Status
-string
+knative.dev/pkg/apis/duck/v1.Status
|
- MetricsServiceName is the K8s Service name that provides revision metrics. -The service is managed by the PA object. +
+(Members of |
-desiredScale
+ConfigurationStatusFields
-int32
+
+ConfigurationStatusFields
+
|
- DesiredScale shows the current desired number of replicas for the revision. +
+(Members of In addition to inlining ConfigurationSpec, we also inline the fields +specific to ConfigurationStatus. |
-actualScale
+RouteStatusFields
-int32
+
+RouteStatusFields
+
|
- ActualScale shows the actual number of replicas for the revision. +
+(Members of In addition to inlining RouteSpec, we also inline the fields +specific to RouteStatus. |
-
PodScalable is a duck type that the resources referenced by the
-PodAutoscaler’s ScaleTargetRef must implement. They must also
-implement the /scale sub-resource for use with /scale based
-implementations (e.g. HPA), but this further constrains the shape
-the referenced resources may take.
+
TrafficTarget holds a single entry of the routing table for a Route.
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec
-
-
-PodScalableSpec
-
-
- |
-
- - -
Tag is optionally used to expose a dedicated url for referencing +this target exclusively. |
||||||
-status
+revisionName
-
-PodScalableStatus
-
+string
|
+(Optional)
+ RevisionName of a specific revision to which to send this portion of +traffic. This is mutually exclusive with ConfigurationName. |
-(Appears on: -PodScalable) -
--
PodScalableSpec is the specification for the desired state of a -PodScalable (or at least our shared portion).
- -| Field | -Description | -
|---|---|
-replicas
+configurationName
-int32
+string
|
+(Optional)
+ ConfigurationName of a configuration to whose latest revision we will send +this portion of traffic. When the “status.latestReadyRevisionName” of the +referenced configuration changes, we will automatically migrate traffic +from the prior “latest ready” revision to the new one. This field is never +set in Route’s status, only its spec. This is mutually exclusive with +RevisionName. |
-selector
+latestRevision
-
-Kubernetes meta/v1.LabelSelector
-
+bool
|
+(Optional)
+ LatestRevision may be optionally provided to indicate that the latest +ready Revision of the Configuration should be used for this traffic +target. When provided LatestRevision must be true if RevisionName is +empty; it must be false when RevisionName is non-empty. |
-template
+percent
-
-Kubernetes core/v1.PodTemplateSpec
-
+int64
|
+(Optional)
+ Percent indicates that percentage based routing should be used and
+the value indicates the percent of traffic that is be routed to this
+Revision or Configuration. |
-(Appears on: -PodScalable) -
--
PodScalableStatus is the observed state of a PodScalable (or at -least our shared portion).
- -| Field | -Description | -
|---|---|
-replicas
+url
-int32
+knative.dev/pkg/apis.URL
|
+(Optional)
+ URL displays the URL for accessing named traffic targets. URL is displayed in +status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and +a hostname, but may not contain anything else (e.g. basic auth, url path, etc.) |
string alias)-(Appears on: -PodAutoscalerSpec) -
--
ReachabilityType is the enumeration type for the different states of reachability
-to the ScaleTarget of a PodAutoscaler
Resource Types: -
-
Certificate is responsible for provisioning a SSL certificate for the -given hosts. It is a Knative abstraction for various SSL certificate -provisioning solutions (such as cert-manager or self-signed SSL certificate).
+Configuration represents the “floating HEAD” of a linear history of Revisions, +and optionally how the containers those revisions reference are built. +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
-networking.internal.knative.dev/v1alpha1
+serving.knative.dev/v1alpha1
|
@@ -3070,7 +3406,7 @@ networking.internal.knative.dev/v1alpha1
Certificate |
+Configuration |
|||||
| @@ -3083,8 +3419,6 @@ Kubernetes meta/v1.ObjectMeta |
(Optional)
- Standard object’s metadata. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of themetadata field.
|
@@ -3093,69 +3427,106 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-CertificateSpec
+
+ConfigurationSpec
|
(Optional)
- Spec is the desired state of the Certificate. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +Spec holds the desired state of the Configuration (from the client).
Build optionally holds the specification for the build to +perform to produce the Revision’s container image. |
||||
-status
+revisionTemplate
-
-CertificateStatus
+
+RevisionTemplateSpec
|
(Optional)
- Status is the current state of the Certificate. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +DeprecatedRevisionTemplate holds the latest specification for the Revision to +be stamped out. If a Build specification is provided, then the +DeprecatedRevisionTemplate’s BuildName field will be populated with the name of +the Build object created to produce the container for the Revision. +DEPRECATED Use Template instead. |
-
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined -by a backend. An Ingress can be configured to give services externally-reachable URLs, load -balance traffic, offer name based virtual hosting, etc.
-This is heavily based on K8s Ingress https://godoc.org/k8s.io/api/networking/v1beta1#Ingress -which some highlighted modifications.
+template
+
+
+RevisionTemplateSpec
+
+
+Template holds the latest specification for the Revision to +be stamped out.
+status
+
+
+ConfigurationStatus
+
+
+Status communicates the observed state of the Configuration (from the controller).
++
Revision is an immutable snapshot of code and configuration. A revision +references a container image, and optionally a build that is responsible for +materializing that container image from source. Revisions are created by +updates to a Configuration.
+See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision
-networking.internal.knative.dev/v1alpha1
+serving.knative.dev/v1alpha1
|
@@ -3180,7 +3551,7 @@ networking.internal.knative.dev/v1alpha1
Ingress |
+Revision |
||||||||||||||||
| @@ -3193,8 +3564,6 @@ Kubernetes meta/v1.ObjectMeta |
(Optional)
- Standard object’s metadata. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of themetadata field.
|
@@ -3203,20 +3572,34 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-IngressSpec
+
+RevisionSpec
|
(Optional)
- Spec is the desired state of the Ingress. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +Spec holds the desired state of the Revision (from the client).
|
status
-
-IngressStatus
+
+RevisionStatus
|
(Optional)
- Status is the current state of the Ingress. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +Status communicates the observed state of the Revision (from the controller). |
-
ServerlessService is a proxy for the K8s service objects containing the -endpoints for the revision, whether those are endpoints of the activator or -revision pods. -See: https://knative.page.link/naxz for details.
+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
-networking.internal.knative.dev/v1alpha1
+serving.knative.dev/v1alpha1
|
@@ -3327,7 +3748,7 @@ networking.internal.knative.dev/v1alpha1
ServerlessService |
+Route |
|||||||||
| @@ -3340,8 +3761,6 @@ Kubernetes meta/v1.ObjectMeta |
(Optional)
- Standard object’s metadata. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of themetadata field.
|
@@ -3350,55 +3769,45 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ServerlessServiceSpec
+
+RouteSpec
|
(Optional)
- Spec is the desired state of the ServerlessService. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +Spec holds the desired state of the Route (from the client).
|
status
-
-ServerlessServiceStatus
+
+RouteStatus
|
(Optional)
- Status is the current state of the ServerlessService. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +Status communicates the observed state of the Route (from the controller). |
-(Appears on: -Certificate) -
--
CertificateSpec defines the desired state of a Certificate.
Service acts as a top-level container that manages a set of Routes and +Configurations 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
|
- SecretName is the name of the secret resource to store the SSL certificate in. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-
-
-(Appears on: -Certificate) -
--
CertificateStatus defines the observed state of a Certificate.
| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-(Members of When Certificate status is ready, it means: -- The target secret exists -- The target secret contains a certificate that has not expired -- The target secret contains a private key valid for the certificate - |
-
-notAfter
+spec
-
-Kubernetes meta/v1.Time
+
+ServiceSpec
|
(Optional)
- The expiration time of the TLS certificate stored in the secret named -by this resource in spec.secretName. - |
-
-http01Challenges
-
-
-[]HTTP01Challenge
-
-
- |
-
- HTTP01Challenges is a list of HTTP01 challenges that need to be fulfilled -in order to get the TLS certificate.. - |
-
-(Appears on: -CertificateStatus) -
--
HTTP01Challenge defines the status of a HTTP01 challenge that a certificate needs -to fulfill.
- -| Field | -Description | -
|---|---|
-url
-
-knative.dev/pkg/apis.URL
-
- |
-
- URL is the URL that the HTTP01 challenge is expected to serve on. - |
-
-serviceName
-
-string
-
- |
-
- ServiceName is the name of the service to serve HTTP01 challenge requests. - |
-
-serviceNamespace
-
-string
-
- |
-
- ServiceNamespace is the namespace of the service to serve HTTP01 challenge requests. - |
-
-servicePort
-
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
-
- |
-
- ServicePort is the port of the service to serve HTTP01 challenge requests. - |
-
-(Appears on: -HTTPIngressRuleValue) -
--
HTTPIngressPath associates a path regex with a backend. Incoming URLs matching -the path are forwarded to the backend.
- +| Field | -Description | -
|---|---|
-path
+generation
-string
+int64
|
(Optional)
- Path is an extended POSIX regex as defined by IEEE Std 1003.1, -(i.e this follows the egrep/unix syntax, not the perl syntax) -matched against the path of an incoming request. Currently it can -contain characters disallowed from the conventional “path” -part of a URL as defined by RFC 3986. Paths must begin with -a ‘/’. If unspecified, the path defaults to a catch all sending -traffic to the backend. +DeprecatedGeneration was used prior in Kubernetes versions <1.11 +when metadata.generation was not being incremented by the api server +This property will be dropped in future Knative releases and should +not be used - use metadata.generation +Tracking issue: https://github.com/knative/serving/issues/643 |
-splits
+runLatest
-
-[]IngressBackendSplit
+
+RunLatestType
|
- Splits defines the referenced service endpoints to which the traffic -will be forwarded to. - |
-
-appendHeaders
-
-map[string]string
-
- |
-
(Optional)
- AppendHeaders allow specifying additional HTTP headers to add -before forwarding a request to the destination service. -NOTE: This differs from K8s Ingress which doesn’t allow header appending. +DeprecatedRunLatest defines a simple Service. It will automatically +configure a route that keeps the latest ready revision +from the supplied configuration running. |
-timeout
+pinned
-
-Kubernetes meta/v1.Duration
+
+PinnedType
|
(Optional)
- Timeout for HTTP requests. -NOTE: This differs from K8s Ingress which doesn’t allow setting timeouts. +DeprecatedPinned is DEPRECATED in favor of ReleaseType |
-retries
+manual
-
-HTTPRetry
+
+ManualType
|
(Optional)
- Retry policy for HTTP requests. -NOTE: This differs from K8s Ingress which doesn’t allow retry settings. +DeprecatedManual mode enables users to start managing the underlying Route and Configuration +resources directly. This advanced usage is intended as a path for users to graduate +from the limited capabilities of Service to the full power of Route. |
-(Appears on: -IngressRule) -
--
HTTPIngressRuleValue is a list of http selectors pointing to backends.
-In the example: http://
| Field | -Description | -
|---|---|
-paths
+release
-
-[]HTTPIngressPath
+
+ReleaseType
|
- A collection of paths that map requests to backends. -If they are multiple matching paths, the first match takes precendent. - |
-
-(Appears on: -HTTPIngressPath) -
--
HTTPRetry describes the retry policy to use when a HTTP request fails.
- -| Field | -Description | -
|---|---|
-attempts
-
-int
-
- |
-
- Number of retries for a given request. +(Optional) +Release enables gradual promotion of new revisions by allowing traffic +to be split between two revisions. This type replaces the deprecated Pinned type. |
-perTryTimeout
+ConfigurationSpec
-
-Kubernetes meta/v1.Duration
+
+ConfigurationSpec
|
- Timeout per retry attempt for a given request. format: 1h/1m/1s/1ms. MUST BE >=1ms. - |
-
-(Appears on: -IngressBackendSplit) -
--
IngressBackend describes all endpoints for a given service and port.
+(Members ofConfigurationSpec are embedded into this type.)
-| Field | -Description | -
|---|---|
-serviceNamespace
-
-string
-
- |
-
- Specifies the namespace of the referenced service. -NOTE: This differs from K8s Ingress to allow routing to different namespaces. - |
-
-serviceName
-
-string
-
- |
-
- Specifies the name of the referenced service. - |
-
-servicePort
-
-k8s.io/apimachinery/pkg/util/intstr.IntOrString
-
- |
-
- Specifies the port of the referenced service. +We are moving to a shape where the Configuration and Route specifications +are inlined into the Service, which gives them compatible shapes. We are +staging this change here as a path to this in v1beta1, which drops the +“mode” based specifications above. Ultimately all non-v1beta1 fields will +be deprecated, and then dropped in v1beta1. |
-(Appears on: -HTTPIngressPath) -
--
IngressBackendSplit describes all endpoints for a given service and port.
- -| Field | -Description | -
|---|---|
-IngressBackend
+RouteSpec
-
-IngressBackend
+
+RouteSpec
|
-(Members of Specifies the backend receiving the traffic split. |
-percent
-
-int
-
- |
-
- Specifies the split percentage, a number between 0 and 100. If -only one split is specified, we default to 100. -NOTE: This differs from K8s Ingress to allow percentage split. + |
appendHeaders
+status
-map[string]string
+
+ServiceStatus
+
AppendHeaders allow specifying additional HTTP headers to add -before forwarding a request to the destination service.
-NOTE: This differs from K8s Ingress which doesn’t allow header appending.
-(Appears on: -IngressSpec) -
--
IngressRule represents the rules mapping the paths under a specified host to -the related backend services. Incoming requests are first evaluated for a host -match, then routed to the backend associated with the matching IngressRuleValue.
+CannotConvertError is returned when a field cannot be converted.
-hosts
-
-[]string
-
- |
-
-(Optional)
- Host is the fully qualified domain name of a network host, as defined
-by RFC 3986. Note the following deviations from the “host” part of the
-URI as defined in the RFC:
-1. IPs are not allowed. Currently a rule value can only apply to the
-IP in the Spec of the parent .
-2. The |
-
-visibility
+Message
-
-IngressVisibility
-
+string
|
-(Optional)
- Visibility signifies whether this rule should |
-http
+Field
-
-HTTPIngressRuleValue
-
+string
|
- HTTP represents a rule to apply against incoming requests. If the -rule is satisfied, the request is routed to the specified backend. |
(Appears on: -Ingress) +Configuration, +PinnedType, +ReleaseType, +RunLatestType, +ServiceSpec)
-
IngressSpec describes the Ingress the user wishes to exist.
-In general this follows the same shape as K8s Ingress. -Some notable differences: -- Backends now can have namespace: -- Traffic can be split across multiple backends. -- Timeout & Retry can be configured. -- Headers can be appended.
+ConfigurationSpec holds the desired state of the Configuration (from the client).
-tls
+build
-
-[]IngressTLS
-
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
(Optional)
- TLS configuration. Currently Ingress only supports a single TLS -port: 443. If multiple members of this list specify different hosts, they -will be multiplexed on the same port according to the hostname specified -through the SNI TLS extension, if the ingress controller fulfilling the -ingress supports SNI. +Build optionally holds the specification for the build to +perform to produce the Revision’s container image. |
-rules
+revisionTemplate
-
-[]IngressRule
+
+RevisionTemplateSpec
|
(Optional)
- A list of host rules used to configure the Ingress. +DeprecatedRevisionTemplate holds the latest specification for the Revision to +be stamped out. If a Build specification is provided, then the +DeprecatedRevisionTemplate’s BuildName field will be populated with the name of +the Build object created to produce the container for the Revision. +DEPRECATED Use Template instead. |
-visibility
+template
-
-IngressVisibility
+
+RevisionTemplateSpec
|
- Visibility setting. +(Optional) +Template holds the latest specification for the Revision to +be stamped out. |
(Appears on: -Ingress) +Configuration)
-
IngressStatus describe the current state of the Ingress.
+ConfigurationStatus communicates the observed state of the Configuration (from the controller).
-loadBalancer
-
-
-LoadBalancerStatus
-
-
- |
-
-(Optional)
- LoadBalancer contains the current status of the load-balancer.
-This is to be superseded by the combination of |
-
-publicLoadBalancer
-
-
-LoadBalancerStatus
-
-
- |
-
-(Optional)
- PublicLoadBalancer contains the current status of the load-balancer. - |
-
-privateLoadBalancer
+ConfigurationStatusFields
-
-LoadBalancerStatus
+
+ConfigurationStatusFields
|
-(Optional)
- PrivateLoadBalancer contains the current status of the load-balancer. +
+(Members of |
(Appears on: -IngressSpec) +ConfigurationStatus, +ServiceStatus)
-
IngressTLS describes the transport layer security associated with an Ingress.
+ConfigurationStatusFields holds all of the non-duckv1.Status status fields of a Route. +These are defined outline so that we can also inline them into Service, and more easily +copy them.
-hosts
-
-[]string
-
- |
-
-(Optional)
- Hosts is a list of hosts included in the TLS certificate. The values in -this list must match the name/s used in the tlsSecret. Defaults to the -wildcard host setting for the loadbalancer controller fulfilling this -Ingress, if left unspecified. - |
-
-secretName
-
-string
-
- |
-
- SecretName is the name of the secret used to terminate SSL traffic. - |
-
-secretNamespace
-
-string
-
- |
-
- SecretNamespace is the namespace of the secret used to terminate SSL traffic. - |
-
-serverCertificate
+latestReadyRevisionName
string
|
(Optional)
- ServerCertificate identifies the certificate filename in the secret.
-Defaults to LatestReadyRevisionName holds the name of the latest Revision stamped out +from this Configuration that has had its “Ready” condition become “True”. |
-privateKey
+latestCreatedRevisionName
string
|
(Optional)
- PrivateKey identifies the private key filename in the secret.
-Defaults to LatestCreatedRevisionName is the last revision that was created from this +Configuration. It might not be ready yet, for that use LatestReadyRevisionName. |
string alias)(Appears on: -IngressRule, -IngressSpec) +RevisionSpec)
-
IngressVisibility describes whether the Ingress should be exposed to -public gateways or not.
+DeprecatedRevisionRequestConcurrencyModelType is an enumeration of the +concurrency models supported by a Revision. +DEPRECATED in favor of an integer based ContainerConcurrency setting. +TODO(vagababov): retire completely in 0.9.
-string alias)+(Appears on: +RevisionSpec) +
++
DeprecatedRevisionServingStateType is an enumeration of the levels of serving readiness of the Revision. +See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting
+ +(Appears on: -LoadBalancerStatus) +ServiceSpec)
-
LoadBalancerIngressStatus represents the status of a load-balancer ingress point: -traffic intended for the service should be sent to an ingress point.
+ManualType contains the options for configuring a manual service. See ServiceSpec for +more details.
-| Field | -Description | -
|---|---|
-ip
-
-string
-
- |
-
-(Optional)
- IP is set for load-balancer ingress points that are IP based -(typically GCE or OpenStack load-balancers) - |
-
-domain
-
-string
-
- |
-
-(Optional)
- Domain is set for load-balancer ingress points that are DNS based -(typically AWS load-balancers) - |
-
-domainInternal
-
-string
-
- |
-
-(Optional)
- DomainInternal is set if there is a cluster-local DNS name to access the Ingress. -NOTE: This differs from K8s Ingress, since we also desire to have a cluster-local -DNS name to allow routing in case of not having a mesh. - |
-
-meshOnly
-
-bool
-
- |
-
-(Optional)
- MeshOnly is set if the Ingress is only load-balanced through a Service mesh. - |
-
(Appears on: -IngressStatus) +ServiceSpec)
-
LoadBalancerStatus represents the status of a load-balancer.
+PinnedType is DEPRECATED. ReleaseType should be used instead. To get the behavior of PinnedType set +ReleaseType.Revisions to []string{PinnedType.RevisionName} and ReleaseType.RolloutPercent to 0.
-ingress
+revisionName
-
-[]LoadBalancerIngressStatus
+string
+
+ |
+
+(Optional)
+ The revision name to pin this service to until changed +to a different service type. + |
+
+configuration
+
+
+ConfigurationSpec
|
(Optional)
- Ingress is a list containing ingress points for the load-balancer. -Traffic intended for the service should be sent to these ingress points. +The configuration for this service. |
string alias)-(Appears on: -ServerlessServiceSpec) -
--
ServerlessServiceOperationMode is an enumeration of the modes of operation -for the ServerlessService.
- -(Appears on: -ServerlessService) +ServiceSpec)
-
ServerlessServiceSpec describes the ServerlessService.
+ReleaseType contains the options for slowly releasing revisions. See ServiceSpec for +more details.
-mode
+revisions
-
-ServerlessServiceOperationMode
-
+[]string
|
- Mode describes the mode of operation of the ServerlessService. +(Optional) +Revisions is an ordered list of 1 or 2 revisions. The first will +have a TrafficTarget with a name of “current” and the second will have +a name of “candidate”. |
-objectRef
+rolloutPercent
-
-Kubernetes core/v1.ObjectReference
-
+int
|
- ObjectRef defines the resource that this ServerlessService -is responsible for making “serverless”. +(Optional) +RolloutPercent is the percent of traffic that should be sent to the “candidate” +revision. Valid values are between 0 and 99 inclusive. |
-ProtocolType
+configuration
-knative.dev/serving/pkg/apis/networking.ProtocolType
+
+ConfigurationSpec
+
|
- The application-layer protocol. Matches The configuration for this service. All revisions from this service must +come from a single configuration. |
(Appears on: -ServerlessService) +Revision, +RevisionTemplateSpec)
-
ServerlessServiceStatus describes the current state of the ServerlessService.
+RevisionSpec holds the desired state of the Revision (from the client).
-Status
+RevisionSpec
-knative.dev/pkg/apis/duck/v1.Status
+
+RevisionSpec
+
|
-(Members of |
-serviceName
+generation
-string
+int64
|
(Optional)
- ServiceName holds the name of a core K8s Service resource that -load balances over the pods backing this Revision (activator or revision). +DeprecatedGeneration was used prior in Kubernetes versions <1.11 +when metadata.generation was not being incremented by the api server +This property will be dropped in future Knative releases and should +not be used - use metadata.generation +Tracking issue: https://github.com/knative/serving/issues/643 |
-privateServiceName
+servingState
-string
+
+DeprecatedRevisionServingStateType
+
|
(Optional)
- PrivateServiceName holds the name of a core K8s Service resource that -load balances over the user service pods backing this Revision. +DeprecatedServingState holds a value describing the desired state the Kubernetes +resources should be in for this Revision. +Users must not specify this when creating a revision. These values are no longer +updated by the system. |
-
-Resource Types: --
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
- -| Field | -Description | -|
|---|---|---|
-apiVersion
-string |
+
-
-serving.knative.dev/v1
-
+(Optional)
+DeprecatedConcurrencyModel specifies the desired concurrency model +(Single or Multi) for the +Revision. Defaults to Multi. +Deprecated in favor of ContainerConcurrency. |
|
-kind
+buildName
+
string
+
+ |
+
+(Optional)
+ DeprecatedBuildName optionally holds the name of the Build responsible for +producing the container image for its Revision. +DEPRECATED: Use DeprecatedBuildRef instead. |
-Configuration |
-metadata
+buildRef
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.ObjectReference
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+DeprecatedBuildRef holds the reference to the build (if there is one) responsible +for producing the container image for this Revision. Otherwise, nil |
|
-spec
+container
-
-ConfigurationSpec
+
+Kubernetes core/v1.Container
|
(Optional)
- - + Container defines the unit of execution for this Revision. +In the context of a Revision, we disallow a number of the fields of +this Container, including: name and lifecycle. +See also the runtime contract for more information about the execution +environment: +https://github.com/knative/serving/blob/master/docs/runtime-contract.md + |
+
+(Appears on: +Revision) +
++
RevisionStatus communicates the observed state of the Revision (from the controller).
+| Field | +Description | +
|---|---|
-template
+Status
-
-RevisionTemplateSpec
-
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of |
+
+serviceName
+
+string
|
(Optional)
- Template holds the latest specification for the Revision to be stamped out. +ServiceName holds the name of a core Kubernetes Service resource that +load balances over the pods backing this Revision. |
logUrl
+
+string
+
+LogURL specifies the generated logging url for this particular revision +based on the revision url template specified in the controller’s config.
status
+imageDigest
-
-ConfigurationStatus
-
+string
ImageDigest holds the resolved digest for the image specified +within .Spec.Container.Image. The digest is resolved during the creation +of Revision. This field holds the digest value regardless of whether +a tag or digest was originally specified in the Container object. It +may be empty if the image comes from a registry listed to skip resolution.
-
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
+(Appears on: +ConfigurationSpec) + ++
RevisionTemplateSpec describes the data a revision should have when created from a template. +Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190
-apiVersion
-string |
-
-
-serving.knative.dev/v1
-
- |
-||||||
-kind
-string
- |
-Revision |
-||||||
metadata
@@ -4603,7 +4627,7 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
+
RevisionSpec
@@ -4615,178 +4639,180 @@ RevisionSpec
DeprecatedServingState holds a value describing the desired state the Kubernetes +resources should be in for this Revision. +Users must not specify this when creating a revision. These values are no longer +updated by the system. | ||||||
-status
+concurrencyModel
-
-RevisionStatus
+
+DeprecatedRevisionRequestConcurrencyModelType
|
(Optional)
+ DeprecatedConcurrencyModel specifies the desired concurrency model +(Single or Multi) for the +Revision. Defaults to Multi. +Deprecated in favor of ContainerConcurrency. |
-
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
- -| Field | -Description | -
|---|---|
-apiVersion
-string |
-
-
-serving.knative.dev/v1
-
+buildName
+
+string
+
|
-
-kind
-string
+(Optional)
+DeprecatedBuildName optionally holds the name of the Build responsible for +producing the container image for its Revision. +DEPRECATED: Use DeprecatedBuildRef instead. |
-Route |
-metadata
+buildRef
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.ObjectReference
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+DeprecatedBuildRef holds the reference to the build (if there is one) responsible +for producing the container image for this Revision. Otherwise, nil |
-spec
+container
-
-RouteSpec
+
+Kubernetes core/v1.Container
|
(Optional)
- Spec holds the desired state of the Route (from the client). -- + Container defines the unit of execution for this Revision. +In the context of a Revision, we disallow a number of the fields of +this Container, including: name and lifecycle. +See also the runtime contract for more information about the execution +environment: +https://github.com/knative/serving/blob/master/docs/runtime-contract.md + |
+
+(Appears on: +Route, +ServiceSpec) +
++
RouteSpec holds the desired state of the Route (from the client).
+| Field | +Description | +
|---|---|
-traffic
+generation
-
-[]TrafficTarget
-
+int64
|
(Optional)
- Traffic specifies how to distribute traffic over a collection of -revisions and configurations. - |
-
DeprecatedGeneration was used prior in Kubernetes versions <1.11 +when metadata.generation was not being incremented by the api server
+This property will be dropped in future Knative releases and should +not be used - use metadata.generation
+Tracking issue: https://github.com/knative/serving/issues/643
status
+traffic
-
-RouteStatus
+
+[]TrafficTarget
Status communicates the observed state of the Route (from the controller).
+Traffic specifies how to distribute traffic over a collection of Knative Serving Revisions and Configurations.
-
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
+(Appears on: +Route) + ++
RouteStatus communicates the observed state of the Route (from the controller).
-apiVersion
-string |
+
-
-serving.knative.dev/v1
-
+
+(Members of |
|
-kind
-string
+RouteStatusFields
+
+
+RouteStatusFields
+
+
|
-Service |
+
+
+(Members of |
+
+(Appears on: +RouteStatus, +ServiceStatus) +
++
RouteStatusFields holds all of the non-duckv1.Status status fields of a Route. +These are defined outline so that we can also inline them into Service, and more easily +copy them.
+ +| Field | +Description | ||||
|---|---|---|---|---|---|
-metadata
+url
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis.URL
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+URL holds the url that will distribute traffic over the provided traffic targets. +It generally has the form http[s]://{route-name}.{route-namespace}.{cluster-level-suffix} |
||||
-spec
+domain
-
-ServiceSpec
-
+string
|
(Optional)
- - -
Address holds the information needed for a Route to be the target of an event. |
||||
-status
+traffic
-
-ServiceStatus
+
+[]TrafficTarget
|
(Optional)
+ Traffic holds the configured traffic distribution. +These entries will always contain RevisionName references. +When ConfigurationName appears in the spec, this will hold the +LatestReadyRevisionName that we last observed. |
(Appears on: -Configuration, -Configuration, -ServiceSpec) +ServiceSpec)
-
ConfigurationSpec holds the desired state of the Configuration (from the client).
+RunLatestType contains the options for always having a route to the latest configuration. See +ServiceSpec for more details.
-template
+configuration
-
-RevisionTemplateSpec
+
+ConfigurationSpec
|
(Optional)
- Template holds the latest specification for the Revision to be stamped out. +The configuration for this service. |
(Appears on: -Configuration, -Configuration) +Service)
-
ConfigurationStatus communicates the observed state of the Configuration (from the controller).
+ServiceSpec represents the configuration for the Service object. Exactly one +of its members (other than Generation) must be specified. Services can either +track the latest ready revision of a configuration or be pinned to a specific +revision.
-Status
+generation
-knative.dev/pkg/apis/duck/v1.Status
+int64
|
-
-(Members of DeprecatedGeneration was used prior in Kubernetes versions <1.11 +when metadata.generation was not being incremented by the api server +This property will be dropped in future Knative releases and should +not be used - use metadata.generation +Tracking issue: https://github.com/knative/serving/issues/643 |
-ConfigurationStatusFields
+runLatest
-
-ConfigurationStatusFields
+
+RunLatestType
|
-
-(Members of DeprecatedRunLatest defines a simple Service. It will automatically +configure a route that keeps the latest ready revision +from the supplied configuration running. |
-(Appears on: -ConfigurationStatus, -ServiceStatus) -
--
ConfigurationStatusFields holds the fields of Configuration’s status that -are not generally shared. This is defined separately and inlined so that -other types can readily consume these fields via duck typing.
- -| Field | -Description | +
+pinned
+
+
+PinnedType
+
+
+ |
+
+(Optional)
+ DeprecatedPinned is DEPRECATED in favor of ReleaseType + |
|---|---|---|---|
-latestReadyRevisionName
+manual
-string
+
+ManualType
+
|
(Optional)
- LatestReadyRevisionName holds the name of the latest Revision stamped out -from this Configuration that has had its “Ready” condition become “True”. +DeprecatedManual mode enables users to start managing the underlying Route and Configuration +resources directly. This advanced usage is intended as a path for users to graduate +from the limited capabilities of Service to the full power of Route. |
||
-latestCreatedRevisionName
+release
-string
+
+ReleaseType
+
|
(Optional)
- LatestCreatedRevisionName is the last revision that was created from this -Configuration. It might not be ready yet, for that use LatestReadyRevisionName. +Release enables gradual promotion of new revisions by allowing traffic +to be split between two revisions. This type replaces the deprecated Pinned type. + |
+||
+ConfigurationSpec
+
+
+ConfigurationSpec
+
+
+ |
+
+
+(Members of We are moving to a shape where the Configuration and Route specifications +are inlined into the Service, which gives them compatible shapes. We are +staging this change here as a path to this in v1beta1, which drops the +“mode” based specifications above. Ultimately all non-v1beta1 fields will +be deprecated, and then dropped in v1beta1. + |
+||
+RouteSpec
+
+
+RouteSpec
+
+
+ |
+
+
+(Members of |
(Appears on: -Revision, -Revision, -RevisionSpec, -RevisionTemplateSpec) +Service)
-
RevisionSpec holds the desired state of the Revision (from the client).
+ServiceStatus represents the Status stanza of the Service resource.
-PodSpec
+Status
-
-Kubernetes core/v1.PodSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of |
|
-containerConcurrency
+RouteStatusFields
-int64
+
+RouteStatusFields
+
|
-(Optional)
- ContainerConcurrency specifies the maximum allowed in-flight (concurrent)
-requests per container of the Revision. Defaults to
+(Members of |
|
-timeoutSeconds
+ConfigurationStatusFields
-int64
+
+ConfigurationStatusFields
+
|
-
-(Optional)
- TimeoutSeconds holds the max duration the instance is allowed for -responding to a request. If unspecified, a system default will -be provided. + |
+
+(Members of |
(Appears on: -Revision, -Revision) +RouteSpec, +RouteStatusFields)
-
RevisionStatus communicates the observed state of the Revision (from the controller).
+TrafficTarget holds a single entry of the routing table for a Route.
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of |
-
-serviceName
-
-string
-
- |
-
-(Optional)
- ServiceName holds the name of a core Kubernetes Service resource that -load balances over the pods backing this Revision. - |
-
-logUrl
+name
string
|
(Optional)
- LogURL specifies the generated logging url for this particular revision -based on the revision url template specified in the controller’s config. +Name is optionally used to expose a dedicated hostname for referencing this +target exclusively. It has the form: {name}.${route.status.domain} |
-imageDigest
+TrafficTarget
-string
+
+TrafficTarget
+
|
-(Optional)
- ImageDigest holds the resolved digest for the image specified -within .Spec.Container.Image. The digest is resolved during the creation -of Revision. This field holds the digest value regardless of whether -a tag or digest was originally specified in the Container object. It -may be empty if the image comes from a registry listed to skip resolution. +
+(Members of We inherit most of our fields by inlining the v1 type. +Ultimately all non-v1 fields will be deprecated. |
-(Appears on: -ConfigurationSpec)
+Resource Types: +-
RevisionTemplateSpec describes the data a revision should have when created from a template. -Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190
+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
spec
-
-RevisionSpec
+
+ConfigurationSpec
|
@@ -5216,63 +5303,43 @@ RevisionSpec
-PodSpec
+template
-
-Kubernetes core/v1.PodSpec
+
+RevisionTemplateSpec
|
-
-(Members of Template holds the latest specification for the Revision to be stamped out. |
-containerConcurrency
-
-int64
-
- |
-
-(Optional)
- ContainerConcurrency specifies the maximum allowed in-flight (concurrent)
-requests per container of the Revision. Defaults to |
timeoutSeconds
+status
-int64
+
+ConfigurationStatus
+
TimeoutSeconds holds the max duration the instance is allowed for -responding to a request. If unspecified, a system default will -be provided.
--(Appears on: -Route, -Route, -ServiceSpec) -
--
RouteSpec holds the desired state of the Route (from the client).
+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
-traffic
+apiVersion
+string |
+
+
+serving.knative.dev/v1beta1
+
+ |
+
+kind
+string
+ |
+Revision |
+
+metadata
-
-[]TrafficTarget
+
+Kubernetes meta/v1.ObjectMeta
|
(Optional)
- Traffic specifies how to distribute traffic over a collection of -revisions and configurations. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -Route, -Route) -
--
RouteStatus communicates the observed state of the Route (from the controller).
- -| Field | -Description | -
|---|---|
-Status
+spec
-knative.dev/pkg/apis/duck/v1.Status
+
+RevisionSpec
+
|
-
-(Members of |
-
-RouteStatusFields
+PodSpec
-
-RouteStatusFields
+
+Kubernetes core/v1.PodSpec
|
-(Members of |
-(Appears on: -RouteStatus, -ServiceStatus) -
--
RouteStatusFields holds the fields of Route’s status that -are not generally shared. This is defined separately and inlined so that -other types can readily consume these fields via duck typing.
- -| Field | -Description | -
|---|---|
-url
+containerConcurrency
-knative.dev/pkg/apis.URL
+int64
|
(Optional)
- URL holds the url that will distribute traffic over the provided traffic targets. -It generally has the form http[s]://{route-name}.{route-namespace}.{cluster-level-suffix} +ContainerConcurrency specifies the maximum allowed in-flight (concurrent)
+requests per container of the Revision. Defaults to |
-address
+timeoutSeconds
-knative.dev/pkg/apis/duck/v1.Addressable
+int64
|
(Optional)
- Address holds the information needed for a Route to be the target of an event. +TimeoutSeconds holds the max duration the instance is allowed for +responding to a request. If unspecified, a system default will +be provided. + |
+
traffic
+status
-
-[]TrafficTarget
+
+RevisionStatus
Traffic holds the configured traffic distribution. -These entries will always contain RevisionName references. -When ConfigurationName appears in the spec, this will hold the -LatestReadyRevisionName that we last observed.
-(Appears on: -Service, -Service) -
--
ServiceSpec represents the configuration for the Service object. -A Service’s specification is the union of the specifications for a Route -and Configuration. The Service restricts what can be expressed in these -fields, e.g. the Route must reference the provided Configuration; -however, these limitations also enable friendlier defaulting, -e.g. Route never needs a Configuration name, and may be defaulted to -the appropriate “run latest” spec.
+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
-ConfigurationSpec
-
-
-ConfigurationSpec
-
-
+apiVersion
+string |
+
+
+serving.knative.dev/v1beta1
+
|
+
|
-
-(Members of ServiceSpec inlines an unrestricted ConfigurationSpec. +kind
+string
|
+Route |
-RouteSpec
+metadata
-
-RouteSpec
+
+Kubernetes meta/v1.ObjectMeta
|
-
-(Members of 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). +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -Service, -Service) -
--
ServiceStatus represents the Status stanza of the Service resource.
- -| Field | -Description | -
|---|---|
-Status
+spec
-knative.dev/pkg/apis/duck/v1.Status
+
+RouteSpec
+
|
-
-(Members of |
-
-ConfigurationStatusFields
+traffic
-
-ConfigurationStatusFields
+
+[]TrafficTarget
|
-
-(Members of In addition to inlining ConfigurationSpec, we also inline the fields -specific to ConfigurationStatus. +(Optional) +Traffic specifies how to distribute traffic over a collection of +revisions and configurations. + |
+
RouteStatusFields
+status
-
-RouteStatusFields
+
+RouteStatus
-(Members of RouteStatusFields are embedded into this type.)
-
In addition to inlining RouteSpec, we also inline the fields -specific to RouteStatus.
+(Optional) +Status communicates the observed state of the Route (from the controller).
-(Appears on: -RouteSpec, -RouteStatusFields, -TrafficTarget) -
--
TrafficTarget holds a single entry of the routing table for a Route.
+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
-tag
-
-string
-
+apiVersion
+string |
+
+
+serving.knative.dev/v1beta1
+
|
+
|
-(Optional)
- Tag is optionally used to expose a dedicated url for referencing -this target exclusively. +kind
+string
|
+Service |
-revisionName
+metadata
-string
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- RevisionName of a specific revision to which to send this portion of -traffic. This is mutually exclusive with ConfigurationName. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-configurationName
+spec
-string
+
+ServiceSpec
+
|
(Optional)
- ConfigurationName of a configuration to whose latest revision we will send -this portion of traffic. When the “status.latestReadyRevisionName” of the -referenced configuration changes, we will automatically migrate traffic -from the prior “latest ready” revision to the new one. This field is never -set in Route’s status, only its spec. This is mutually exclusive with -RevisionName. - |
-
-latestRevision
+ConfigurationSpec
-bool
+
+ConfigurationSpec
+
|
-(Optional)
- LatestRevision may be optionally provided to indicate that the latest -ready Revision of the Configuration should be used for this traffic -target. When provided LatestRevision must be true if RevisionName is -empty; it must be false when RevisionName is non-empty. +
+(Members of ServiceSpec inlines an unrestricted ConfigurationSpec. |
-percent
+RouteSpec
-int64
+
+RouteSpec
+
|
-(Optional)
- Percent indicates that percentage based routing should be used and
-the value indicates the percent of traffic that is be routed to this
-Revision or Configuration.
+(Members of 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). + |
+
url
+status
-knative.dev/pkg/apis.URL
+
+ServiceStatus
+
URL displays the URL for accessing named traffic targets. URL is displayed in -status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and -a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)
Generated with gen-crd-api-reference-docs
-on git commit 804b3bb85.
+on git commit f87352b72.