diff --git a/docs/reference/eventing/eventing-contrib.md b/docs/reference/eventing/eventing-contrib.md index 1e82faf9a..416b479f2 100644 --- a/docs/reference/eventing/eventing-contrib.md +++ b/docs/reference/eventing/eventing-contrib.md @@ -1,2162 +1,12 @@

Packages:

-

sources.knative.dev/v1alpha1

-

-

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

-

-Resource Types: - -

AwsSqsSource -

-

-

AwsSqsSource is the Schema for the AWS SQS API

-

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

QueueURL of the SQS queue that we will poll from.

-
-awsCredsSecret
- - -Kubernetes core/v1.SecretKeySelector - - -		 -

AwsCredsSecret is the credential to use to poll the AWS SQS

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

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

-
-serviceAccountName
- -string - -		 -

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

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

CamelSource -

-

-

CamelSource is the Schema for the camelsources API

-

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

Source is the reference to the integration flow to run.

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

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

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

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

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

CouchDbSource -

-

-

CouchDbSource is the Schema for the githubsources API

-

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

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

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

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

-
-feed
- - -FeedType - - -		 -

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

-
-database
- -string - -		 -

Database is the database to watch for changes

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

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

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

GitHubSource -

-

-

GitHubSource is the Schema for the githubsources API

-

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

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

-
-ownerAndRepository
- -string - -		 -

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

-
-eventTypes
- -[]string - -		 -

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

-
-accessToken
- - -SecretValueFromSource - - -		 -

AccessToken is the Kubernetes secret containing the GitHub -access token

-
-secretToken
- - -SecretValueFromSource - - -		 -

SecretToken is the Kubernetes secret containing the GitHub -secret token

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

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

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

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

Secure can be set to true to configure the webhook to use https.

-
-
-status
- - -GitHubSourceStatus - - -		 -
-

PrometheusSource -

-

-

PrometheusSource is the Schema for the prometheussources API

-

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

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

-
-serverURL
- -string - -		 -

ServerURL is the URL of the Prometheus server

-
-promQL
- -string - -		 -

PromQL is the Prometheus query for this source

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

The name of the file containing the authenication token

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

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

-
-schedule
- -string - -		 -

A crontab-formatted schedule for running the PromQL query

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

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

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

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

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

AwsSqsSourceSpec -

-

-(Appears on: -AwsSqsSource) -

-

-

AwsSqsSourceSpec defines the desired state of the source.

-

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

QueueURL of the SQS queue that we will poll from.

-
-awsCredsSecret
- - -Kubernetes core/v1.SecretKeySelector - - -		 -

AwsCredsSecret is the credential to use to poll the AWS SQS

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

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

-
-serviceAccountName
- -string - -		 -

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

-
-

AwsSqsSourceStatus -

-

-(Appears on: -AwsSqsSource) -

-

-

AwsSqsSourceStatus defines the observed state of the source.

-

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

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

-

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

-
-

CamelSourceOriginSpec -

-

-(Appears on: -CamelSourceSpec) -

-

-

CamelSourceOriginSpec is the integration flow to run

-

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

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

-
-flow
- - -Flow - - -		 -

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

-
-

CamelSourceSpec -

-

-(Appears on: -CamelSource) -

-

-

CamelSourceSpec defines the desired state of CamelSource

-

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

Source is the reference to the integration flow to run.

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

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

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

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

-
-

CamelSourceStatus -

-

-(Appears on: -CamelSource) -

-

-

CamelSourceStatus defines the observed state of CamelSource

-

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

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

-

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

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

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

-
-

CouchDbSourceSpec -

-

-(Appears on: -CouchDbSource) -

-

-

CouchDbSourceSpec defines the desired state of CouchDbSource

-

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

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

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

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

-
-feed
- - -FeedType - - -		 -

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

-
-database
- -string - -		 -

Database is the database to watch for changes

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

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

-
-

CouchDbSourceStatus -

-

-(Appears on: -CouchDbSource) -

-

-

CouchDbSourceStatus defines the observed state of CouchDbSource

-

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

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

-

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

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

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

-
-

FeedType -(string alias)

-

-(Appears on: -CouchDbSourceSpec) -

-

-

FeedType is the type of Feed

-

-

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

-

-(Appears on: -CamelSourceOriginSpec) -

-

-

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

-

-

GitHubSourceSpec -

-

-(Appears on: -GitHubSource) -

-

-

GitHubSourceSpec defines the desired state of GitHubSource

-

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

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

-
-ownerAndRepository
- -string - -		 -

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

-
-eventTypes
- -[]string - -		 -

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

-
-accessToken
- - -SecretValueFromSource - - -		 -

AccessToken is the Kubernetes secret containing the GitHub -access token

-
-secretToken
- - -SecretValueFromSource - - -		 -

SecretToken is the Kubernetes secret containing the GitHub -secret token

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

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

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

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

Secure can be set to true to configure the webhook to use https.

-
-

GitHubSourceStatus -

-

-(Appears on: -GitHubSource) -

-

-

GitHubSourceStatus defines the observed state of GitHubSource

-

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

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

-

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

-
-webhookIDKey
- -string - -		 -

WebhookIDKey is the ID of the webhook registered with GitHub

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

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

-
-

KafkaLimitsSpec -

-

-(Appears on: -KafkaResourceSpec) -

-

-

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

KafkaRequestsSpec -

-

-(Appears on: -KafkaResourceSpec) -

-

-

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

KafkaResourceSpec -

-

-(Appears on: -KafkaSourceSpec) -

-

-

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

KafkaSource -

-

-

KafkaSource is the Schema for the kafkasources API.

-

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

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

-
-topics
- -string - -		 -

Topic topics to consume messages from

-
-consumerGroup
- -string - -		 -

ConsumerGroupID is the consumer group ID.

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

-
-serviceAccountName
- -string - -		 -

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

-
-resources
- - -KafkaResourceSpec - - -		 -

Resource limits and Request specifications of the Receive Adapter Deployment

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

KafkaSourceNetSpec -

-

-(Appears on: -KafkaSourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-sasl
- - -KafkaSourceSASLSpec - - -		 -
-tls
- - -KafkaSourceTLSSpec - - -		 -
-

KafkaSourceSASLSpec -

-

-(Appears on: -KafkaSourceNetSpec) -

-

-

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

User is the Kubernetes secret containing the SASL username.

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

Password is the Kubernetes secret containing the SASL password.

-
-

KafkaSourceSpec -

-

-(Appears on: -KafkaSource) -

-

-

KafkaSourceSpec defines the desired state of the KafkaSource.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-bootstrapServers
- -string - -		 -

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

-
-topics
- -string - -		 -

Topic topics to consume messages from

-
-consumerGroup
- -string - -		 -

ConsumerGroupID is the consumer group ID.

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

-
-serviceAccountName
- -string - -		 -

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

-
-resources
- - -KafkaResourceSpec - - -		 -

Resource limits and Request specifications of the Receive Adapter Deployment

-
-

KafkaSourceStatus -

-

-(Appears on: -KafkaSource) -

-

-

KafkaSourceStatus defines the observed state of KafkaSource.

-

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

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

-

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

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

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

-
-

KafkaSourceTLSSpec -

-

-(Appears on: -KafkaSourceNetSpec) -

-

-

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

Cert is the Kubernetes secret containing the client certificate.

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

Key is the Kubernetes secret containing the client key.

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

CACert is the Kubernetes secret containing the server CA cert.

-
-

PrometheusSourceSpec -

-

-(Appears on: -PrometheusSource) -

-

-

PrometheusSourceSpec defines the desired state of PrometheusSource

-

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

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

-
-serverURL
- -string - -		 -

ServerURL is the URL of the Prometheus server

-
-promQL
- -string - -		 -

PromQL is the Prometheus query for this source

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

The name of the file containing the authenication token

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

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

-
-schedule
- -string - -		 -

A crontab-formatted schedule for running the PromQL query

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

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

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

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

-
-

PrometheusSourceStatus -

-

-(Appears on: -PrometheusSource) -

-

-

PrometheusSourceStatus defines the observed state of PrometheusSource

-

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

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

-

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

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

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

-
-

SecretValueFromSource -

-

-(Appears on: -KafkaSourceSASLSpec, -KafkaSourceTLSSpec) -

-

-

SecretValueFromSource represents the source of a secret value

-

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

The Secret key to select from.

-
-

SecretValueFromSource -

-

-(Appears on: -GitHubSourceSpec) -

-

-

SecretValueFromSource represents the source of a secret value

-

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

The Secret key to select from.

-
-

messaging.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

@@ -2584,7 +434,2587 @@ knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
+

sources.knative.dev/v1alpha1

+

+

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

+

+Resource Types: + +

AwsSqsSource +

+

+

AwsSqsSource is the Schema for the AWS SQS API

+

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

QueueURL of the SQS queue that we will poll from.

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

AwsCredsSecret is the credential to use to poll the AWS SQS

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

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

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

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

+
+serviceAccountName
+ +string + +		 +

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

+
+
+status
+ + +AwsSqsSourceStatus + + +		 +
+

CamelSource +

+

+

CamelSource is the Schema for the camelsources API

+

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

Source is the reference to the integration flow to run.

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

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

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

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

+
+
+status
+ + +CamelSourceStatus + + +		 +
+

CouchDbSource +

+

+

CouchDbSource is the Schema for the githubsources API

+

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

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

+
+credentials
+ + +Kubernetes core/v1.ObjectReference + + +		 +

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

+
+feed
+ + +FeedType + + +		 +

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

+
+database
+ +string + +		 +

Database is the database to watch for changes

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

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

+
+
+status
+ + +CouchDbSourceStatus + + +		 +
+

GitHubSource +

+

+

GitHubSource is the Schema for the githubsources API

+

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

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

+
+ownerAndRepository
+ +string + +		 +

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

+
+eventTypes
+ +[]string + +		 +

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

+
+accessToken
+ + +SecretValueFromSource + + +		 +

AccessToken is the Kubernetes secret containing the GitHub +access token

+
+secretToken
+ + +SecretValueFromSource + + +		 +

SecretToken is the Kubernetes secret containing the GitHub +secret token

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

+
+githubAPIURL
+ +string + +		 +(Optional) +

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

+
+secure
+ +bool + +		 +(Optional) +

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

+
+
+status
+ + +GitHubSourceStatus + + +		 +
+

GitLabSource +

+

+

GitLabSource is the Schema for the gitlabsources API

+

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

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

+
+projectUrl
+ +string + +		 +

ProjectUrl is the url of the GitLab project we want to receive events from. +Examples: +https://github.com/knative/eventing-contrib/tree/master/gitlab/

+
+eventTypes
+ +[]string + +		 +

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

+
+accessToken
+ + +SecretValueFromSource + + +		 +

AccessToken is the Kubernetes secret containing the GitLab +access token

+
+secretToken
+ + +SecretValueFromSource + + +		 +

SecretToken is the Kubernetes secret containing the GitLab +secret token

+
+sslverify
+ +bool + +		 +

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

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

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

+
+
+status
+ + +GitLabSourceStatus + + +		 +
+

PrometheusSource +

+

+

PrometheusSource is the Schema for the prometheussources API

+

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

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

+
+serverURL
+ +string + +		 +

ServerURL is the URL of the Prometheus server

+
+promQL
+ +string + +		 +

PromQL is the Prometheus query for this source

+
+authTokenFile
+ +string + +		 +(Optional) +

The name of the file containing the authenication token

+
+caCertConfigMap
+ +string + +		 +(Optional) +

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

+
+schedule
+ +string + +		 +

A crontab-formatted schedule for running the PromQL query

+
+step
+ +string + +		 +(Optional) +

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

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

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

+
+
+status
+ + +PrometheusSourceStatus + + +		 +
+

AwsSqsSourceSpec +

+

+(Appears on: +AwsSqsSource) +

+

+

AwsSqsSourceSpec defines the desired state of the source.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+queueUrl
+ +string + +		 +

QueueURL of the SQS queue that we will poll from.

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

AwsCredsSecret is the credential to use to poll the AWS SQS

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

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

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

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

+
+serviceAccountName
+ +string + +		 +

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

+
+

AwsSqsSourceStatus +

+

+(Appears on: +AwsSqsSource) +

+

+

AwsSqsSourceStatus defines the observed state of the source.

+

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

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

+

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

+
+

CamelSourceOriginSpec +

+

+(Appears on: +CamelSourceSpec) +

+

+

CamelSourceOriginSpec is the integration flow to run

+

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

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

+
+flow
+ + +Flow + + +		 +

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

+
+

CamelSourceSpec +

+

+(Appears on: +CamelSource) +

+

+

CamelSourceSpec defines the desired state of CamelSource

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+source
+ + +CamelSourceOriginSpec + + +		 +

Source is the reference to the integration flow to run.

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

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

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

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

+
+

CamelSourceStatus +

+

+(Appears on: +CamelSource) +

+

+

CamelSourceStatus defines the observed state of CamelSource

+

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

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

+

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

+
+sinkUri
+ +string + +		 +(Optional) +

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

+
+

CouchDbSourceSpec +

+

+(Appears on: +CouchDbSource) +

+

+

CouchDbSourceSpec defines the desired state of CouchDbSource

+

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

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

+
+credentials
+ + +Kubernetes core/v1.ObjectReference + + +		 +

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

+
+feed
+ + +FeedType + + +		 +

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

+
+database
+ +string + +		 +

Database is the database to watch for changes

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

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

+
+

CouchDbSourceStatus +

+

+(Appears on: +CouchDbSource) +

+

+

CouchDbSourceStatus defines the observed state of CouchDbSource

+

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

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

+

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

+
+

FeedType +(string alias)

+

+(Appears on: +CouchDbSourceSpec) +

+

+

FeedType is the type of Feed

+

+

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

+

+(Appears on: +CamelSourceOriginSpec) +

+

+

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

+

+

GitHubSourceSpec +

+

+(Appears on: +GitHubSource) +

+

+

GitHubSourceSpec defines the desired state of GitHubSource

+

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

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

+
+ownerAndRepository
+ +string + +		 +

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

+
+eventTypes
+ +[]string + +		 +

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

+
+accessToken
+ + +SecretValueFromSource + + +		 +

AccessToken is the Kubernetes secret containing the GitHub +access token

+
+secretToken
+ + +SecretValueFromSource + + +		 +

SecretToken is the Kubernetes secret containing the GitHub +secret token

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

+
+githubAPIURL
+ +string + +		 +(Optional) +

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

+
+secure
+ +bool + +		 +(Optional) +

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

+
+

GitHubSourceStatus +

+

+(Appears on: +GitHubSource) +

+

+

GitHubSourceStatus defines the observed state of GitHubSource

+

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

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

+

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

+
+webhookIDKey
+ +string + +		 +

WebhookIDKey is the ID of the webhook registered with GitHub

+
+

GitLabSourceSpec +

+

+(Appears on: +GitLabSource) +

+

+

GitLabSourceSpec defines the desired state of GitLabSource

+

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

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

+
+projectUrl
+ +string + +		 +

ProjectUrl is the url of the GitLab project which we are interested +in receiving events from. +Examples: +https://github.com/knative/eventing-contrib/tree/{{% branch %}}/gitlab/samples

+
+eventTypes
+ +[]string + +		 +

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

+
+accessToken
+ + +SecretValueFromSource + + +		 +

AccessToken is the Kubernetes secret containing the GitLab +access token

+
+secretToken
+ + +SecretValueFromSource + + +		 +

SecretToken is the Kubernetes secret containing the GitLab +secret token

+
+sslverify
+ +bool + +		 +

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

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

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

+
+

GitLabSourceStatus +

+

+(Appears on: +GitLabSource) +

+

+

GitLabSourceStatus defines the observed state of GitLabSource

+

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

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

+

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

+
+Id
+ +string + +		 +

ID of the project hook registered with GitLab

+
+

KafkaLimitsSpec +

+

+(Appears on: +KafkaResourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+cpu
+ +string + +		 +
+memory
+ +string + +		 +
+

KafkaRequestsSpec +

+

+(Appears on: +KafkaResourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+cpu
+ +string + +		 +
+memory
+ +string + +		 +
+

KafkaResourceSpec +

+

+(Appears on: +KafkaSourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+requests
+ + +KafkaRequestsSpec + + +		 +
+limits
+ + +KafkaLimitsSpec + + +		 +
+

KafkaSource +

+

+

KafkaSource is the Schema for the kafkasources API.

+

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

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

+
+topics
+ +string + +		 +

Topic topics to consume messages from

+
+consumerGroup
+ +string + +		 +

ConsumerGroupID is the consumer group ID.

+
+net
+ + +KafkaSourceNetSpec + + +		 +
+sink
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +(Optional) +

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

+
+serviceAccountName
+ +string + +		 +

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

+
+resources
+ + +KafkaResourceSpec + + +		 +

Resource limits and Request specifications of the Receive Adapter Deployment

+
+
+status
+ + +KafkaSourceStatus + + +		 +
+

KafkaSourceNetSpec +

+

+(Appears on: +KafkaSourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+sasl
+ + +KafkaSourceSASLSpec + + +		 +
+tls
+ + +KafkaSourceTLSSpec + + +		 +
+

KafkaSourceSASLSpec +

+

+(Appears on: +KafkaSourceNetSpec) +

+

+

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

User is the Kubernetes secret containing the SASL username.

+
+password
+ + +SecretValueFromSource + + +		 +(Optional) +

Password is the Kubernetes secret containing the SASL password.

+
+

KafkaSourceSpec +

+

+(Appears on: +KafkaSource) +

+

+

KafkaSourceSpec defines the desired state of the KafkaSource.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+bootstrapServers
+ +string + +		 +

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

+
+topics
+ +string + +		 +

Topic topics to consume messages from

+
+consumerGroup
+ +string + +		 +

ConsumerGroupID is the consumer group ID.

+
+net
+ + +KafkaSourceNetSpec + + +		 +
+sink
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +(Optional) +

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

+
+serviceAccountName
+ +string + +		 +

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

+
+resources
+ + +KafkaResourceSpec + + +		 +

Resource limits and Request specifications of the Receive Adapter Deployment

+
+

KafkaSourceStatus +

+

+(Appears on: +KafkaSource) +

+

+

KafkaSourceStatus defines the observed state of KafkaSource.

+

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

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

+

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

+
+<<<<<<< HEAD +

KafkaSourceTLSSpec +======= +

SecretValueFromSource +

+

+(Appears on: +KafkaSourceSASLSpec, +KafkaSourceTLSSpec) +

+

+

SecretValueFromSource represents the source of a secret value

+

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

The Secret key to select from.

+
+

SecretValueFromSource +

+

+(Appears on: +GitHubSourceSpec) +

+

+

SecretValueFromSource represents the source of a secret value

+

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

The Secret key to select from.

+
+

SecretValueFromSource +>>>>>>> 15673978d483a43af83f84279f409699774b4a97 +

+

+(Appears on: +KafkaSourceNetSpec) +

+

+

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

Cert is the Kubernetes secret containing the client certificate.

+
+key
+ + +SecretValueFromSource + + +		 +(Optional) +

Key is the Kubernetes secret containing the client key.

+
+caCert
+ + +SecretValueFromSource + + +		 +(Optional) +

CACert is the Kubernetes secret containing the server CA cert.

+
+

PrometheusSourceSpec +

+

+(Appears on: +PrometheusSource) +

+

+

PrometheusSourceSpec defines the desired state of PrometheusSource

+

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

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

+
+serverURL
+ +string + +		 +

ServerURL is the URL of the Prometheus server

+
+promQL
+ +string + +		 +

PromQL is the Prometheus query for this source

+
+authTokenFile
+ +string + +		 +(Optional) +

The name of the file containing the authenication token

+
+caCertConfigMap
+ +string + +		 +(Optional) +

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

+
+schedule
+ +string + +		 +

A crontab-formatted schedule for running the PromQL query

+
+step
+ +string + +		 +(Optional) +

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

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

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

+
+

PrometheusSourceStatus +

+

+(Appears on: +PrometheusSource) +

+

+

PrometheusSourceStatus defines the observed state of PrometheusSource

+

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

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

+

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

+
+

SecretValueFromSource +

+

+(Appears on: +KafkaSourceSASLSpec, +KafkaSourceTLSSpec) +

+

+

SecretValueFromSource represents the source of a secret value

+

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

The Secret key to select from.

+
+

SecretValueFromSource +

+

+(Appears on: +GitHubSourceSpec) +

+

+

SecretValueFromSource represents the source of a secret value

+

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

The Secret key to select from.

+
+

SecretValueFromSource +

+

+(Appears on: +GitLabSourceSpec) +

+

+

SecretValueFromSource represents the source of a secret value

+

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

The Secret key to select from.

+
+

Generated with gen-crd-api-reference-docs -on git commit a49a7c73. +on git commit 6ba61a66.

diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index e3163febf..6c546e728 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,19 +1,16 @@

Packages:

-

configs.internal.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

ConfigMapPropagation -

-

-

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

-

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

Spec defines the desired state of the ConfigMapPropagation

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

OriginalNamespace is the namespace where the original configMaps are in

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

Selector only selects original configMaps with corresponding labels

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

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

-
-

ConfigMapPropagationSpec -

-

-(Appears on: -ConfigMapPropagation) -

-

-

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

OriginalNamespace is the namespace where the original configMaps are in

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

Selector only selects original configMaps with corresponding labels

-
-

ConfigMapPropagationStatus -

-

-(Appears on: -ConfigMapPropagation) -

-

-

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

-

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

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

-

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

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

CopyConfigMaps is the status for each copied configmap.

-
-

ConfigMapPropagationStatusCopyConfigMap -

-

-(Appears on: -ConfigMapPropagationStatus) -

-

-

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

-

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

Name is copy configmap’s name

-
-source
- -string - -		 -

Source is “originalNamespace/originalConfigMapName”

-
-operation
- -string - -		 -

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

-
-ready
- -string - -		 -

Ready represents the operation is ready or not

-
-reason
- -string - -		 -

Reason indicates reasons if the operation is not ready

-
-resourceVersionFromSource
- -string - -		 -

ResourceVersion is the resourceVersion of original configmap

-
-
-

eventing.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

Broker -

-

-

Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.

-

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

Spec defines the desired state of the Broker.

-
-
- - - - - - - - - - - - - -
-channelTemplateSpec
- - -ChannelTemplateSpec - - -		 -(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 for channel based broker implementation.

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

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

Delivery is the delivery specification to be used internally by the broker to -create subscriptions.

-
-
-status
- - -BrokerStatus - - -		 -(Optional) -

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

-
-

EventType -

-

-

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

Spec defines the desired state of the EventType.

-
-
- - - - - - - - - - - - - - - - - - - - - -
-type
- -string - -		 -

Type represents the CloudEvents type. It is authoritative.

-
-source
- -string - -		 -

Source is a URI, it represents the CloudEvents source.

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

-
-
-status
- - -EventTypeStatus - - -		 -(Optional) -

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

-
-

Trigger -

-

-

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

-

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

Spec defines the desired state of the Trigger.

-
-
- - - - - - - - - - - - - -
-broker
- -string - -		 -

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

-
-filter
- - -TriggerFilter - - -		 -(Optional) -

Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

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

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

-
-
-status
- - -TriggerStatus - - -		 -(Optional) -

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

-
-

BrokerSpec -

-

-(Appears on: -Broker) -

-

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-channelTemplateSpec
- - -ChannelTemplateSpec - - -		 -(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 for channel based broker implementation.

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

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

Delivery is the delivery specification to be used internally by the broker to -create subscriptions.

-
-

BrokerStatus -

-

-(Appears on: -Broker) -

-

-

BrokerStatus represents the current state of a Broker.

-

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

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

-

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

-
-address
- -knative.dev/pkg/apis/duck/v1alpha1.Addressable - -		 -

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}

-
-triggerChannel
- - -Kubernetes core/v1.ObjectReference - - -		 -

TriggerChannel is an objectref to the object for the TriggerChannel

-
-

EventTypeSpec -

-

-(Appears on: -EventType) -

-

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-type
- -string - -		 -

Type represents the CloudEvents type. It is authoritative.

-
-source
- -string - -		 -

Source is a URI, it represents the CloudEvents source.

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

-
-

EventTypeStatus -

-

-(Appears on: -EventType) -

-

-

EventTypeStatus represents the current state of a EventType.

-

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

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

-

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

-
-

TriggerFilter -

-

-(Appears on: -TriggerSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-sourceAndType
- - -TriggerFilterSourceAndType - - -		 -(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.

-
-

TriggerFilterAttributes -(map[string]string alias)

-

-(Appears on: -TriggerFilter) -

-

-

TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.

-

-

TriggerFilterSourceAndType -

-

-(Appears on: -TriggerFilter) -

-

-

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.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-type
- -string - -		 -
-source
- -string - -		 -
-

TriggerSpec -

-

-(Appears on: -Trigger) -

-

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-broker
- -string - -		 -

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

-
-filter
- - -TriggerFilter - - -		 -(Optional) -

Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

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

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

-
-

TriggerStatus -

-

-(Appears on: -Trigger) -

-

-

TriggerStatus represents the current state of a Trigger.

-

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

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

-

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

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

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

-
-
-

eventing.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

Broker -

-

-

Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.

-

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

Spec defines the desired state of the Broker.

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

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

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

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

-
-
-status
- - -BrokerStatus - - -		 -(Optional) -

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

-
-

EventType -

-

-

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

Spec defines the desired state of the EventType.

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

-
-
-status
- - -EventTypeStatus - - -		 -(Optional) -

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

-
-

Trigger -

-

-

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

-

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

Spec defines the desired state of the Trigger.

-
-
- - - - - - - - - - - - - -
-broker
- -string - -		 -

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

-
-filter
- - -TriggerFilter - - -		 -(Optional) -

Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

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

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

-
-
-status
- - -TriggerStatus - - -		 -(Optional) -

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

-
-

BrokerSpec -

-

-(Appears on: -Broker) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-config
- -knative.dev/pkg/apis/duck/v1.KReference - -		 -(Optional) -

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

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

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

-
-

BrokerStatus -

-

-(Appears on: -Broker) -

-

-

BrokerStatus represents the current state of a Broker.

-

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

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

-

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

-
-address
- -knative.dev/pkg/apis/duck/v1.Addressable - -		 -

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

-
-

EventTypeSpec -

-

-(Appears on: -EventType) -

-

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-type
- -string - -		 -

Type represents the CloudEvents type. It is authoritative.

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

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.

-
-

EventTypeStatus -

-

-(Appears on: -EventType) -

-

-

EventTypeStatus represents the current state of a EventType.

-

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

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

-

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

-
-

TriggerFilter -

-

-(Appears on: -TriggerSpec) -

-

-

- - - - - - - - - - - - - -
FieldDescription
-attributes
- - -TriggerFilterAttributes - - -		 -(Optional) -

Attributes filters events by exact match on event context attributes. -Each key in the map is compared with the equivalent key in the event -context. An event passes the filter if all values are equal to the -specified values.

-

Nested context attributes are not supported as keys. Only string values are supported.

-
-

TriggerFilterAttributes -(map[string]string alias)

-

-(Appears on: -TriggerFilter) -

-

-

TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.

-

-

TriggerSpec -

-

-(Appears on: -Trigger) -

-

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-broker
- -string - -		 -

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

-
-filter
- - -TriggerFilter - - -		 -(Optional) -

Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

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

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

-
-

TriggerStatus -

-

-(Appears on: -Trigger) -

-

-

TriggerStatus represents the current state of a Trigger.

-

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

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

-

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

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

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

-
-

flows.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

@@ -2725,3607 +852,6 @@ knative.dev/pkg/apis.Condition
-

sources.eventing.knative.dev/v1alpha1

-

-

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

-

-Resource Types: - -

ApiServerSource -

-

-

ApiServerSource is the Schema for the apiserversources API

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -sources.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 - - -		 -
-
- - - - - - - - - - - - - - - - - -
-resources
- - -[]ApiServerResource - - -		 -

Resources is the list of resources to watch

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

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

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

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

-
-mode
- -string - -		 -

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

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

ContainerSource -

-

-

ContainerSource is the Schema for the containersources API

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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 - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 -(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 Template instead. -When Template is set, this field is ignored.

-
-args
- -[]string - -		 -

DeprecatedArgs are passed to the ContainerSpec as they are. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

-
-env
- - -[]Kubernetes core/v1.EnvVar - - -		 -(Optional) -

DeprecatedEnv is the list of environment variables to set in the container. -Cannot be updated. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

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

DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this -source. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

-
-sink
- -knative.dev/pkg/apis/duck/v1beta1.Destination - -		 -

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

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

CronJobSource -

-

-

CronJobSource is the Schema for the cronjobsources API.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -sources.eventing.knative.dev/v1alpha1 - -
-kind
-string -		CronJobSource
-Deprecated
- - -Deprecated - - -		 -

Deprecated allows CronJobSource to have a deprecated message.

-
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -CronJobSourceSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - -
-schedule
- -string - -		 -

Schedule is the cronjob schedule.

-
-data
- -string - -		 -

Data is the data posted to the target function.

-
-sink
- -knative.dev/pkg/apis/duck/v1beta1.Destination - -		 -

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

-
-serviceAccountName
- -string - -		 -

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

-
-resources
- - -CronJobResourceSpec - - -		 -

Resource limits and Request specifications of the Receive Adapter Deployment

-
-
-status
- - -CronJobSourceStatus - - -		 -
-

SinkBinding -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -sources.eventing.knative.dev/v1alpha1 - -
-kind
-string -		SinkBinding
-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
- - -SinkBindingSpec - - -		 -
-
- - - - - - - - - -
-SourceSpec
- -knative.dev/pkg/apis/duck/v1.SourceSpec - -		 -

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

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

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

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

ApiServerResource -

-

-(Appears on: -ApiServerSourceSpec) -

-

-

ApiServerResource defines the resource to watch

-

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

API version of the resource to watch.

-
-kind
- -string - -		 -

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

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

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

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

ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional.

-
-controller
- -bool - -		 -

If true, send an event referencing the object controlling the resource

-
-

ApiServerSourceSpec -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceSpec defines the desired state of ApiServerSource

-

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

Resources is the list of resources to watch

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

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

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

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

-
-mode
- -string - -		 -

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

-
-

ApiServerSourceStatus -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceStatus defines the observed state of ApiServerSource

-

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

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

-

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

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

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

-
-

ContainerSourceSpec -

-

-(Appears on: -ContainerSource) -

-

-

ContainerSourceSpec defines the desired state of ContainerSource

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 -(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 Template instead. -When Template is set, this field is ignored.

-
-args
- -[]string - -		 -

DeprecatedArgs are passed to the ContainerSpec as they are. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

-
-env
- - -[]Kubernetes core/v1.EnvVar - - -		 -(Optional) -

DeprecatedEnv is the list of environment variables to set in the container. -Cannot be updated. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

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

DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this -source. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

-
-sink
- -knative.dev/pkg/apis/duck/v1beta1.Destination - -		 -

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

-
-

ContainerSourceStatus -

-

-(Appears on: -ContainerSource) -

-

-

ContainerSourceStatus defines the observed state of ContainerSource

-

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

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

-

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

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

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

-
-

CronJobLimitsSpec -

-

-(Appears on: -CronJobResourceSpec) -

-

-

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

CronJobRequestsSpec -

-

-(Appears on: -CronJobResourceSpec) -

-

-

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

CronJobResourceSpec -

-

-(Appears on: -CronJobSourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-requests
- - -CronJobRequestsSpec - - -		 -
-limits
- - -CronJobLimitsSpec - - -		 -
-

CronJobSourceSpec -

-

-(Appears on: -CronJobSource) -

-

-

CronJobSourceSpec defines the desired state of the CronJobSource.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-schedule
- -string - -		 -

Schedule is the cronjob schedule.

-
-data
- -string - -		 -

Data is the data posted to the target function.

-
-sink
- -knative.dev/pkg/apis/duck/v1beta1.Destination - -		 -

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

-
-serviceAccountName
- -string - -		 -

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

-
-resources
- - -CronJobResourceSpec - - -		 -

Resource limits and Request specifications of the Receive Adapter Deployment

-
-

CronJobSourceStatus -

-

-(Appears on: -CronJobSource) -

-

-

CronJobSourceStatus defines the observed state of CronJobSource.

-

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

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

-

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

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

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

-
-

Deprecated -

-

-(Appears on: -ApiServerSource, -ContainerSource, -CronJobSource, -SinkBinding) -

-

-

-

SinkBindingSpec -

-

-(Appears on: -SinkBinding) -

-

-

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

-

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

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

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

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

-
-

SinkBindingStatus -

-

-(Appears on: -SinkBinding) -

-

-

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

-

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

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

-
-
-

sources.knative.dev/v1alpha2

-

-

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

-

-Resource Types: - -

ApiServerSource -

-

-

ApiServerSource is the Schema for the apiserversources API

-

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

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

-

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

-
-resources
- - -[]APIVersionKind - - -		 -

Resource is the resource this source will track and send related -lifecycle events from the Kubernetes ApiServer.

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

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

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

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

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

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

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

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

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

PingSource -

-

-

PingSource is the Schema for the PingSources API.

-

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

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

-

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

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

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

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

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

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

SinkBinding -

-

-

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

-

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

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

-

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

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

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

-

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

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

APIVersionKind -

-

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

-

-

APIVersionKind is an APIVersion and Kind tuple.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
- -string - -		 -(Optional) -

APIVersion - the API version of the resource to watch.

-
-kind
- -string - -		 -(Optional) -

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

-
-

ApiServerSourceSpec -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceSpec defines the desired state of ApiServerSource

-

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

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

-

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

-
-resources
- - -[]APIVersionKind - - -		 -

Resource is the resource this source will track and send related -lifecycle events from the Kubernetes ApiServer.

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

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

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

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

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

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

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

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

-
-

ApiServerSourceStatus -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceStatus defines the observed state of ApiServerSource

-

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

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

-

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

-
-

PingSourceSpec -

-

-(Appears on: -PingSource) -

-

-

PingSourceSpec defines the desired state of the PingSource.

-

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

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

-

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

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

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

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

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

-
-

PingSourceStatus -

-

-(Appears on: -PingSource) -

-

-

PingSourceStatus defines the observed state of PingSource.

-

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

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

-

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

-
-

SinkBindingSpec -

-

-(Appears on: -SinkBinding) -

-

-

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

-

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

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

-

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

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

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

-

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

-
-

SinkBindingStatus -

-

-(Appears on: -SinkBinding) -

-

-

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

-

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

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

-

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

-
-
-

duck.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

Channelable -

-

-

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

-

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

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

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

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

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

DeliverySpec contains options controlling the event delivery

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

ChannelableCombined -

-

-

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

-

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

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

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

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

-

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

-
-SubscribableSpec
- - -SubscribableSpec - - -		 -

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

-

SubscribableSpec is for the v1beta1 spec compatibility.

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

DeliverySpec contains options controlling the event delivery

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

ChannelableCombinedSpec -

-

-(Appears on: -ChannelableCombined) -

-

-

ChannelableSpec contains Spec of the Channelable object

-

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

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

-

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

-
-SubscribableSpec
- - -SubscribableSpec - - -		 -

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

-

SubscribableSpec is for the v1beta1 spec compatibility.

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

DeliverySpec contains options controlling the event delivery

-
-

ChannelableCombinedStatus -

-

-(Appears on: -ChannelableCombined) -

-

-

ChannelableStatus contains the Status of a Channelable object.

-

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

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

-

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

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

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

-

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

-
-SubscribableTypeStatus
- - -SubscribableTypeStatus - - -		 -

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

-

SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

-
-SubscribableStatus
- - -SubscribableStatus - - -		 -

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

-

SubscribableStatus is the v1beta1 part of the Subscribers status.

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

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

-
-

ChannelableSpec -

-

-(Appears on: -Channelable) -

-

-

ChannelableSpec contains Spec of the Channelable object

-

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

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

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

DeliverySpec contains options controlling the event delivery

-
-

ChannelableStatus -

-

-(Appears on: -Channelable) -

-

-

ChannelableStatus contains the Status of a Channelable object.

-

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

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

-

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

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

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

-

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

-
-SubscribableTypeStatus
- - -SubscribableTypeStatus - - -		 -

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

-

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

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

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

-
-

Resource -

-

-

Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch -arbitrary other resources (such as any Source or Addressable). This is not a real resource.

-

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

Subscribable -

-

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

-

-

Subscribable is the schema for the subscribable portion of the spec -section of the resource.

-

- - - - - - - - - - - - - -
FieldDescription
-subscribers
- - -[]SubscriberSpec - - -		 -

This is the list of subscriptions for this subscribable.

-
-

SubscribableStatus -

-

-(Appears on: -SubscribableTypeStatus) -

-

-

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

-

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

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

-
-

SubscribableType -

-

-

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

-

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

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

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

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

-
-

SubscribableTypeSpec -

-

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

-

-

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

-

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

SubscribableTypeStatus -

-

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

-

-

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

-

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

SubscriberSpec -

-

-(Appears on: -Subscribable) -

-

-

SubscriberSpec defines a single subscriber to a Subscribable. -Ref is a reference to the Subscription this SubscriberSpec was created for -SubscriberURI is the endpoint for the subscriber -ReplyURI is the endpoint for the reply -At least one of SubscriberURI and ReplyURI must be present

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-uid
- -k8s.io/apimachinery/pkg/types.UID - -		 -(Optional) -

UID is used to understand the origin of the subscriber.

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

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

-
-subscriberURI
- -knative.dev/pkg/apis.URL - -		 -(Optional) -
-replyURI
- -knative.dev/pkg/apis.URL - -		 -(Optional) -
-deadLetterSink
- -knative.dev/pkg/apis.URL - -		 -(Optional) -
-delivery
- - -DeliverySpec - - -		 -(Optional) -
-

SubscriberStatus -

-

-(Appears on: -SubscribableStatus) -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-uid
- -k8s.io/apimachinery/pkg/types.UID - -		 -(Optional) -

UID is used to understand the origin of the subscriber.

-
-observedGeneration
- -int64 - -		 -(Optional) -

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

-
-ready
- - -Kubernetes core/v1.ConditionStatus - - -		 -(Optional) -

Status of the subscriber.

-
-message
- -string - -		 -(Optional) -

A human readable message indicating details of Ready status.

-
-
-

duck.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

BackoffPolicyType -(string alias)

-

-(Appears on: -DeliverySpec) -

-

-

BackoffPolicyType is the type for backoff policies

-

-

Channelable -

-

-

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

-

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

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

-
-
- - - - - - - - - -
-SubscribableSpec
- - -SubscribableSpec - - -		 -

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

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

DeliverySpec contains options controlling the event delivery

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

ChannelableSpec -

-

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

-

-

ChannelableSpec contains Spec of the Channelable object

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-SubscribableSpec
- - -SubscribableSpec - - -		 -

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

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

DeliverySpec contains options controlling the event delivery

-
-

ChannelableStatus -

-

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

-

-

ChannelableStatus contains the Status of a Channelable object.

-

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

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

-

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

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

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

-

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

-
-SubscribableStatus
- - -SubscribableStatus - - -		 -

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

-

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

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

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

-
-

DeliverySpec -

-

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

-

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

DeadLetterSink is the sink receiving event that couldn’t be sent to -a destination.

-
-retry
- -int32 - -		 -(Optional) -

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

-
-backoffPolicy
- - -BackoffPolicyType - - -		 -(Optional) -

BackoffPolicy is the retry backoff policy (linear, exponential)

-
-backoffDelay
- -string - -		 -(Optional) -

BackoffDelay is the delay before retrying. -More information on Duration format: https://www.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 -

-

-

DeliveryStatus contains the Status of an object supporting delivery options.

-

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

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

-
-

Subscribable -

-

-

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

-

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

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

-
-
- - - - - -
-subscribers
- - -[]SubscriberSpec - - -		 -

This is the list of subscriptions for this subscribable.

-
-
-status
- - -SubscribableStatus - - -		 -

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

-
-

SubscribableSpec -

-

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

-

-

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

-

- - - - - - - - - - - - - -
FieldDescription
-subscribers
- - -[]SubscriberSpec - - -		 -

This is the list of subscriptions for this subscribable.

-
-

SubscribableStatus -

-

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

-

-

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

-

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

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

-
-

SubscriberSpec -

-

-(Appears on: -SubscribableSpec) -

-

-

SubscriberSpec defines a single subscriber to a Subscribable.

-

At least one of SubscriberURI and ReplyURI must be present

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-uid
- -k8s.io/apimachinery/pkg/types.UID - -		 -(Optional) -

UID is used to understand the origin of the subscriber.

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

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

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

SubscriberURI is the endpoint for the subscriber

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

ReplyURI is the endpoint for the reply

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

DeliverySpec contains options controlling the event delivery

-
-

SubscriberStatus -

-

-(Appears on: -SubscribableStatus) -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-uid
- -k8s.io/apimachinery/pkg/types.UID - -		 -(Optional) -

UID is used to understand the origin of the subscriber.

-
-observedGeneration
- -int64 - -		 -(Optional) -

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

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

Status of the subscriber.

-
-message
- -string - -		 -(Optional) -

A human readable message indicating details of Ready status.

-
-

flows.knative.dev/v1beta1

Package v1beta1 is the v1beta1 version of the API.

@@ -7993,6 +2519,5156 @@ knative.dev/pkg/apis.URL
+

sources.knative.dev/v1alpha1

+

+

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

+

+Resource Types: + +

ApiServerSource +

+

+

ApiServerSource is the Schema for the apiserversources API

+

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

Resources is the list of resources to watch

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

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

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

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

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

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

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

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

+
+mode
+ +string + +		 +

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

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

PingSource +

+

+

PingSource is the Schema for the PingSources API.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.knative.dev/v1alpha1 + +
+kind
+string +		PingSource
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +PingSourceSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+schedule
+ +string + +		 +

Schedule is the cronjob 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) +

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

+
+serviceAccountName
+ +string + +		 +

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

+
+resources
+ + +PingResourceSpec + + +		 +

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

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

SinkBinding +

+

+

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

+

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

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

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

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

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

ApiServerResource +

+

+(Appears on: +ApiServerSourceSpec) +

+

+

ApiServerResource defines the resource to watch

+

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

API version of the resource to watch.

+
+kind
+ +string + +		 +

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

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

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

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

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

+
+controller
+ +bool + +		 +

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

+
+

ApiServerSourceSpec +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceSpec defines the desired state of ApiServerSource

+

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

Resources is the list of resources to watch

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

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

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

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

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

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

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

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

+
+mode
+ +string + +		 +

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

+
+

ApiServerSourceStatus +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

+

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

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

+

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

+
+

PingLimitsSpec +

+

+(Appears on: +PingResourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+cpu
+ +string + +		 +
+memory
+ +string + +		 +
+

PingRequestsSpec +

+

+(Appears on: +PingResourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+cpu
+ +string + +		 +
+memory
+ +string + +		 +
+

PingResourceSpec +

+

+(Appears on: +PingSourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+requests
+ + +PingRequestsSpec + + +		 +
+limits
+ + +PingLimitsSpec + + +		 +
+

PingSourceSpec +

+

+(Appears on: +PingSource) +

+

+

PingSourceSpec defines the desired state of the PingSource.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+schedule
+ +string + +		 +

Schedule is the cronjob 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) +

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

+
+serviceAccountName
+ +string + +		 +

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

+
+resources
+ + +PingResourceSpec + + +		 +

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

+
+

PingSourceStatus +

+

+(Appears on: +PingSource) +

+

+

PingSourceStatus defines the observed state of PingSource.

+

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

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

+

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

+
+

SinkBindingSpec +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

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

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

+
+

SinkBindingStatus +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

+
+
+

sources.knative.dev/v1alpha2

+

+

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

+

+Resource Types: + +

ApiServerSource +

+

+

ApiServerSource is the Schema for the apiserversources API

+

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

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

+

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

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

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

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

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

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

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

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

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

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

ContainerSource +

+

+

ContainerSource is the Schema for the containersources API

+

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

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

+

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

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

Template describes the pods that will be created

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

PingSource +

+

+

PingSource is the Schema for the PingSources API.

+

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

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

+

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

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

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

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

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

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

SinkBinding +

+

+

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

+

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

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

+

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

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

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

+

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

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

APIVersionKind +

+

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

+

+

APIVersionKind is an APIVersion and Kind tuple.

+

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

APIVersion - the API version of the resource to watch.

+
+kind
+ +string + +		 +

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

+
+

APIVersionKindSelector +

+

+(Appears on: +ApiServerSourceSpec) +

+

+

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

+

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

APIVersion - the API version of the resource to watch.

+
+kind
+ +string + +		 +

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

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

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

+
+

ApiServerSourceSpec +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceSpec defines the desired state of ApiServerSource

+

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

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

+

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

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

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

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

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

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

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

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

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

+
+

ApiServerSourceStatus +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

+

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

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

+

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

+
+

ContainerSourceSpec +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceSpec defines the desired state of ContainerSource

+

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

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

+

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

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

Template describes the pods that will be created

+
+

ContainerSourceStatus +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceStatus defines the observed state of ContainerSource

+

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

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

+

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

+
+

PingSourceSpec +

+

+(Appears on: +PingSource) +

+

+

PingSourceSpec defines the desired state of the PingSource.

+

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

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

+

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

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

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

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

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

+
+

PingSourceStatus +

+

+(Appears on: +PingSource) +

+

+

PingSourceStatus defines the observed state of PingSource.

+

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

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

+

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

+
+

SinkBindingSpec +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

+

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

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

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

+

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

+
+

SinkBindingStatus +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

+

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

+
+
+

duck.knative.dev/v1alpha1

+

+

Package v1alpha1 is the v1alpha1 version of the API.

+

+Resource Types: + +

Channelable +

+

+

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

+

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

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

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

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

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

DeliverySpec contains options controlling the event delivery

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

ChannelableCombined +

+

+

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

+

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

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

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

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

+

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

+
+SubscribableSpec
+ + +SubscribableSpec + + +		 +

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

+

SubscribableSpec is for the v1beta1 spec compatibility.

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

DeliverySpec contains options controlling the event delivery

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

ChannelableCombinedSpec +

+

+(Appears on: +ChannelableCombined) +

+

+

ChannelableSpec contains Spec of the Channelable object

+

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

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

+

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

+
+SubscribableSpec
+ + +SubscribableSpec + + +		 +

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

+

SubscribableSpec is for the v1beta1 spec compatibility.

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

DeliverySpec contains options controlling the event delivery

+
+

ChannelableCombinedStatus +

+

+(Appears on: +ChannelableCombined) +

+

+

ChannelableStatus contains the Status of a Channelable object.

+

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

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

+

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

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

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

+

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

+
+SubscribableTypeStatus
+ + +SubscribableTypeStatus + + +		 +

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

+

SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

+
+SubscribableStatus
+ + +SubscribableStatus + + +		 +

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

+

SubscribableStatus is the v1beta1 part of the Subscribers status.

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

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

+
+

ChannelableSpec +

+

+(Appears on: +Channelable) +

+

+

ChannelableSpec contains Spec of the Channelable object

+

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

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

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

DeliverySpec contains options controlling the event delivery

+
+

ChannelableStatus +

+

+(Appears on: +Channelable) +

+

+

ChannelableStatus contains the Status of a Channelable object.

+

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

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

+

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

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

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

+

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

+
+SubscribableTypeStatus
+ + +SubscribableTypeStatus + + +		 +

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

+

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

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

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

+
+

Resource +

+

+

Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch +arbitrary other resources (such as any Source or Addressable). This is not a real resource.

+

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

Subscribable +

+

+(Appears on: +ChannelSpec, +InMemoryChannelSpec, +SubscribableTypeSpec) +

+

+

Subscribable is the schema for the subscribable portion of the spec +section of the resource.

+

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

This is the list of subscriptions for this subscribable.

+
+

SubscribableStatus +

+

+(Appears on: +SubscribableTypeStatus) +

+

+

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

+

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

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

+
+

SubscribableType +

+

+

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

+

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

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

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

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

+
+

SubscribableTypeSpec +

+

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

+

+

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

+

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

SubscribableTypeStatus +

+

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

+

+

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

+

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

SubscriberSpec +

+

+(Appears on: +Subscribable) +

+

+

SubscriberSpec defines a single subscriber to a Subscribable. +Ref is a reference to the Subscription this SubscriberSpec was created for +SubscriberURI is the endpoint for the subscriber +ReplyURI is the endpoint for the reply +At least one of SubscriberURI and ReplyURI must be present

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+uid
+ +k8s.io/apimachinery/pkg/types.UID + +		 +(Optional) +

UID is used to understand the origin of the subscriber.

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

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

+
+subscriberURI
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +
+replyURI
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +
+deadLetterSink
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +
+delivery
+ + +DeliverySpec + + +		 +(Optional) +
+

SubscriberStatus +

+

+(Appears on: +SubscribableStatus) +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+uid
+ +k8s.io/apimachinery/pkg/types.UID + +		 +(Optional) +

UID is used to understand the origin of the subscriber.

+
+observedGeneration
+ +int64 + +		 +(Optional) +

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

+
+ready
+ + +Kubernetes core/v1.ConditionStatus + + +		 +(Optional) +

Status of the subscriber.

+
+message
+ +string + +		 +(Optional) +

A human readable message indicating details of Ready status.

+
+
+

duck.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

BackoffPolicyType +(string alias)

+

+(Appears on: +DeliverySpec) +

+

+

BackoffPolicyType is the type for backoff policies

+

+

Channelable +

+

+

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

+

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

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

+
+
+ + + + + + + + + +
+SubscribableSpec
+ + +SubscribableSpec + + +		 +

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

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

DeliverySpec contains options controlling the event delivery

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

ChannelableSpec +

+

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

+

+

ChannelableSpec contains Spec of the Channelable object

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+SubscribableSpec
+ + +SubscribableSpec + + +		 +

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

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

DeliverySpec contains options controlling the event delivery

+
+

ChannelableStatus +

+

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

+

+

ChannelableStatus contains the Status of a Channelable object.

+

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

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

+

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

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

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

+

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

+
+SubscribableStatus
+ + +SubscribableStatus + + +		 +

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

+

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

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

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

+
+

DeliverySpec +

+

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

+

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

DeadLetterSink is the sink receiving event that couldn’t be sent to +a destination.

+
+retry
+ +int32 + +		 +(Optional) +

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

+
+backoffPolicy
+ + +BackoffPolicyType + + +		 +(Optional) +

BackoffPolicy is the retry backoff policy (linear, exponential)

+
+backoffDelay
+ +string + +		 +(Optional) +

BackoffDelay is the delay before retrying. +More information on Duration format: https://www.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 +

+

+

DeliveryStatus contains the Status of an object supporting delivery options.

+

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

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

+
+

Subscribable +

+

+

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

+

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

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

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

This is the list of subscriptions for this subscribable.

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

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

+
+

SubscribableSpec +

+

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

+

+

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

+

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

This is the list of subscriptions for this subscribable.

+
+

SubscribableStatus +

+

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

+

+

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

+

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

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

+
+

SubscriberSpec +

+

+(Appears on: +SubscribableSpec) +

+

+

SubscriberSpec defines a single subscriber to a Subscribable.

+

At least one of SubscriberURI and ReplyURI must be present

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+uid
+ +k8s.io/apimachinery/pkg/types.UID + +		 +(Optional) +

UID is used to understand the origin of the subscriber.

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

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

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

SubscriberURI is the endpoint for the subscriber

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

ReplyURI is the endpoint for the reply

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

DeliverySpec contains options controlling the event delivery

+
+

SubscriberStatus +

+

+(Appears on: +SubscribableStatus) +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+uid
+ +k8s.io/apimachinery/pkg/types.UID + +		 +(Optional) +

UID is used to understand the origin of the subscriber.

+
+observedGeneration
+ +int64 + +		 +(Optional) +

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

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

Status of the subscriber.

+
+message
+ +string + +		 +(Optional) +

A human readable message indicating details of Ready status.

+
+
+

eventing.knative.dev/v1alpha1

+

+

Package v1alpha1 is the v1alpha1 version of the API.

+

+Resource Types: + +

Broker +

+

+

Broker collects a pool of events that are consumable using Triggers. Brokers +provide a well-known endpoint for event delivery that senders can use with +minimal knowledge of the event routing strategy. Receivers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.

+

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

Spec defines the desired state of the Broker.

+
+
+ + + + + + + + + + + + + +
+channelTemplateSpec
+ + +ChannelTemplateSpec + + +		 +(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 for channel based broker implementation.

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

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

Delivery is the delivery specification to be used internally by the broker to +create subscriptions.

+
+
+status
+ + +BrokerStatus + + +		 +(Optional) +

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

+
+

EventType +

+

+

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

Spec defines the desired state of the EventType.

+
+
+ + + + + + + + + + + + + + + + + + + + + +
+type
+ +string + +		 +

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +string + +		 +(Optional) +

Source is a URI, it represents the CloudEvents source.

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

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

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

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

+
+
+status
+ + +EventTypeStatus + + +		 +(Optional) +

Status represents the current state of the EventType. +This data may be out of date. +TODO might be removed https://github.com/knative/eventing/issues/2750

+
+

Trigger +

+

+

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

+

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

Spec defines the desired state of the Trigger.

+
+
+ + + + + + + + + + + + + +
+broker
+ +string + +		 +

Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

+
+filter
+ + +TriggerFilter + + +		 +(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+
+subscriber
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.

+
+
+status
+ + +TriggerStatus + + +		 +(Optional) +

Status represents the current state of the Trigger. This data may be out of +date.

+
+

BrokerSpec +

+

+(Appears on: +Broker) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+channelTemplateSpec
+ + +ChannelTemplateSpec + + +		 +(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 for channel based broker implementation.

+
+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.

+
+delivery
+ + +DeliverySpec + + +		 +(Optional) +

Delivery is the delivery specification to be used internally by the broker to +create subscriptions.

+
+

BrokerStatus +

+

+(Appears on: +Broker) +

+

+

BrokerStatus represents the current state of a Broker.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+address
+ +knative.dev/pkg/apis/duck/v1alpha1.Addressable + +		 +

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}

+
+triggerChannel
+ + +Kubernetes core/v1.ObjectReference + + +		 +

TriggerChannel is an objectref to the object for the TriggerChannel

+
+

EventTypeSpec +

+

+(Appears on: +EventType) +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ +string + +		 +

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +string + +		 +(Optional) +

Source is a URI, it represents the CloudEvents source.

+
+schema
+ +string + +		 +(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 + +		 +(Optional) +

TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

+
+description
+ +string + +		 +(Optional) +

Description is an optional field used to describe the EventType, in any meaningful way.

+
+

EventTypeStatus +

+

+(Appears on: +EventType) +

+

+

EventTypeStatus represents the current state of a EventType.

+

+ + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+

TriggerFilter +

+

+(Appears on: +TriggerSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+sourceAndType
+ + +TriggerFilterSourceAndType + + +		 +(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.

+
+

TriggerFilterAttributes +(map[string]string alias)

+

+(Appears on: +TriggerFilter) +

+

+

TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.

+

+

TriggerFilterSourceAndType +

+

+(Appears on: +TriggerFilter) +

+

+

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.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ +string + +		 +
+source
+ +string + +		 +
+

TriggerSpec +

+

+(Appears on: +Trigger) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+broker
+ +string + +		 +

Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

+
+filter
+ + +TriggerFilter + + +		 +(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+
+subscriber
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.

+
+

TriggerStatus +

+

+(Appears on: +Trigger) +

+

+

TriggerStatus represents the current state of a Trigger.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+subscriberURI
+ +knative.dev/pkg/apis.URL + +		 +

SubscriberURI is the resolved URI of the receiver for this Trigger.

+
+
+

eventing.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

Broker +

+

+

Broker collects a pool of events that are consumable using Triggers. Brokers +provide a well-known endpoint for event delivery that senders can use with +minimal knowledge of the event routing strategy. Receivers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +eventing.knative.dev/v1beta1 + +
+kind
+string +		Broker
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +BrokerSpec + + +		 +

Spec defines the desired state of the Broker.

+
+
+ + + + + + + + + +
+config
+ +knative.dev/pkg/apis/duck/v1.KReference + +		 +(Optional) +

Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.

+
+delivery
+ + +DeliverySpec + + +		 +(Optional) +

Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.

+
+
+status
+ + +BrokerStatus + + +		 +(Optional) +

Status represents the current state of the Broker. This data may be out of +date.

+
+

EventType +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +eventing.knative.dev/v1beta1 + +
+kind
+string +		EventType
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +EventTypeSpec + + +		 +

Spec defines the desired state of the EventType.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+type
+ +string + +		 +

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +

Source is a URI, it represents the CloudEvents source.

+
+schema
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.

+
+schemaData
+ +string + +		 +(Optional) +

SchemaData allows the CloudEvents schema to be stored directly in the +EventType. Content is dependent on the encoding. Optional attribute. +The contents are not validated or manipulated by the system.

+
+broker
+ +string + +		 +(Optional) +

TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

+
+description
+ +string + +		 +(Optional) +

Description is an optional field used to describe the EventType, in any meaningful way.

+
+
+status
+ + +EventTypeStatus + + +		 +(Optional) +

Status represents the current state of the EventType. +This data may be out of date. +TODO might be removed https://github.com/knative/eventing/issues/2750

+
+

Trigger +

+

+

Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +eventing.knative.dev/v1beta1 + +
+kind
+string +		Trigger
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +TriggerSpec + + +		 +

Spec defines the desired state of the Trigger.

+
+
+ + + + + + + + + + + + + +
+broker
+ +string + +		 +

Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

+
+filter
+ + +TriggerFilter + + +		 +(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+
+subscriber
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.

+
+
+status
+ + +TriggerStatus + + +		 +(Optional) +

Status represents the current state of the Trigger. This data may be out of +date.

+
+

BrokerSpec +

+

+(Appears on: +Broker) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+config
+ +knative.dev/pkg/apis/duck/v1.KReference + +		 +(Optional) +

Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.

+
+delivery
+ + +DeliverySpec + + +		 +(Optional) +

Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.

+
+

BrokerStatus +

+

+(Appears on: +Broker) +

+

+

BrokerStatus represents the current state of a Broker.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+address
+ +knative.dev/pkg/apis/duck/v1.Addressable + +		 +

Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh.

+
+

EventTypeSpec +

+

+(Appears on: +EventType) +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ +string + +		 +

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +

Source is a URI, it represents the CloudEvents source.

+
+schema
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.

+
+schemaData
+ +string + +		 +(Optional) +

SchemaData allows the CloudEvents schema to be stored directly in the +EventType. Content is dependent on the encoding. Optional attribute. +The contents are not validated or manipulated by the system.

+
+broker
+ +string + +		 +(Optional) +

TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

+
+description
+ +string + +		 +(Optional) +

Description is an optional field used to describe the EventType, in any meaningful way.

+
+

EventTypeStatus +

+

+(Appears on: +EventType) +

+

+

EventTypeStatus represents the current state of a EventType.

+

+ + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+

TriggerFilter +

+

+(Appears on: +TriggerSpec) +

+

+

+ + + + + + + + + + + + + +
FieldDescription
+attributes
+ + +TriggerFilterAttributes + + +		 +(Optional) +

Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values.

+

Nested context attributes are not supported as keys. Only string values are supported.

+
+

TriggerFilterAttributes +(map[string]string alias)

+

+(Appears on: +TriggerFilter) +

+

+

TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.

+

+

TriggerSpec +

+

+(Appears on: +Trigger) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+broker
+ +string + +		 +

Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.

+
+filter
+ + +TriggerFilter + + +		 +(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

+
+subscriber
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.

+
+

TriggerStatus +

+

+(Appears on: +Trigger) +

+

+

TriggerStatus represents the current state of a Trigger.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+subscriberUri
+ +knative.dev/pkg/apis.URL + +		 +

SubscriberURI is the resolved URI of the receiver for this Trigger.

+
+

messaging.knative.dev/v1beta1

Package v1beta1 is the v1beta1 version of the API.

@@ -8459,12 +8135,12 @@ knative.dev/pkg/apis/duck/v1.KReference

(Appears on: BrokerSpec, -ChannelSpec, ChannelSpec, -ParallelSpec, +ChannelSpec, ParallelSpec, -SequenceSpec, -SequenceSpec) +ParallelSpec, +SequenceSpec, +SequenceSpec)

@@ -8815,22 +8491,18 @@ knative.dev/pkg/apis.URL
-

sources.knative.dev/v1alpha1

+

configs.internal.knative.dev/v1alpha1

-

Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group

+

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types: -

ApiServerSource +

ConfigMapPropagation

-

ApiServerSource is the Schema for the apiserversources API

+

ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace

@@ -8846,7 +8518,7 @@ Resource Types: string @@ -8855,7 +8527,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -8875,64 +8548,25 @@ Refer to the Kubernetes API documentation for the fields of the - - - - - -
-sources.knative.dev/v1alpha1 +configs.internal.knative.dev/v1alpha1
ApiServerSourceConfigMapPropagation
@@ -8867,6 +8539,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ApiServerSourceSpec + +ConfigMapPropagationSpec 		+

Spec defines the desired state of the ConfigMapPropagation



- - - - - - - - - - - - @@ -8946,317 +8580,36 @@ Kubernetes meta/v1.LabelSelector + +
-resources
- - -[]ApiServerResource - - -		 -

Resources is the list of resources to watch

-
-serviceAccountName
+originalNamespace
string 		-(Optional) -

ServiceAccountName is the name of the ServiceAccount to use to run this -source.

-
-sink
- -knative.dev/pkg/apis/duck/v1beta1.Destination - -		 -(Optional) -

Sink is a reference to an object that will resolve to a domain name to use as the sink.

-
-ceOverrides
- -knative.dev/pkg/apis/duck/v1.CloudEventOverrides - -		 -(Optional) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

+

OriginalNamespace is the namespace where the original configMaps are in
(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

+

Selector only selects original configMaps with corresponding labels

+
-owner
+status
- -APIVersionKind + +ConfigMapPropagationStatus 		(Optional) -

ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

-
-mode
- -string - -		 -

Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

-
- - - - -status
- - -ApiServerSourceStatus - - - - +

Status represents the current state of the EventType. +This data may be out of date.

-

PingSource -

-

-

PingSource is the Schema for the PingSources API.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -sources.knative.dev/v1alpha1 - -
-kind
-string -		PingSource
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -PingSourceSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-schedule
- -string - -		 -

Schedule is the cronjob 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) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

-
-serviceAccountName
- -string - -		 -

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. -Deprecated: v1beta1 drops this field.

-
-resources
- - -PingResourceSpec - - -		 -

Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

-
-
-status
- - -PingSourceStatus - - -		 -
-

SinkBinding -

-

-

SinkBinding describes a Binding that is also a Source. -The sink (from the Source duck) is resolved to a URL and -then projected into the subject by augmenting the runtime -contract of the referenced containers to have a K_SINK -environment variable holding the endpoint to which to send -cloud events.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -sources.knative.dev/v1alpha1 - -
-kind
-string -		SinkBinding
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -SinkBindingSpec - - -		 -
-
- - - - - - - - - -
-SourceSpec
- -knative.dev/pkg/apis/duck/v1.SourceSpec - -		 -

-(Members of SourceSpec are embedded into this type.) -

-
-BindingSpec
- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -		 -

-(Members of BindingSpec are embedded into this type.) -

-
-
-status
- - -SinkBindingStatus - - -		 -
-

ApiServerResource +

ConfigMapPropagationSpec

(Appears on: -ApiServerSourceSpec) +ConfigMapPropagation)

-

ApiServerResource defines the resource to watch

@@ -9268,140 +8621,13 @@ SinkBindingStatus - - - - - - - - - - - - - - - - - - -
-apiVersion
+originalNamespace
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
- - -Kubernetes meta/v1.OwnerReference - - -		 -

ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. -Deprecated: Per-resource owner refs will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

-
-controller
- -bool - -		 -

If true, send an event referencing the object controlling the resource -Deprecated: Per-resource controller flag will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

-
-

ApiServerSourceSpec -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceSpec defines the desired state of ApiServerSource

-

- - - - - - - - - - - - - - - - - - - - - - - @@ -9415,299 +8641,19 @@ Kubernetes meta/v1.LabelSelector - - - - - - - -
FieldDescription
-resources
- - -[]ApiServerResource - - -		 -

Resources is the list of resources to watch

-
-serviceAccountName
- -string - -		 -(Optional) -

ServiceAccountName is the name of the ServiceAccount to use to run this -source.

-
-sink
- -knative.dev/pkg/apis/duck/v1beta1.Destination - -		 -(Optional) -

Sink is a reference to an object that will resolve to a domain name to use as the sink.

-
-ceOverrides
- -knative.dev/pkg/apis/duck/v1.CloudEventOverrides - -		 -(Optional) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

+

OriginalNamespace is the namespace where the original configMaps are in
(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

-
-owner
- - -APIVersionKind - - -		 -(Optional) -

ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

-
-mode
- -string - -		 -

Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

+

Selector only selects original configMaps with corresponding labels
-

ApiServerSourceStatus +

ConfigMapPropagationStatus

(Appears on: -ApiServerSource) +ConfigMapPropagation)

-

ApiServerSourceStatus defines the observed state of ApiServerSource

-

- - - - - - - - - - - - - -
FieldDescription
-SourceStatus
- -knative.dev/pkg/apis/duck/v1.SourceStatus - -		 -

-(Members of SourceStatus are embedded into this type.) -

-

inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

-
-

PingLimitsSpec -

-

-(Appears on: -PingResourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-cpu
- -string - -		 -
-memory
- -string - -		 -
-

PingRequestsSpec -

-

-(Appears on: -PingResourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-cpu
- -string - -		 -
-memory
- -string - -		 -
-

PingResourceSpec -

-

-(Appears on: -PingSourceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-requests
- - -PingRequestsSpec - - -		 -
-limits
- - -PingLimitsSpec - - -		 -
-

PingSourceSpec -

-

-(Appears on: -PingSource) -

-

-

PingSourceSpec defines the desired state of the PingSource.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-schedule
- -string - -		 -

Schedule is the cronjob 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) -

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

-
-serviceAccountName
- -string - -		 -

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. -Deprecated: v1beta1 drops this field.

-
-resources
- - -PingResourceSpec - - -		 -

Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

-
-

PingSourceStatus -

-

-(Appears on: -PingSource) -

-

-

PingSourceStatus defines the observed state of PingSource.

+

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

@@ -9735,26 +8681,28 @@ knative.dev/pkg/apis/duck/v1.Status
-sinkUri
+copyConfigmaps
-knative.dev/pkg/apis.URL + +[]ConfigMapPropagationStatusCopyConfigMap + 		(Optional) -

SinkURI is the current active sink URI that has been configured for the PingSource.

+

CopyConfigMaps is the status for each copied configmap.
-

SinkBindingSpec +

ConfigMapPropagationStatusCopyConfigMap

(Appears on: -SinkBinding) +ConfigMapPropagationStatus)

-

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

+

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

@@ -9766,60 +8714,68 @@ knative.dev/pkg/apis.URL - -
-SourceSpec
+name
-knative.dev/pkg/apis/duck/v1.SourceSpec +string 		-

-(Members of SourceSpec are embedded into this type.) -

+

Name is copy configmap’s name
-BindingSpec
+source
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +string 		-

-(Members of BindingSpec are embedded into this type.) -

+

Source is “originalNamespace/originalConfigMapName”
-

SinkBindingStatus -

-

-(Appears on: -SinkBinding) -

-

-

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

-

- - - - - - - - + + + + + + + + + + + + @@ -9827,5 +8783,5 @@ knative.dev/pkg/apis/duck/v1.SourceStatus

Generated with gen-crd-api-reference-docs -on git commit 200ea1ae. +on git commit 02bc5166.

diff --git a/docs/reference/serving.md b/docs/reference/serving.md index efa0cbda6..eb1b7199d 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1,12 +1,6 @@

Packages:

+

autoscaling.internal.knative.dev/v1alpha1

+

+

+Resource Types: + +

PodAutoscaler +

+

+

PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative +components instantiate autoscalers. This definition is an abstraction that may be backed +by multiple definitions. For more information, see the Knative Pluggability presentation: +https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit

+

+
FieldDescription
-SourceStatus
+operation
-knative.dev/pkg/apis/duck/v1.SourceStatus +string 		-

-(Members of SourceStatus are embedded into this type.) -

+

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
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +autoscaling.internal.knative.dev/v1alpha1 + +
+kind
+string +		PodAutoscaler
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +PodAutoscalerSpec + + +		 +(Optional) +

Spec holds the desired state of the PodAutoscaler (from the client).

+
+
+ + + + + + + + + + + + + + + + + + + + + +
+generation
+ +int64 + +		 +(Optional) +

DeprecatedGeneration was used prior in Kubernetes versions <1.11 +when metadata.generation was not being incremented by the api server

+

This property will be dropped in future Knative releases and should +not be used - use metadata.generation

+

Tracking issue: https://github.com/knative/serving/issues/643

+
+containerConcurrency
+ +int64 + +		 +(Optional) +

ContainerConcurrency specifies the maximum allowed +in-flight (concurrent) requests per container of the Revision. +Defaults to 0 which means unlimited concurrency.

+
+scaleTargetRef
+ + +Kubernetes core/v1.ObjectReference + + +		 +

ScaleTargetRef defines the /scale-able resource that this PodAutoscaler +is responsible for quickly right-sizing.

+
+reachability
+ + +ReachabilityType + + +		 +(Optional) +

Reachable specifies whether or not the ScaleTargetRef can be reached (ie. has a route). +Defaults to ReachabilityUnknown

+
+protocolType
+ +knative.dev/serving/pkg/apis/networking.ProtocolType + +		 +

The application-layer protocol. Matches ProtocolType inferred from the revision spec.

+
+
+status
+ + +PodAutoscalerStatus + + +		 +(Optional) +

Status communicates the observed state of the PodAutoscaler (from the controller).

+
+

Metric +

+

+

Metric represents a resource to configure the metric collector with.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +MetricSpec + + +		 +(Optional) +

Spec holds the desired state of the Metric (from the client).

+
+
+ + + + + + + + + + + + + +
+stableWindow
+ +time.Duration + +		 +

StableWindow is the aggregation window for metrics in a stable state.

+
+panicWindow
+ +time.Duration + +		 +

PanicWindow is the aggregation window for metrics where quick reactions are needed.

+
+scrapeTarget
+ +string + +		 +

ScrapeTarget is the K8s service that publishes the metric endpoint.

+
+
+status
+ + +MetricStatus + + +		 +(Optional) +

Status communicates the observed state of the Metric (from the controller).

+
+

MetricSpec +

+

+(Appears on: +Metric) +

+

+

MetricSpec contains all values a metric collector needs to operate.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+stableWindow
+ +time.Duration + +		 +

StableWindow is the aggregation window for metrics in a stable state.

+
+panicWindow
+ +time.Duration + +		 +

PanicWindow is the aggregation window for metrics where quick reactions are needed.

+
+scrapeTarget
+ +string + +		 +

ScrapeTarget is the K8s service that publishes the metric endpoint.

+
+

MetricStatus +

+

+(Appears on: +Metric) +

+

+

MetricStatus reflects the status of metric collection for this specific entity.

+

+ + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+
+

PodAutoscalerSpec +

+

+(Appears on: +PodAutoscaler) +

+

+

PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+generation
+ +int64 + +		 +(Optional) +

DeprecatedGeneration was used prior in Kubernetes versions <1.11 +when metadata.generation was not being incremented by the api server

+

This property will be dropped in future Knative releases and should +not be used - use metadata.generation

+

Tracking issue: https://github.com/knative/serving/issues/643

+
+containerConcurrency
+ +int64 + +		 +(Optional) +

ContainerConcurrency specifies the maximum allowed +in-flight (concurrent) requests per container of the Revision. +Defaults to 0 which means unlimited concurrency.

+
+scaleTargetRef
+ + +Kubernetes core/v1.ObjectReference + + +		 +

ScaleTargetRef defines the /scale-able resource that this PodAutoscaler +is responsible for quickly right-sizing.

+
+reachability
+ + +ReachabilityType + + +		 +(Optional) +

Reachable specifies whether or not the ScaleTargetRef can be reached (ie. has a route). +Defaults to ReachabilityUnknown

+
+protocolType
+ +knative.dev/serving/pkg/apis/networking.ProtocolType + +		 +

The application-layer protocol. Matches ProtocolType inferred from the revision spec.

+
+

PodAutoscalerStatus +

+

+(Appears on: +PodAutoscaler) +

+

+

PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+
+serviceName
+ +string + +		 +

ServiceName is the K8s Service name that serves the revision, scaled by this PA. +The service is created and owned by the ServerlessService object owned by this PA.

+
+metricsServiceName
+ +string + +		 +

MetricsServiceName is the K8s Service name that provides revision metrics. +The service is managed by the PA object.

+
+desiredScale
+ +int32 + +		 +

DesiredScale shows the current desired number of replicas for the revision.

+
+actualScale
+ +int32 + +		 +

ActualScale shows the actual number of replicas for the revision.

+
+

PodScalable +

+

+

PodScalable is a duck type that the resources referenced by the +PodAutoscaler’s ScaleTargetRef must implement. They must also +implement the /scale sub-resource for use with /scale based +implementations (e.g. HPA), but this further constrains the shape +the referenced resources may take.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +PodScalableSpec + + +		 +
+
+ + + + + + + + + + + + + +
+replicas
+ +int32 + +		 +
+selector
+ + +Kubernetes meta/v1.LabelSelector + + +		 +
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +		 +
+
+status
+ + +PodScalableStatus + + +		 +
+

PodScalableSpec +

+

+(Appears on: +PodScalable) +

+

+

PodScalableSpec is the specification for the desired state of a +PodScalable (or at least our shared portion).

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+replicas
+ +int32 + +		 +
+selector
+ + +Kubernetes meta/v1.LabelSelector + + +		 +
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +		 +
+

PodScalableStatus +

+

+(Appears on: +PodScalable) +

+

+

PodScalableStatus is the observed state of a PodScalable (or at +least our shared portion).

+

+ + + + + + + + + + + + + +
FieldDescription
+replicas
+ +int32 + +		 +
+

ReachabilityType +(string alias)

+

+(Appears on: +PodAutoscalerSpec) +

+

+

ReachabilityType is the enumeration type for the different states of reachability +to the ScaleTarget of a PodAutoscaler

+

+
+

networking.internal.knative.dev/v1alpha1

+

+

+Resource Types: + +

Certificate +

+

+

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).

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +networking.internal.knative.dev/v1alpha1 + +
+kind
+string +		Certificate
+metadata
+ + +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 the +metadata field. +
+spec
+ + +CertificateSpec + + +		 +(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

+
+
+ + + + + + + + + +
+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.

+
+secretName
+ +string + +		 +

SecretName is the name of the secret resource to store the SSL certificate in.

+
+
+status
+ + +CertificateStatus + + +		 +(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

+
+

Ingress +

+

+

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.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +networking.internal.knative.dev/v1alpha1 + +
+kind
+string +		Ingress
+metadata
+ + +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 the +metadata field. +
+spec
+ + +IngressSpec + + +		 +(Optional) +

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

+
+
+ + + + + + + + + + + + + + + + + +
+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

+
+tls
+ + +[]IngressTLS + + +		 +(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.

+
+rules
+ + +[]IngressRule + + +		 +(Optional) +

A list of host rules used to configure the Ingress.

+
+visibility
+ + +IngressVisibility + + +		 +

Visibility setting.

+
+
+status
+ + +IngressStatus + + +		 +(Optional) +

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

+
+

ServerlessService +

+

+

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.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +networking.internal.knative.dev/v1alpha1 + +
+kind
+string +		ServerlessService
+metadata
+ + +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 the +metadata field. +
+spec
+ + +ServerlessServiceSpec + + +		 +(Optional) +

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

+
+
+ + + + + + + + + + + + + + + + + +
+mode
+ + +ServerlessServiceOperationMode + + +		 +

Mode describes the mode of operation of the ServerlessService.

+
+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 RevisionProtocolType set on the owning pa/revision. +serving imports networking, so just use string.

+
+numActivators
+ +int32 + +		 +

NumActivators contains number of Activators that this revision should be +assigned. +O means — assign all.

+
+
+status
+ + +ServerlessServiceStatus + + +		 +(Optional) +

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

+
+

CertificateSpec +

+

+(Appears on: +Certificate) +

+

+

CertificateSpec defines the desired state of a Certificate.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+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.

+
+secretName
+ +string + +		 +

SecretName is the name of the secret resource to store the SSL certificate in.

+
+

CertificateStatus +

+

+(Appears on: +Certificate) +

+

+

CertificateStatus defines the observed state of a Certificate.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+

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
+ + +Kubernetes meta/v1.Time + + +		 +(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..

+
+

HTTP01Challenge +

+

+(Appears on: +CertificateStatus) +

+

+

HTTP01Challenge defines the status of a HTTP01 challenge that a certificate needs +to fulfill.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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.

+
+

HTTPIngressPath +

+

+(Appears on: +HTTPIngressRuleValue) +

+

+

HTTPIngressPath associates a path regex with a backend. Incoming URLs matching +the path are forwarded to the backend.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+path
+ +string + +		 +(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.

+
+splits
+ + +[]IngressBackendSplit + + +		 +

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.

+
+timeout
+ + +Kubernetes meta/v1.Duration + + +		 +(Optional) +

Timeout for HTTP requests.

+

NOTE: This differs from K8s Ingress which doesn’t allow setting timeouts.

+
+retries
+ + +HTTPRetry + + +		 +(Optional) +

Retry policy for HTTP requests.

+

NOTE: This differs from K8s Ingress which doesn’t allow retry settings.

+
+

HTTPIngressRuleValue +

+

+(Appears on: +IngressRule) +

+

+

HTTPIngressRuleValue is a list of http selectors pointing to backends. +In the example: http:///? -> backend where +where parts of the url correspond to RFC 3986, this resource will be used +to match against everything after the last ‘/’ and before the first ‘?’ +or ‘#’.

+

+ + + + + + + + + + + + + +
FieldDescription
+paths
+ + +[]HTTPIngressPath + + +		 +

A collection of paths that map requests to backends.

+

If they are multiple matching paths, the first match takes precendent.

+
+

HTTPRetry +

+

+(Appears on: +HTTPIngressPath) +

+

+

HTTPRetry describes the retry policy to use when a HTTP request fails.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+attempts
+ +int + +		 +

Number of retries for a given request.

+
+perTryTimeout
+ + +Kubernetes meta/v1.Duration + + +		 +

Timeout per retry attempt for a given request. format: 1h/1m/1s/1ms. MUST BE >=1ms.

+
+

IngressBackend +

+

+(Appears on: +IngressBackendSplit) +

+

+

IngressBackend describes all endpoints for a given service and port.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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.

+
+

IngressBackendSplit +

+

+(Appears on: +HTTPIngressPath) +

+

+

IngressBackendSplit describes all endpoints for a given service and port.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+IngressBackend
+ + +IngressBackend + + +		 +

+(Members of IngressBackend are embedded into this type.) +

+

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
+ +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.

+
+

IngressRule +

+

+(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.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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 : delimiter is not respected because ports are not allowed. +Currently the port of an Ingress is implicitly :80 for http and +:443 for https. +Both these may change in the future. +If the host is unspecified, the Ingress routes all traffic based on the +specified IngressRuleValue. +If multiple matching Hosts were provided, the first rule will take precedent.

+
+visibility
+ + +IngressVisibility + + +		 +(Optional) +

Visibility signifies whether this rule should ClusterLocal. If it’s not +specified then it defaults to ExternalIP.

+
+http
+ + +HTTPIngressRuleValue + + +		 +

HTTP represents a rule to apply against incoming requests. If the +rule is satisfied, the request is routed to the specified backend.

+
+

IngressSpec +

+

+(Appears on: +Ingress) +

+

+

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.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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

+
+tls
+ + +[]IngressTLS + + +		 +(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.

+
+rules
+ + +[]IngressRule + + +		 +(Optional) +

A list of host rules used to configure the Ingress.

+
+visibility
+ + +IngressVisibility + + +		 +

Visibility setting.

+
+

IngressStatus +

+

+(Appears on: +Ingress) +

+

+

IngressStatus describe the current state of the Ingress.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+
+loadBalancer
+ + +LoadBalancerStatus + + +		 +(Optional) +

LoadBalancer contains the current status of the load-balancer. +This is to be superseded by the combination of PublicLoadBalancer and PrivateLoadBalancer

+
+publicLoadBalancer
+ + +LoadBalancerStatus + + +		 +(Optional) +

PublicLoadBalancer contains the current status of the load-balancer.

+
+privateLoadBalancer
+ + +LoadBalancerStatus + + +		 +(Optional) +

PrivateLoadBalancer contains the current status of the load-balancer.

+
+

IngressTLS +

+

+(Appears on: +IngressSpec) +

+

+

IngressTLS describes the transport layer security associated with an Ingress.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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
+ +string + +		 +(Optional) +

ServerCertificate identifies the certificate filename in the secret. +Defaults to tls.crt.

+
+privateKey
+ +string + +		 +(Optional) +

PrivateKey identifies the private key filename in the secret. +Defaults to tls.key.

+
+

IngressVisibility +(string alias)

+

+(Appears on: +IngressRule, +IngressSpec) +

+

+

IngressVisibility describes whether the Ingress should be exposed to +public gateways or not.

+

+

LoadBalancerIngressStatus +

+

+(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.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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.

+
+

LoadBalancerStatus +

+

+(Appears on: +IngressStatus) +

+

+

LoadBalancerStatus represents the status of a load-balancer.

+

+ + + + + + + + + + + + + +
FieldDescription
+ingress
+ + +[]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.

+
+

ServerlessServiceOperationMode +(string alias)

+

+(Appears on: +ServerlessServiceSpec) +

+

+

ServerlessServiceOperationMode is an enumeration of the modes of operation +for the ServerlessService.

+

+

ServerlessServiceSpec +

+

+(Appears on: +ServerlessService) +

+

+

ServerlessServiceSpec describes the ServerlessService.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+mode
+ + +ServerlessServiceOperationMode + + +		 +

Mode describes the mode of operation of the ServerlessService.

+
+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 RevisionProtocolType set on the owning pa/revision. +serving imports networking, so just use string.

+
+numActivators
+ +int32 + +		 +

NumActivators contains number of Activators that this revision should be +assigned. +O means — assign all.

+
+

ServerlessServiceStatus +

+

+(Appears on: +ServerlessService) +

+

+

ServerlessServiceStatus describes the current state of the ServerlessService.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+
+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.

+
+
+

serving.knative.dev/v1

+

+

+Resource Types: + +

Configuration +

+

+

Configuration represents the “floating HEAD” of a linear history of Revisions. +Users create new Revisions by updating the Configuration’s spec. +The “latest created” revision’s name is available under status, as is the +“latest ready” revision’s name. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +serving.knative.dev/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) +
+
+ + + + + +
+template
+ + +RevisionTemplateSpec + + +		 +(Optional) +

Template holds the latest specification for the Revision to be stamped out.

+
+
+status
+ + +ConfigurationStatus + + +		 +(Optional) +
+

Revision +

+

+

Revision is an immutable snapshot of code and configuration. A revision +references a container image. Revisions are created by updates to a +Configuration.

+

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +serving.knative.dev/v1 + +
+kind
+string +		Revision
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +RevisionSpec + + +		 +(Optional) +
+
+ + + + + + + + + + + + + +
+PodSpec
+ + +Kubernetes core/v1.PodSpec + + +		 +

+(Members of PodSpec are embedded into this type.) +

+
+containerConcurrency
+ +int64 + +		 +(Optional) +

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) +requests per container of the Revision. Defaults to 0 which means +concurrency to the application is not limited, and the system decides the +target concurrency for the autoscaler.

+
+timeoutSeconds
+ +int64 + +		 +(Optional) +

TimeoutSeconds holds the max duration the instance is allowed for +responding to a request. If unspecified, a system default will +be provided.

+
+
+status
+ + +RevisionStatus + + +		 +(Optional) +
+

Route +

+

+

Route is responsible for configuring ingress over a collection of Revisions. +Some of the Revisions a Route distributes traffic over may be specified by +referencing the Configuration responsible for creating them; in these cases +the Route is additionally responsible for monitoring the Configuration for +“latest ready revision” changes, and smoothly rolling out latest revisions. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +serving.knative.dev/v1 + +
+kind
+string +		Route
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +RouteSpec + + +		 +(Optional) +

Spec holds the desired state of the Route (from the client).

+
+
+ + + + + +
+traffic
+ + +[]TrafficTarget + + +		 +(Optional) +

Traffic specifies how to distribute traffic over a collection of +revisions and configurations.

+
+
+status
+ + +RouteStatus + + +		 +(Optional) +

Status communicates the observed state of the Route (from the controller).

+
+

Service +

+

+

Service acts as a top-level container that manages a Route and Configuration +which implement a network service. Service exists to provide a singular +abstraction which can be access controlled, reasoned about, and which +encapsulates software lifecycle decisions such as rollout policy and +team resource ownership. Service acts only as an orchestrator of the +underlying Routes and Configurations (much as a kubernetes Deployment +orchestrates ReplicaSets), and its usage is optional but recommended.

+

The Service’s controller will track the statuses of its owned Configuration +and Route, reflecting their statuses and conditions as its own.

+

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +serving.knative.dev/v1 + +
+kind
+string +		Service
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ServiceSpec + + +		 +(Optional) +
+
+ + + + + + + + + +
+ConfigurationSpec
+ + +ConfigurationSpec + + +		 +

+(Members of ConfigurationSpec are embedded into this type.) +

+

ServiceSpec inlines an unrestricted ConfigurationSpec.

+
+RouteSpec
+ + +RouteSpec + + +		 +

+(Members of RouteSpec are embedded into this type.) +

+

ServiceSpec inlines RouteSpec and restricts/defaults its fields +via webhook. In particular, this spec can only reference this +Service’s configuration and revisions (which also influences +defaults).

+
+
+status
+ + +ServiceStatus + + +		 +(Optional) +
+

ConfigurationSpec +

+

+(Appears on: +Configuration, +Configuration, +ServiceSpec) +

+

+

ConfigurationSpec holds the desired state of the Configuration (from the client).

+

+ + + + + + + + + + + + + +
FieldDescription
+template
+ + +RevisionTemplateSpec + + +		 +(Optional) +

Template holds the latest specification for the Revision to be stamped out.

+
+

ConfigurationStatus +

+

+(Appears on: +Configuration, +Configuration) +

+

+

ConfigurationStatus communicates the observed state of the Configuration (from the controller).

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+
+ConfigurationStatusFields
+ + +ConfigurationStatusFields + + +		 +

+(Members of ConfigurationStatusFields are embedded into this type.) +

+
+

ConfigurationStatusFields +

+

+(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.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+latestReadyRevisionName
+ +string + +		 +(Optional) +

LatestReadyRevisionName holds the name of the latest Revision stamped out +from this Configuration that has had its “Ready” condition become “True”.

+
+latestCreatedRevisionName
+ +string + +		 +(Optional) +

LatestCreatedRevisionName is the last revision that was created from this +Configuration. It might not be ready yet, for that use LatestReadyRevisionName.

+
+

RevisionSpec +

+

+(Appears on: +Revision, +Revision, +RevisionSpec, +RevisionTemplateSpec) +

+

+

RevisionSpec holds the desired state of the Revision (from the client).

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+PodSpec
+ + +Kubernetes core/v1.PodSpec + + +		 +

+(Members of PodSpec are embedded into this type.) +

+
+containerConcurrency
+ +int64 + +		 +(Optional) +

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) +requests per container of the Revision. Defaults to 0 which means +concurrency to the application is not limited, and the system decides the +target concurrency for the autoscaler.

+
+timeoutSeconds
+ +int64 + +		 +(Optional) +

TimeoutSeconds holds the max duration the instance is allowed for +responding to a request. If unspecified, a system default will +be provided.

+
+

RevisionStatus +

+

+(Appears on: +Revision, +Revision) +

+

+

RevisionStatus communicates the observed state of the Revision (from the controller).

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+
+serviceName
+ +string + +		 +(Optional) +

ServiceName holds the name of a core Kubernetes Service resource that +load balances over the pods backing this Revision.

+
+logUrl
+ +string + +		 +(Optional) +

LogURL specifies the generated logging url for this particular revision +based on the revision url template specified in the controller’s config.

+
+imageDigest
+ +string + +		 +(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.

+
+

RevisionTemplateSpec +

+

+(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

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +RevisionSpec + + +		 +(Optional) +
+
+ + + + + + + + + + + + + +
+PodSpec
+ + +Kubernetes core/v1.PodSpec + + +		 +

+(Members of PodSpec are embedded into this type.) +

+
+containerConcurrency
+ +int64 + +		 +(Optional) +

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) +requests per container of the Revision. Defaults to 0 which means +concurrency to the application is not limited, and the system decides the +target concurrency for the autoscaler.

+
+timeoutSeconds
+ +int64 + +		 +(Optional) +

TimeoutSeconds holds the max duration the instance is allowed for +responding to a request. If unspecified, a system default will +be provided.

+
+
+

RouteSpec +

+

+(Appears on: +Route, +Route, +ServiceSpec) +

+

+

RouteSpec holds the desired state of the Route (from the client).

+

+ + + + + + + + + + + + + +
FieldDescription
+traffic
+ + +[]TrafficTarget + + +		 +(Optional) +

Traffic specifies how to distribute traffic over a collection of +revisions and configurations.

+
+

RouteStatus +

+

+(Appears on: +Route, +Route) +

+

+

RouteStatus communicates the observed state of the Route (from the controller).

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+
+RouteStatusFields
+ + +RouteStatusFields + + +		 +

+(Members of RouteStatusFields are embedded into this type.) +

+
+

RouteStatusFields +

+

+(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.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+url
+ +knative.dev/pkg/apis.URL + +		 +(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}

+
+address
+ +knative.dev/pkg/apis/duck/v1.Addressable + +		 +(Optional) +

Address holds the information needed for a Route to be the target of an event.

+
+traffic
+ + +[]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.

+
+

ServiceSpec +

+

+(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.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+ConfigurationSpec
+ + +ConfigurationSpec + + +		 +

+(Members of ConfigurationSpec are embedded into this type.) +

+

ServiceSpec inlines an unrestricted ConfigurationSpec.

+
+RouteSpec
+ + +RouteSpec + + +		 +

+(Members of RouteSpec are embedded into this type.) +

+

ServiceSpec inlines RouteSpec and restricts/defaults its fields +via webhook. In particular, this spec can only reference this +Service’s configuration and revisions (which also influences +defaults).

+
+

ServiceStatus +

+

+(Appears on: +Service, +Service) +

+

+

ServiceStatus represents the Status stanza of the Service resource.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

+(Members of Status are embedded into this type.) +

+
+ConfigurationStatusFields
+ + +ConfigurationStatusFields + + +		 +

+(Members of ConfigurationStatusFields are embedded into this type.) +

+

In addition to inlining ConfigurationSpec, we also inline the fields +specific to ConfigurationStatus.

+
+RouteStatusFields
+ + +RouteStatusFields + + +		 +

+(Members of RouteStatusFields are embedded into this type.) +

+

In addition to inlining RouteSpec, we also inline the fields +specific to RouteStatus.

+
+

TrafficTarget +

+

+(Appears on: +RouteSpec, +RouteStatusFields, +TrafficTarget) +

+

+

TrafficTarget holds a single entry of the routing table for a Route.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+tag
+ +string + +		 +(Optional) +

Tag is optionally used to expose a dedicated url for referencing +this target exclusively.

+
+revisionName
+ +string + +		 +(Optional) +

RevisionName of a specific revision to which to send this portion of +traffic. This is mutually exclusive with ConfigurationName.

+
+configurationName
+ +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.

+
+latestRevision
+ +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.

+
+percent
+ +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. 0 (zero) mean no traffic, 100 means all +traffic. +When percentage based routing is being used the follow rules apply: +- the sum of all percent values must equal 100 +- when not specified, the implied value for percent is zero for +that particular Revision or Configuration

+
+url
+ +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.)

+
+

serving.knative.dev/v1alpha1

@@ -2334,3325 +5678,7 @@ ServiceStatus
-

autoscaling.internal.knative.dev/v1alpha1

-

-

-Resource Types: - -

PodAutoscaler -

-

-

PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative -components instantiate autoscalers. This definition is an abstraction that may be backed -by multiple definitions. For more information, see the Knative Pluggability presentation: -https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -autoscaling.internal.knative.dev/v1alpha1 - -
-kind
-string -		PodAutoscaler
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -PodAutoscalerSpec - - -		 -(Optional) -

Spec holds the desired state of the PodAutoscaler (from the client).

-
-
- - - - - - - - - - - - - - - - - - - - - -
-generation
- -int64 - -		 -(Optional) -

DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server

-

This property will be dropped in future Knative releases and should -not be used - use metadata.generation

-

Tracking issue: https://github.com/knative/serving/issues/643

-
-containerConcurrency
- -int64 - -		 -(Optional) -

ContainerConcurrency specifies the maximum allowed -in-flight (concurrent) requests per container of the Revision. -Defaults to 0 which means unlimited concurrency.

-
-scaleTargetRef
- - -Kubernetes core/v1.ObjectReference - - -		 -

ScaleTargetRef defines the /scale-able resource that this PodAutoscaler -is responsible for quickly right-sizing.

-
-reachability
- - -ReachabilityType - - -		 -(Optional) -

Reachable specifies whether or not the ScaleTargetRef can be reached (ie. has a route). -Defaults to ReachabilityUnknown

-
-protocolType
- -knative.dev/serving/pkg/apis/networking.ProtocolType - -		 -

The application-layer protocol. Matches ProtocolType inferred from the revision spec.

-
-
-status
- - -PodAutoscalerStatus - - -		 -(Optional) -

Status communicates the observed state of the PodAutoscaler (from the controller).

-
-

Metric -

-

-

Metric represents a resource to configure the metric collector with.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -MetricSpec - - -		 -(Optional) -

Spec holds the desired state of the Metric (from the client).

-
-
- - - - - - - - - - - - - -
-stableWindow
- -time.Duration - -		 -

StableWindow is the aggregation window for metrics in a stable state.

-
-panicWindow
- -time.Duration - -		 -

PanicWindow is the aggregation window for metrics where quick reactions are needed.

-
-scrapeTarget
- -string - -		 -

ScrapeTarget is the K8s service that publishes the metric endpoint.

-
-
-status
- - -MetricStatus - - -		 -(Optional) -

Status communicates the observed state of the Metric (from the controller).

-
-

MetricSpec -

-

-(Appears on: -Metric) -

-

-

MetricSpec contains all values a metric collector needs to operate.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-stableWindow
- -time.Duration - -		 -

StableWindow is the aggregation window for metrics in a stable state.

-
-panicWindow
- -time.Duration - -		 -

PanicWindow is the aggregation window for metrics where quick reactions are needed.

-
-scrapeTarget
- -string - -		 -

ScrapeTarget is the K8s service that publishes the metric endpoint.

-
-

MetricStatus -

-

-(Appears on: -Metric) -

-

-

MetricStatus reflects the status of metric collection for this specific entity.

-

- - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-
-

PodAutoscalerSpec -

-

-(Appears on: -PodAutoscaler) -

-

-

PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-generation
- -int64 - -		 -(Optional) -

DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server

-

This property will be dropped in future Knative releases and should -not be used - use metadata.generation

-

Tracking issue: https://github.com/knative/serving/issues/643

-
-containerConcurrency
- -int64 - -		 -(Optional) -

ContainerConcurrency specifies the maximum allowed -in-flight (concurrent) requests per container of the Revision. -Defaults to 0 which means unlimited concurrency.

-
-scaleTargetRef
- - -Kubernetes core/v1.ObjectReference - - -		 -

ScaleTargetRef defines the /scale-able resource that this PodAutoscaler -is responsible for quickly right-sizing.

-
-reachability
- - -ReachabilityType - - -		 -(Optional) -

Reachable specifies whether or not the ScaleTargetRef can be reached (ie. has a route). -Defaults to ReachabilityUnknown

-
-protocolType
- -knative.dev/serving/pkg/apis/networking.ProtocolType - -		 -

The application-layer protocol. Matches ProtocolType inferred from the revision spec.

-
-

PodAutoscalerStatus -

-

-(Appears on: -PodAutoscaler) -

-

-

PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-
-serviceName
- -string - -		 -

ServiceName is the K8s Service name that serves the revision, scaled by this PA. -The service is created and owned by the ServerlessService object owned by this PA.

-
-metricsServiceName
- -string - -		 -

MetricsServiceName is the K8s Service name that provides revision metrics. -The service is managed by the PA object.

-
-desiredScale
- -int32 - -		 -

DesiredScale shows the current desired number of replicas for the revision.

-
-actualScale
- -int32 - -		 -

ActualScale shows the actual number of replicas for the revision.

-
-

PodScalable -

-

-

PodScalable is a duck type that the resources referenced by the -PodAutoscaler’s ScaleTargetRef must implement. They must also -implement the /scale sub-resource for use with /scale based -implementations (e.g. HPA), but this further constrains the shape -the referenced resources may take.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -PodScalableSpec - - -		 -
-
- - - - - - - - - - - - - -
-replicas
- -int32 - -		 -
-selector
- - -Kubernetes meta/v1.LabelSelector - - -		 -
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 -
-
-status
- - -PodScalableStatus - - -		 -
-

PodScalableSpec -

-

-(Appears on: -PodScalable) -

-

-

PodScalableSpec is the specification for the desired state of a -PodScalable (or at least our shared portion).

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-replicas
- -int32 - -		 -
-selector
- - -Kubernetes meta/v1.LabelSelector - - -		 -
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 -
-

PodScalableStatus -

-

-(Appears on: -PodScalable) -

-

-

PodScalableStatus is the observed state of a PodScalable (or at -least our shared portion).

-

- - - - - - - - - - - - - -
FieldDescription
-replicas
- -int32 - -		 -
-

ReachabilityType -(string alias)

-

-(Appears on: -PodAutoscalerSpec) -

-

-

ReachabilityType is the enumeration type for the different states of reachability -to the ScaleTarget of a PodAutoscaler

-

-
-

networking.internal.knative.dev/v1alpha1

-

-

-Resource Types: - -

Certificate -

-

-

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).

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -networking.internal.knative.dev/v1alpha1 - -
-kind
-string -		Certificate
-metadata
- - -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 the -metadata field. -
-spec
- - -CertificateSpec - - -		 -(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

-
-
- - - - - - - - - -
-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.

-
-secretName
- -string - -		 -

SecretName is the name of the secret resource to store the SSL certificate in.

-
-
-status
- - -CertificateStatus - - -		 -(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

-
-

Ingress -

-

-

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.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -networking.internal.knative.dev/v1alpha1 - -
-kind
-string -		Ingress
-metadata
- - -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 the -metadata field. -
-spec
- - -IngressSpec - - -		 -(Optional) -

Spec is the desired state of the Ingress. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

-
-
- - - - - - - - - - - - - - - - - -
-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

-
-tls
- - -[]IngressTLS - - -		 -(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.

-
-rules
- - -[]IngressRule - - -		 -(Optional) -

A list of host rules used to configure the Ingress.

-
-visibility
- - -IngressVisibility - - -		 -

Visibility setting.

-
-
-status
- - -IngressStatus - - -		 -(Optional) -

Status is the current state of the Ingress. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

-
-

ServerlessService -

-

-

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.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -networking.internal.knative.dev/v1alpha1 - -
-kind
-string -		ServerlessService
-metadata
- - -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 the -metadata field. -
-spec
- - -ServerlessServiceSpec - - -		 -(Optional) -

Spec is the desired state of the ServerlessService. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

-
-
- - - - - - - - - - - - - -
-mode
- - -ServerlessServiceOperationMode - - -		 -

Mode describes the mode of operation of the ServerlessService.

-
-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 RevisionProtocolType set on the owning pa/revision. -serving imports networking, so just use string.

-
-
-status
- - -ServerlessServiceStatus - - -		 -(Optional) -

Status is the current state of the ServerlessService. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

-
-

CertificateSpec -

-

-(Appears on: -Certificate) -

-

-

CertificateSpec defines the desired state of a Certificate.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-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.

-
-secretName
- -string - -		 -

SecretName is the name of the secret resource to store the SSL certificate in.

-
-

CertificateStatus -

-

-(Appears on: -Certificate) -

-

-

CertificateStatus defines the observed state of a Certificate.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-

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
- - -Kubernetes meta/v1.Time - - -		 -(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..

-
-

HTTP01Challenge -

-

-(Appears on: -CertificateStatus) -

-

-

HTTP01Challenge defines the status of a HTTP01 challenge that a certificate needs -to fulfill.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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.

-
-

HTTPIngressPath -

-

-(Appears on: -HTTPIngressRuleValue) -

-

-

HTTPIngressPath associates a path regex with a backend. Incoming URLs matching -the path are forwarded to the backend.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-path
- -string - -		 -(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.

-
-splits
- - -[]IngressBackendSplit - - -		 -

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.

-
-timeout
- - -Kubernetes meta/v1.Duration - - -		 -(Optional) -

Timeout for HTTP requests.

-

NOTE: This differs from K8s Ingress which doesn’t allow setting timeouts.

-
-retries
- - -HTTPRetry - - -		 -(Optional) -

Retry policy for HTTP requests.

-

NOTE: This differs from K8s Ingress which doesn’t allow retry settings.

-
-

HTTPIngressRuleValue -

-

-(Appears on: -IngressRule) -

-

-

HTTPIngressRuleValue is a list of http selectors pointing to backends. -In the example: http:///? -> backend where -where parts of the url correspond to RFC 3986, this resource will be used -to match against everything after the last ‘/’ and before the first ‘?’ -or ‘#’.

-

- - - - - - - - - - - - - -
FieldDescription
-paths
- - -[]HTTPIngressPath - - -		 -

A collection of paths that map requests to backends.

-

If they are multiple matching paths, the first match takes precendent.

-
-

HTTPRetry -

-

-(Appears on: -HTTPIngressPath) -

-

-

HTTPRetry describes the retry policy to use when a HTTP request fails.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-attempts
- -int - -		 -

Number of retries for a given request.

-
-perTryTimeout
- - -Kubernetes meta/v1.Duration - - -		 -

Timeout per retry attempt for a given request. format: 1h/1m/1s/1ms. MUST BE >=1ms.

-
-

IngressBackend -

-

-(Appears on: -IngressBackendSplit) -

-

-

IngressBackend describes all endpoints for a given service and port.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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.

-
-

IngressBackendSplit -

-

-(Appears on: -HTTPIngressPath) -

-

-

IngressBackendSplit describes all endpoints for a given service and port.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-IngressBackend
- - -IngressBackend - - -		 -

-(Members of IngressBackend are embedded into this type.) -

-

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
- -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.

-
-

IngressRule -

-

-(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.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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 : delimiter is not respected because ports are not allowed. -Currently the port of an Ingress is implicitly :80 for http and -:443 for https. -Both these may change in the future. -If the host is unspecified, the Ingress routes all traffic based on the -specified IngressRuleValue. -If multiple matching Hosts were provided, the first rule will take precedent.

-
-visibility
- - -IngressVisibility - - -		 -(Optional) -

Visibility signifies whether this rule should ClusterLocal. If it’s not -specified then it defaults to ExternalIP.

-
-http
- - -HTTPIngressRuleValue - - -		 -

HTTP represents a rule to apply against incoming requests. If the -rule is satisfied, the request is routed to the specified backend.

-
-

IngressSpec -

-

-(Appears on: -Ingress) -

-

-

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.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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

-
-tls
- - -[]IngressTLS - - -		 -(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.

-
-rules
- - -[]IngressRule - - -		 -(Optional) -

A list of host rules used to configure the Ingress.

-
-visibility
- - -IngressVisibility - - -		 -

Visibility setting.

-
-

IngressStatus -

-

-(Appears on: -Ingress) -

-

-

IngressStatus describe the current state of the Ingress.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-
-loadBalancer
- - -LoadBalancerStatus - - -		 -(Optional) -

LoadBalancer contains the current status of the load-balancer. -This is to be superseded by the combination of PublicLoadBalancer and PrivateLoadBalancer

-
-publicLoadBalancer
- - -LoadBalancerStatus - - -		 -(Optional) -

PublicLoadBalancer contains the current status of the load-balancer.

-
-privateLoadBalancer
- - -LoadBalancerStatus - - -		 -(Optional) -

PrivateLoadBalancer contains the current status of the load-balancer.

-
-

IngressTLS -

-

-(Appears on: -IngressSpec) -

-

-

IngressTLS describes the transport layer security associated with an Ingress.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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
- -string - -		 -(Optional) -

ServerCertificate identifies the certificate filename in the secret. -Defaults to tls.crt.

-
-privateKey
- -string - -		 -(Optional) -

PrivateKey identifies the private key filename in the secret. -Defaults to tls.key.

-
-

IngressVisibility -(string alias)

-

-(Appears on: -IngressRule, -IngressSpec) -

-

-

IngressVisibility describes whether the Ingress should be exposed to -public gateways or not.

-

-

LoadBalancerIngressStatus -

-

-(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.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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.

-
-

LoadBalancerStatus -

-

-(Appears on: -IngressStatus) -

-

-

LoadBalancerStatus represents the status of a load-balancer.

-

- - - - - - - - - - - - - -
FieldDescription
-ingress
- - -[]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.

-
-

ServerlessServiceOperationMode -(string alias)

-

-(Appears on: -ServerlessServiceSpec) -

-

-

ServerlessServiceOperationMode is an enumeration of the modes of operation -for the ServerlessService.

-

-

ServerlessServiceSpec -

-

-(Appears on: -ServerlessService) -

-

-

ServerlessServiceSpec describes the ServerlessService.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-mode
- - -ServerlessServiceOperationMode - - -		 -

Mode describes the mode of operation of the ServerlessService.

-
-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 RevisionProtocolType set on the owning pa/revision. -serving imports networking, so just use string.

-
-

ServerlessServiceStatus -

-

-(Appears on: -ServerlessService) -

-

-

ServerlessServiceStatus describes the current state of the ServerlessService.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-
-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.

-
-
-

serving.knative.dev/v1

-

-

-Resource Types: - -

Configuration -

-

-

Configuration represents the “floating HEAD” of a linear history of Revisions. -Users create new Revisions by updating the Configuration’s spec. -The “latest created” revision’s name is available under status, as is the -“latest ready” revision’s name. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/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) -
-
- - - - - -
-template
- - -RevisionTemplateSpec - - -		 -(Optional) -

Template holds the latest specification for the Revision to be stamped out.

-
-
-status
- - -ConfigurationStatus - - -		 -(Optional) -
-

Revision -

-

-

Revision is an immutable snapshot of code and configuration. A revision -references a container image. Revisions are created by updates to a -Configuration.

-

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1 - -
-kind
-string -		Revision
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -RevisionSpec - - -		 -(Optional) -
-
- - - - - - - - - - - - - -
-PodSpec
- - -Kubernetes core/v1.PodSpec - - -		 -

-(Members of PodSpec are embedded into this type.) -

-
-containerConcurrency
- -int64 - -		 -(Optional) -

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) -requests per container of the Revision. Defaults to 0 which means -concurrency to the application is not limited, and the system decides the -target concurrency for the autoscaler.

-
-timeoutSeconds
- -int64 - -		 -(Optional) -

TimeoutSeconds holds the max duration the instance is allowed for -responding to a request. If unspecified, a system default will -be provided.

-
-
-status
- - -RevisionStatus - - -		 -(Optional) -
-

Route -

-

-

Route is responsible for configuring ingress over a collection of Revisions. -Some of the Revisions a Route distributes traffic over may be specified by -referencing the Configuration responsible for creating them; in these cases -the Route is additionally responsible for monitoring the Configuration for -“latest ready revision” changes, and smoothly rolling out latest revisions. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1 - -
-kind
-string -		Route
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -RouteSpec - - -		 -(Optional) -

Spec holds the desired state of the Route (from the client).

-
-
- - - - - -
-traffic
- - -[]TrafficTarget - - -		 -(Optional) -

Traffic specifies how to distribute traffic over a collection of -revisions and configurations.

-
-
-status
- - -RouteStatus - - -		 -(Optional) -

Status communicates the observed state of the Route (from the controller).

-
-

Service -

-

-

Service acts as a top-level container that manages a Route and Configuration -which implement a network service. Service exists to provide a singular -abstraction which can be access controlled, reasoned about, and which -encapsulates software lifecycle decisions such as rollout policy and -team resource ownership. Service acts only as an orchestrator of the -underlying Routes and Configurations (much as a kubernetes Deployment -orchestrates ReplicaSets), and its usage is optional but recommended.

-

The Service’s controller will track the statuses of its owned Configuration -and Route, reflecting their statuses and conditions as its own.

-

See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1 - -
-kind
-string -		Service
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ServiceSpec - - -		 -(Optional) -
-
- - - - - - - - - -
-ConfigurationSpec
- - -ConfigurationSpec - - -		 -

-(Members of ConfigurationSpec are embedded into this type.) -

-

ServiceSpec inlines an unrestricted ConfigurationSpec.

-
-RouteSpec
- - -RouteSpec - - -		 -

-(Members of RouteSpec are embedded into this type.) -

-

ServiceSpec inlines RouteSpec and restricts/defaults its fields -via webhook. In particular, this spec can only reference this -Service’s configuration and revisions (which also influences -defaults).

-
-
-status
- - -ServiceStatus - - -		 -(Optional) -
-

ConfigurationSpec -

-

-(Appears on: -Configuration, -Configuration, -ServiceSpec) -

-

-

ConfigurationSpec holds the desired state of the Configuration (from the client).

-

- - - - - - - - - - - - - -
FieldDescription
-template
- - -RevisionTemplateSpec - - -		 -(Optional) -

Template holds the latest specification for the Revision to be stamped out.

-
-

ConfigurationStatus -

-

-(Appears on: -Configuration, -Configuration) -

-

-

ConfigurationStatus communicates the observed state of the Configuration (from the controller).

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-
-ConfigurationStatusFields
- - -ConfigurationStatusFields - - -		 -

-(Members of ConfigurationStatusFields are embedded into this type.) -

-
-

ConfigurationStatusFields -

-

-(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.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-latestReadyRevisionName
- -string - -		 -(Optional) -

LatestReadyRevisionName holds the name of the latest Revision stamped out -from this Configuration that has had its “Ready” condition become “True”.

-
-latestCreatedRevisionName
- -string - -		 -(Optional) -

LatestCreatedRevisionName is the last revision that was created from this -Configuration. It might not be ready yet, for that use LatestReadyRevisionName.

-
-

RevisionSpec -

-

-(Appears on: -Revision, -Revision, -RevisionSpec, -RevisionTemplateSpec) -

-

-

RevisionSpec holds the desired state of the Revision (from the client).

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-PodSpec
- - -Kubernetes core/v1.PodSpec - - -		 -

-(Members of PodSpec are embedded into this type.) -

-
-containerConcurrency
- -int64 - -		 -(Optional) -

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) -requests per container of the Revision. Defaults to 0 which means -concurrency to the application is not limited, and the system decides the -target concurrency for the autoscaler.

-
-timeoutSeconds
- -int64 - -		 -(Optional) -

TimeoutSeconds holds the max duration the instance is allowed for -responding to a request. If unspecified, a system default will -be provided.

-
-

RevisionStatus -

-

-(Appears on: -Revision, -Revision) -

-

-

RevisionStatus communicates the observed state of the Revision (from the controller).

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-
-serviceName
- -string - -		 -(Optional) -

ServiceName holds the name of a core Kubernetes Service resource that -load balances over the pods backing this Revision.

-
-logUrl
- -string - -		 -(Optional) -

LogURL specifies the generated logging url for this particular revision -based on the revision url template specified in the controller’s config.

-
-imageDigest
- -string - -		 -(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.

-
-

RevisionTemplateSpec -

-

-(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

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -RevisionSpec - - -		 -(Optional) -
-
- - - - - - - - - - - - - -
-PodSpec
- - -Kubernetes core/v1.PodSpec - - -		 -

-(Members of PodSpec are embedded into this type.) -

-
-containerConcurrency
- -int64 - -		 -(Optional) -

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) -requests per container of the Revision. Defaults to 0 which means -concurrency to the application is not limited, and the system decides the -target concurrency for the autoscaler.

-
-timeoutSeconds
- -int64 - -		 -(Optional) -

TimeoutSeconds holds the max duration the instance is allowed for -responding to a request. If unspecified, a system default will -be provided.

-
-
-

RouteSpec -

-

-(Appears on: -Route, -Route, -ServiceSpec) -

-

-

RouteSpec holds the desired state of the Route (from the client).

-

- - - - - - - - - - - - - -
FieldDescription
-traffic
- - -[]TrafficTarget - - -		 -(Optional) -

Traffic specifies how to distribute traffic over a collection of -revisions and configurations.

-
-

RouteStatus -

-

-(Appears on: -Route, -Route) -

-

-

RouteStatus communicates the observed state of the Route (from the controller).

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-
-RouteStatusFields
- - -RouteStatusFields - - -		 -

-(Members of RouteStatusFields are embedded into this type.) -

-
-

RouteStatusFields -

-

-(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.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-url
- -knative.dev/pkg/apis.URL - -		 -(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}

-
-address
- -knative.dev/pkg/apis/duck/v1.Addressable - -		 -(Optional) -

Address holds the information needed for a Route to be the target of an event.

-
-traffic
- - -[]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.

-
-

ServiceSpec -

-

-(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.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-ConfigurationSpec
- - -ConfigurationSpec - - -		 -

-(Members of ConfigurationSpec are embedded into this type.) -

-

ServiceSpec inlines an unrestricted ConfigurationSpec.

-
-RouteSpec
- - -RouteSpec - - -		 -

-(Members of RouteSpec are embedded into this type.) -

-

ServiceSpec inlines RouteSpec and restricts/defaults its fields -via webhook. In particular, this spec can only reference this -Service’s configuration and revisions (which also influences -defaults).

-
-

ServiceStatus -

-

-(Appears on: -Service, -Service) -

-

-

ServiceStatus represents the Status stanza of the Service resource.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- -knative.dev/pkg/apis/duck/v1.Status - -		 -

-(Members of Status are embedded into this type.) -

-
-ConfigurationStatusFields
- - -ConfigurationStatusFields - - -		 -

-(Members of ConfigurationStatusFields are embedded into this type.) -

-

In addition to inlining ConfigurationSpec, we also inline the fields -specific to ConfigurationStatus.

-
-RouteStatusFields
- - -RouteStatusFields - - -		 -

-(Members of RouteStatusFields are embedded into this type.) -

-

In addition to inlining RouteSpec, we also inline the fields -specific to RouteStatus.

-
-

TrafficTarget -

-

-(Appears on: -RouteSpec, -RouteStatusFields, -TrafficTarget) -

-

-

TrafficTarget holds a single entry of the routing table for a Route.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-tag
- -string - -		 -(Optional) -

Tag is optionally used to expose a dedicated url for referencing -this target exclusively.

-
-revisionName
- -string - -		 -(Optional) -

RevisionName of a specific revision to which to send this portion of -traffic. This is mutually exclusive with ConfigurationName.

-
-configurationName
- -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.

-
-latestRevision
- -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.

-
-percent
- -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. 0 (zero) mean no traffic, 100 means all -traffic. -When percentage based routing is being used the follow rules apply: -- the sum of all percent values must equal 100 -- when not specified, the implied value for percent is zero for -that particular Revision or Configuration

-
-url
- -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.)

-
-

Generated with gen-crd-api-reference-docs -on git commit 804b3bb85. +on git commit f87352b72.