From e5f19841046e34ab50cdb3d7c0d48b03f75cf4d7 Mon Sep 17 00:00:00 2001 From: ellenevans <35748459+ellenevans@users.noreply.github.com> Date: Wed, 8 Jul 2020 12:25:07 -0700 Subject: [PATCH] updated api docs for v0.16.0 (#2656) * updated api docs for v0.16.0 * Update docs/reference/serving.md Co-authored-by: Matt Moore Co-authored-by: Matt Moore --- docs/reference/eventing/eventing-contrib.md | 21781 +----------------- docs/reference/eventing/eventing.md | 6749 +++--- docs/reference/serving.md | 1707 +- 3 files changed, 4634 insertions(+), 25603 deletions(-) diff --git a/docs/reference/eventing/eventing-contrib.md b/docs/reference/eventing/eventing-contrib.md index 6df3c39047..a39fe315f2 100644 --- a/docs/reference/eventing/eventing-contrib.md +++ b/docs/reference/eventing/eventing-contrib.md @@ -1,142 +1,46 @@

Packages:

-

duck.knative.dev/v1beta1

+

sources.knative.dev/v1alpha1

-

Package v1beta1 is the v1beta1 version of the API.

+

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

Resource Types: - -

AddressStatus -

-

-(Appears on: -AddressableType) -

-

-

AddressStatus shows how we expect folks to embed Addressable in -their Status field.

-

- - - - - - - - - - - - - -
FieldDescription
-address
- - -Addressable - - -		 -
-

Addressable -

-

-(Appears on: -AddressStatus, -Addressable) -

-

-

Addressable provides a generic mechanism for a custom resource -definition to indicate a destination for message delivery.

-

Addressable is the schema for the destination information. This is -typically stored in the object’s status, as this information may -be generated by the controller.

-

- - - - - - - - - - - - - -
FieldDescription
-url
- -knative.dev/pkg/apis.URL - -		 -
-

AddressableType + +

AwsSqsSource

-

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

+

AwsSqsSource is the Schema for the AWS SQS API

@@ -148,56 +52,21 @@ access the Addressable data. This is not a real resource.

+apiVersion
+string - + - -
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. + +sources.knative.dev/v1alpha1 +
-status
- - -AddressStatus - - -		 +kind
+string 		AwsSqsSource
-

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
@@ -216,19365 +85,77 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -ChannelableSpec + +AwsSqsSourceSpec 		-

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

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

-

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

+

QueueURL of the SQS queue that we will poll from.
-SubscribableStatus
+awsCredsSecret
- -SubscribableStatus - - -		 -

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

-

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

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

-
-

CloudEventOverrides -

-

-(Appears on: -SourceSpec) -

-

-

CloudEventOverrides defines arguments for a Source that control the output -format of the CloudEvents produced by the Source.

-

- - - - - - - - - - - - - -
FieldDescription
-extensions
- -map[string]string - -		 -(Optional) -

Extensions specify what attribute are added or overridden on the -outbound event. Each Extensions key-value pair are set on the event as -an attribute extension independently.

-
-

Conditions -([]knative.dev/pkg/apis.Condition alias)

-

-(Appears on: -Status) -

-

-

Conditions is a simple wrapper around apis.Conditions to implement duck.Implementable.

-

-

DeliverySpec -

-

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

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-deadLetterSink
- - -Destination - - -		 -(Optional) -

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

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

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

-
-backoffPolicy
- - -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
- - -KReference - - -		 -(Optional) -

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

-
-

Destination -

-

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

-

-

Destination represents a target of an invocation over HTTP.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-ref
- - -Kubernetes core/v1.ObjectReference - - -		 -(Optional) -

Ref points to an Addressable.

-
-apiVersion
- -string - -		 -(Optional) -
-kind
- -string - -		 -(Optional) -
-name
- -string - -		 -(Optional) -
-namespace
- -string - -		 -(Optional) -
-uri
- -knative.dev/pkg/apis.URL - -		 -(Optional) -

URI can be an absolute URL(non-empty scheme and non-empty host) pointing to the target or a relative URI. Relative URIs will be resolved using the base URI retrieved from Ref.

-
-

KResource -

-

-

KResource is a skeleton type wrapping Conditions in the manner we expect -resource writers defining compatible resources to embed it. We will -typically use this type to deserialize Conditions ObjectReferences and -access the Conditions 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. -
-status
- - -Status - - -		 -
-

Source -

-

-

Source is the minimum resource shape to adhere to the Source Specification. -This duck type is intended to allow implementors of Sources and -Importers to verify their own resources meet the expectations. -This is not a real resource. -NOTE: The Source Specification is in progress and the shape and names could -be modified until it has been accepted.

-

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

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

-
-ceOverrides
- - -CloudEventOverrides - - -		 -(Optional) -

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

-
-
-status
- - -SourceStatus - - -		 -
-

SourceSpec -

-

-(Appears on: -Source) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-sink
- - -Destination - - -		 -

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

-
-ceOverrides
- - -CloudEventOverrides - - -		 -(Optional) -

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

-
-

SourceStatus -

-

-(Appears on: -Source) -

-

-

SourceStatus shows how we expect folks to embed Addressable in -their Status field.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-

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

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

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

-
-

Status -

-

-(Appears on: -KResource, -KafkaChannelStatus, -NatssChannelStatus, -SourceStatus) -

-

-

Status shows how we expect folks to embed Conditions in -their Status field. -WARNING: Adding fields to this struct will add them to all Knative resources.

-

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

ObservedGeneration is the ‘Generation’ of the Service that -was last processed by the controller.

-
-conditions
- - -Conditions - - -		 -(Optional) -

Conditions the latest available observations of a resource’s current state.

-
-

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

-
-
-

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

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

-
-serviceName
- -string - -		 -

ServiceName is the K8s Service name that serves the revision, scaled by this PA. -The service is created and owned by the ServerlessService object owned by this PA.

-
-metricsServiceName
- -string - -		 -

MetricsServiceName is the K8s Service name that provides revision metrics. -The service is managed by the PA object.

-
-desiredScale
- -int32 - -		 -

DesiredScale shows the current desired number of replicas for the revision.

-
-actualScale
- -int32 - -		 -

ActualScale shows the actual number of replicas for the revision.

-
-

PodScalable -

-

-

PodScalable is a duck type that the resources referenced by the -PodAutoscaler’s ScaleTargetRef must implement. They must also -implement the /scale sub-resource for use with /scale based -implementations (e.g. HPA), but this further constrains the shape -the referenced resources may take.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -PodScalableSpec - - -		 -
-
- - - - - - - - - - - - - -
-replicas
- -int32 - -		 -
-selector
- - -Kubernetes meta/v1.LabelSelector - - -		 -
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 -
-
-status
- - -PodScalableStatus - - -		 -
-

PodScalableSpec -

-

-(Appears on: -PodScalable) -

-

-

PodScalableSpec is the specification for the desired state of a -PodScalable (or at least our shared portion).

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-replicas
- -int32 - -		 -
-selector
- - -Kubernetes meta/v1.LabelSelector - - -		 -
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 -
-

PodScalableStatus -

-

-(Appears on: -PodScalable) -

-

-

PodScalableStatus is the observed state of a PodScalable (or at -least our shared portion).

-

- - - - - - - - - - - - - -
FieldDescription
-replicas
- -int32 - -		 -
-

ReachabilityType -(string alias)

-

-(Appears on: -PodAutoscalerSpec) -

-

-

ReachabilityType is the enumeration type for the different states of reachability -to the ScaleTarget of a PodAutoscaler

-

-
-

serving.knative.dev/v1

-

-

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

-
-

ContainerStatuses -

-

-(Appears on: -RevisionStatus) -

-

-

ContainerStatuses holds the information of container name and image digest value

-

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

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

DeprecatedImageDigest 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. -If multiple containers specified then DeprecatedImageDigest holds the digest -for serving container. -DEPRECATED: Use ContainerStatuses instead. -TODO(savitaashture) Remove deprecatedImageDigest. -ref https://kubernetes.io/docs/reference/using-api/deprecation-policy for deprecation.

-
-containerStatuses
- - -[]ContainerStatuses - - -		 -(Optional) -

ContainerStatuses is a slice of images present in .Spec.Container[*].Image -to their respective digests and their container name. -The digests are resolved during the creation of Revision. -ContainerStatuses holds the container name and image digests -for both serving and non serving containers. -ref: http://bit.ly/image-digests

-
-

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

-

-

-Resource Types: - -

Configuration -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1alpha1 - -
-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) -

Spec holds the desired state of the Configuration (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

-
-build
- -k8s.io/apimachinery/pkg/runtime.RawExtension - -		 -(Optional) -

Build optionally holds the specification for the build to -perform to produce the Revision’s container image.

-
-revisionTemplate
- - -RevisionTemplateSpec - - -		 -(Optional) -

DeprecatedRevisionTemplate holds the latest specification for the Revision to -be stamped out. If a Build specification is provided, then the -DeprecatedRevisionTemplate’s BuildName field will be populated with the name of -the Build object created to produce the container for the Revision. -DEPRECATED Use Template instead.

-
-template
- - -RevisionTemplateSpec - - -		 -(Optional) -

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

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

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

-
-

Revision -

-

-

Revision is an immutable snapshot of code and configuration. A revision -references a container image, and optionally a build that is responsible for -materializing that container image from source. Revisions are created by -updates to a Configuration.

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1alpha1 - -
-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) -

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

-
-
- - - - - - - - - - - - - - - - - -
-RevisionSpec
- - -RevisionSpec - - -		 -

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

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

-
-servingState
- - -DeprecatedRevisionServingStateType - - -		 -(Optional) -

DeprecatedServingState holds a value describing the desired state the Kubernetes -resources should be in for this Revision. -Users must not specify this when creating a revision. These values are no longer -updated by the system.

-
-container
- - -Kubernetes core/v1.Container - - -		 -(Optional) -

DeprecatedContainer defines the unit of execution for this Revision. -In the context of a Revision, we disallow a number of the fields of -this Container, including: name and lifecycle. -See also the runtime contract for more information about the execution -environment: -https://github.com/knative/serving/blob/master/docs/runtime-contract.md

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

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

-
-

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

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

DeprecatedGeneration was used prior in Kubernetes versions <1.11 -when metadata.generation was not being incremented by the api server

-

This property will be dropped in future Knative releases and should -not be used - use metadata.generation

-

Tracking issue: https://github.com/knative/serving/issues/643

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

Traffic specifies how to distribute traffic over a collection of Knative Serving 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 set of Routes and -Configurations which implement a network service. Service exists to provide a -singular abstraction which can be access controlled, reasoned about, and -which encapsulates software lifecycle decisions such as rollout policy and -team resource ownership. Service acts only as an orchestrator of the -underlying Routes and Configurations (much as a kubernetes Deployment -orchestrates ReplicaSets), and its usage is optional but recommended.

-

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

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -serving.knative.dev/v1alpha1 - -
-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) -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-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

-
-runLatest
- - -RunLatestType - - -		 -(Optional) -

DeprecatedRunLatest defines a simple Service. It will automatically -configure a route that keeps the latest ready revision -from the supplied configuration running.

-
-pinned
- - -PinnedType - - -		 -(Optional) -

DeprecatedPinned is DEPRECATED in favor of ReleaseType

-
-manual
- - -ManualType - - -		 -(Optional) -

DeprecatedManual mode enables users to start managing the underlying Route and Configuration -resources directly. This advanced usage is intended as a path for users to graduate -from the limited capabilities of Service to the full power of Route.

-
-release
- - -ReleaseType - - -		 -(Optional) -

Release enables gradual promotion of new revisions by allowing traffic -to be split between two revisions. This type replaces the deprecated Pinned type.

-
-ConfigurationSpec
- - -ConfigurationSpec - - -		 -

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

-

We are moving to a shape where the Configuration and Route specifications -are inlined into the Service, which gives them compatible shapes. We are -staging this change here as a path to this in v1beta1, which drops the -“mode” based specifications above. Ultimately all non-v1beta1 fields will -be deprecated, and then dropped in v1beta1.

-
-RouteSpec
- - -RouteSpec - - -		 -

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

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

CannotConvertError -

-

-

CannotConvertError is returned when a field cannot be converted.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Message
- -string - -		 -
-Field
- -string - -		 -
-

ConfigurationSpec -

-

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

-

-

ConfigurationSpec holds the desired state of the Configuration (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

-
-build
- -k8s.io/apimachinery/pkg/runtime.RawExtension - -		 -(Optional) -

Build optionally holds the specification for the build to -perform to produce the Revision’s container image.

-
-revisionTemplate
- - -RevisionTemplateSpec - - -		 -(Optional) -

DeprecatedRevisionTemplate holds the latest specification for the Revision to -be stamped out. If a Build specification is provided, then the -DeprecatedRevisionTemplate’s BuildName field will be populated with the name of -the Build object created to produce the container for the Revision. -DEPRECATED Use Template instead.

-
-template
- - -RevisionTemplateSpec - - -		 -(Optional) -

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

-
-

ConfigurationStatus -

-

-(Appears on: -Configuration) -

-

-

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

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -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 all of the non-duckv1.Status status fields of a Route. -These are defined outline so that we can also inline them into Service, and more easily -copy them.

-

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

-
-

ContainerStatuses -

-

-(Appears on: -RevisionStatus) -

-

-

ContainerStatuses holds the information of container name and image digest value

-

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

DeprecatedRevisionServingStateType -(string alias)

-

-(Appears on: -RevisionSpec) -

-

-

DeprecatedRevisionServingStateType is an enumeration of the levels of serving readiness of the Revision. -See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

-

-

ManualType -

-

-(Appears on: -ServiceSpec) -

-

-

ManualType contains the options for configuring a manual service. See ServiceSpec for -more details.

-

-

PinnedType -

-

-(Appears on: -ServiceSpec) -

-

-

PinnedType is DEPRECATED. ReleaseType should be used instead. To get the behavior of PinnedType set -ReleaseType.Revisions to []string{PinnedType.RevisionName} and ReleaseType.RolloutPercent to 0.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-revisionName
- -string - -		 -(Optional) -

The revision name to pin this service to until changed -to a different service type.

-
-configuration
- - -ConfigurationSpec - - -		 -(Optional) -

The configuration for this service.

-
-

ReleaseType -

-

-(Appears on: -ServiceSpec) -

-

-

ReleaseType contains the options for slowly releasing revisions. See ServiceSpec for -more details.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-revisions
- -[]string - -		 -(Optional) -

Revisions is an ordered list of 1 or 2 revisions. The first will -have a TrafficTarget with a name of “current” and the second will have -a name of “candidate”.

-
-rolloutPercent
- -int - -		 -(Optional) -

RolloutPercent is the percent of traffic that should be sent to the “candidate” -revision. Valid values are between 0 and 99 inclusive.

-
-configuration
- - -ConfigurationSpec - - -		 -(Optional) -

The configuration for this service. All revisions from this service must -come from a single configuration.

-
-

RevisionSpec -

-

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

-

-

RevisionSpec holds the desired state of the Revision (from the client).

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-RevisionSpec
- - -RevisionSpec - - -		 -

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

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

-
-servingState
- - -DeprecatedRevisionServingStateType - - -		 -(Optional) -

DeprecatedServingState holds a value describing the desired state the Kubernetes -resources should be in for this Revision. -Users must not specify this when creating a revision. These values are no longer -updated by the system.

-
-container
- - -Kubernetes core/v1.Container - - -		 -(Optional) -

DeprecatedContainer defines the unit of execution for this Revision. -In the context of a Revision, we disallow a number of the fields of -this Container, including: name and lifecycle. -See also the runtime contract for more information about the execution -environment: -https://github.com/knative/serving/blob/master/docs/runtime-contract.md

-
-

RevisionStatus -

-

-(Appears on: -Revision) -

-

-

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

-

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

DeprecatedImageDigest 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. -If multiple containers specified then DeprecatedImageDigest holds the digest -for serving container. -DEPRECATED: Use ContainerStatuses instead. -TODO(savitaashture) Remove deprecatedImageDigest. -ref https://kubernetes.io/docs/reference/using-api/deprecation-policy for deprecation.

-
-containerStatuses
- - -[]ContainerStatuses - - -		 -(Optional) -

ContainerStatuses is a slice of images present in .Spec.Container[*].Image -to their respective digests and their container name. -The digests are resolved during the creation of Revision. -ContainerStatuses holds the container name and image digests -for both serving and non serving containers. -ref: http://bit.ly/image-digests

-
-

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

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

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

-
-servingState
- - -DeprecatedRevisionServingStateType - - -		 -(Optional) -

DeprecatedServingState holds a value describing the desired state the Kubernetes -resources should be in for this Revision. -Users must not specify this when creating a revision. These values are no longer -updated by the system.

-
-container
- - -Kubernetes core/v1.Container - - -		 -(Optional) -

DeprecatedContainer defines the unit of execution for this Revision. -In the context of a Revision, we disallow a number of the fields of -this Container, including: name and lifecycle. -See also the runtime contract for more information about the execution -environment: -https://github.com/knative/serving/blob/master/docs/runtime-contract.md

-
-
-

RouteSpec -

-

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

-

-

RouteSpec holds the desired state of the Route (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

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

Traffic specifies how to distribute traffic over a collection of Knative Serving Revisions and Configurations.

-
-

RouteStatus -

-

-(Appears on: -Route) -

-

-

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

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -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 all of the non-duckv1.Status status fields of a Route. -These are defined outline so that we can also inline them into Service, and more easily -copy them.

-

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

-
-domain
- -string - -		 -(Optional) -

DeprecatedDomain holds the top-level domain that will distribute traffic over the provided targets. -It generally has the form {route-name}.{route-namespace}.{cluster-level-suffix}

-
-domainInternal
- -string - -		 -(Optional) -

DeprecatedDomainInternal holds the top-level domain that will distribute traffic over the provided -targets from inside the cluster. It generally has the form -{route-name}.{route-namespace}.svc.{cluster-domain-name} -DEPRECATED: Use Address instead.

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

-
-

RunLatestType -

-

-(Appears on: -ServiceSpec) -

-

-

RunLatestType contains the options for always having a route to the latest configuration. See -ServiceSpec for more details.

-

- - - - - - - - - - - - - -
FieldDescription
-configuration
- - -ConfigurationSpec - - -		 -(Optional) -

The configuration for this service.

-
-

ServiceSpec -

-

-(Appears on: -Service) -

-

-

ServiceSpec represents the configuration for the Service object. Exactly one -of its members (other than Generation) must be specified. Services can either -track the latest ready revision of a configuration or be pinned to a specific -revision.

-

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

-
-runLatest
- - -RunLatestType - - -		 -(Optional) -

DeprecatedRunLatest defines a simple Service. It will automatically -configure a route that keeps the latest ready revision -from the supplied configuration running.

-
-pinned
- - -PinnedType - - -		 -(Optional) -

DeprecatedPinned is DEPRECATED in favor of ReleaseType

-
-manual
- - -ManualType - - -		 -(Optional) -

DeprecatedManual mode enables users to start managing the underlying Route and Configuration -resources directly. This advanced usage is intended as a path for users to graduate -from the limited capabilities of Service to the full power of Route.

-
-release
- - -ReleaseType - - -		 -(Optional) -

Release enables gradual promotion of new revisions by allowing traffic -to be split between two revisions. This type replaces the deprecated Pinned type.

-
-ConfigurationSpec
- - -ConfigurationSpec - - -		 -

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

-

We are moving to a shape where the Configuration and Route specifications -are inlined into the Service, which gives them compatible shapes. We are -staging this change here as a path to this in v1beta1, which drops the -“mode” based specifications above. Ultimately all non-v1beta1 fields will -be deprecated, and then dropped in v1beta1.

-
-RouteSpec
- - -RouteSpec - - -		 -

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

-
-

ServiceStatus -

-

-(Appears on: -Service) -

-

-

ServiceStatus represents the Status stanza of the Service resource.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-
-RouteStatusFields
- - -RouteStatusFields - - -		 -

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

-
-ConfigurationStatusFields
- - -ConfigurationStatusFields - - -		 -

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

-
-

TrafficTarget -

-

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

-

-

TrafficTarget holds a single entry of the routing table for a Route.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-name
- -string - -		 -(Optional) -

Name is optionally used to expose a dedicated hostname for referencing this -target exclusively. It has the form: {name}.${route.status.domain}

-
-TrafficTarget
- - -TrafficTarget - - -		 -

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

-

We inherit most of our fields by inlining the v1 type. -Ultimately all non-v1 fields will be deprecated.

-
-
-

duck.knative.dev/v1

-

-

-Resource Types: - -

AddressStatus -

-

-(Appears on: -AddressableType, -ChannelableStatus, -ParallelStatus, -ParallelStatus, -SequenceStatus, -SequenceStatus) -

-

-

AddressStatus shows how we expect folks to embed Addressable in -their Status field.

-

- - - - - - - - - - - - - -
FieldDescription
-address
- - -Addressable - - -		 -
-

Addressable -

-

-(Appears on: -AddressStatus, -BrokerStatus, -RouteStatusFields) -

-

-

Addressable provides a generic mechanism for a custom resource -definition to indicate a destination for message delivery.

-

Addressable is the schema for the destination information. This is -typically stored in the object’s status, as this information may -be generated by the controller.

-

- - - - - - - - - - - - - -
FieldDescription
-url
- -knative.dev/pkg/apis.URL - -		 -
-

AddressableType -

-

-

AddressableType is a skeleton type wrapping Addressable in the manner we expect -resource writers defining compatible resources to embed it. We will -typically use this type to deserialize Addressable ObjectReferences and -access the Addressable 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. -
-status
- - -AddressStatus - - -		 -
-

CloudEventAttributes -

-

-(Appears on: -SourceStatus) -

-

-

CloudEventAttributes specifies the attributes that a Source -uses as part of its CloudEvents.

-

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

Type refers to the CloudEvent type attribute.

-
-source
- -string - -		 -

Source is the CloudEvents source attribute.

-
-

CloudEventOverrides -

-

-(Appears on: -ApiServerSourceSpec, -CamelSourceSpec, -PingSourceSpec, -SourceSpec) -

-

-

CloudEventOverrides defines arguments for a Source that control the output -format of the CloudEvents produced by the Source.

-

- - - - - - - - - - - - - -
FieldDescription
-extensions
- -map[string]string - -		 -(Optional) -

Extensions specify what attribute are added or overridden on the -outbound event. Each Extensions key-value pair are set on the event as -an attribute extension independently.

-
-

Conditions -([]knative.dev/pkg/apis.Condition alias)

-

-(Appears on: -Status) -

-

-

Conditions is a simple wrapper around apis.Conditions to implement duck.Implementable.

-

-

Destination -

-

-(Appears on: -CouchDbSourceSpec, -DeliverySpec, -GitHubSourceSpec, -GitLabSourceSpec, -KafkaSourceSpec, -ParallelBranch, -ParallelBranch, -ParallelSpec, -ParallelSpec, -PingSourceSpec, -PrometheusSourceSpec, -SequenceSpec, -SequenceSpec, -SequenceStep, -SequenceStep, -SourceSpec, -SubscriptionSpec, -SubscriptionSpec, -TriggerSpec, -TriggerSpec) -

-

-

Destination represents a target of an invocation over HTTP.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-ref
- - -KReference - - -		 -(Optional) -

Ref points to an Addressable.

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

URI can be an absolute URL(non-empty scheme and non-empty host) pointing to the target or a relative URI. Relative URIs will be resolved using the base URI retrieved from Ref.

-
-

KRShaped -

-

-

KRShaped is an interface for retrieving the duck elements of an arbitrary resource.

-

-

KReference -

-

-(Appears on: -BrokerSpec, -BrokerSpec, -ChannelStatus, -ChannelableStatus, -DeliveryStatus, -Destination) -

-

-

KReference contains enough information to refer to another object. -It’s a trimmed down version of corev1.ObjectReference.

-

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

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

-
-namespace
- -string - -		 -(Optional) -

Namespace of the referent. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ -This is optional field, it gets defaulted to the object holding it if left out.

-
-name
- -string - -		 -

Name of the referent. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

-
-apiVersion
- -string - -		 -

API version of the referent.

-
-

KResource -

-

-

KResource is a skeleton type wrapping Conditions in the manner we expect -resource writers defining compatible resources to embed it. We will -typically use this type to deserialize Conditions ObjectReferences and -access the Conditions 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. -
-status
- - -Status - - -		 -
-

PodSpecable -

-

-(Appears on: -WithPodSpec) -

-

-

PodSpecable is implemented by types containing a PodTemplateSpec -in the manner of ReplicaSet, Deployment, DaemonSet, StatefulSet.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-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
- - -Kubernetes core/v1.PodSpec - - -		 -(Optional) -

Specification of the desired behavior of the pod. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-volumes
- - -[]Kubernetes core/v1.Volume - - -		 -(Optional) -

List of volumes that can be mounted by containers belonging to the pod. -More info: https://kubernetes.io/docs/concepts/storage/volumes

-
-initContainers
- - -[]Kubernetes core/v1.Container - - -		 -

List of initialization containers belonging to the pod. -Init containers are executed in order prior to containers being started. If any -init container fails, the pod is considered to have failed and is handled according -to its restartPolicy. The name for an init container or normal container must be -unique among all containers. -Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. -The resourceRequirements of an init container are taken into account during scheduling -by finding the highest request/limit for each resource type, and then using the max of -of that value or the sum of the normal containers. Limits are applied to init containers -in a similar fashion. -Init containers cannot currently be added or removed. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

-
-containers
- - -[]Kubernetes core/v1.Container - - -		 -

List of containers belonging to the pod. -Containers cannot currently be added or removed. -There must be at least one container in a Pod. -Cannot be updated.

-
-ephemeralContainers
- - -[]Kubernetes core/v1.EphemeralContainer - - -		 -(Optional) -

List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing -pod to perform user-initiated actions such as debugging. This list cannot be specified when -creating a pod, and it cannot be modified by updating the pod spec. In order to add an -ephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource. -This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.

-
-restartPolicy
- - -Kubernetes core/v1.RestartPolicy - - -		 -(Optional) -

Restart policy for all containers within the pod. -One of Always, OnFailure, Never. -Default to Always. -More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

-
-terminationGracePeriodSeconds
- -int64 - -		 -(Optional) -

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. -Value must be non-negative integer. The value zero indicates delete immediately. -If this value is nil, the default grace period will be used instead. -The grace period is the duration in seconds after the processes running in the pod are sent -a termination signal and the time when the processes are forcibly halted with a kill signal. -Set this value longer than the expected cleanup time for your process. -Defaults to 30 seconds.

-
-activeDeadlineSeconds
- -int64 - -		 -(Optional) -

Optional duration in seconds the pod may be active on the node relative to -StartTime before the system will actively try to mark it failed and kill associated containers. -Value must be a positive integer.

-
-dnsPolicy
- - -Kubernetes core/v1.DNSPolicy - - -		 -(Optional) -

Set DNS policy for the pod. -Defaults to “ClusterFirst”. -Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’. -DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. -To have DNS options set along with hostNetwork, you have to specify DNS policy -explicitly to ‘ClusterFirstWithHostNet’.

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

NodeSelector is a selector which must be true for the pod to fit on a node. -Selector which must match a node’s labels for the pod to be scheduled on that node. -More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

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

ServiceAccountName is the name of the ServiceAccount to use to run this pod. -More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

-
-serviceAccount
- -string - -		 -(Optional) -

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. -Deprecated: Use serviceAccountName instead.

-
-automountServiceAccountToken
- -bool - -		 -(Optional) -

AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

-
-nodeName
- -string - -		 -(Optional) -

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, -the scheduler simply schedules this pod onto that node, assuming that it fits resource -requirements.

-
-hostNetwork
- -bool - -		 -(Optional) -

Host networking requested for this pod. Use the host’s network namespace. -If this option is set, the ports that will be used must be specified. -Default to false.

-
-hostPID
- -bool - -		 -(Optional) -

Use the host’s pid namespace. -Optional: Default to false.

-
-hostIPC
- -bool - -		 -(Optional) -

Use the host’s ipc namespace. -Optional: Default to false.

-
-shareProcessNamespace
- -bool - -		 -(Optional) -

Share a single process namespace between all of the containers in a pod. -When this is set containers will be able to view and signal processes from other containers -in the same pod, and the first process in each container will not be assigned PID 1. -HostPID and ShareProcessNamespace cannot both be set. -Optional: Default to false. -This field is beta-level and may be disabled with the PodShareProcessNamespace feature.

-
-securityContext
- - -Kubernetes core/v1.PodSecurityContext - - -		 -(Optional) -

SecurityContext holds pod-level security attributes and common container settings. -Optional: Defaults to empty. See type description for default values of each field.

-
-imagePullSecrets
- - -[]Kubernetes core/v1.LocalObjectReference - - -		 -(Optional) -

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. -If specified, these secrets will be passed to individual puller implementations for them to use. For example, -in the case of docker, only DockerConfig type secrets are honored. -More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

-
-hostname
- -string - -		 -(Optional) -

Specifies the hostname of the Pod -If not specified, the pod’s hostname will be set to a system-defined value.

-
-subdomain
- -string - -		 -(Optional) -

If specified, the fully qualified Pod hostname will be “...svc.”. -If not specified, the pod will not have a domainname at all.

-
-affinity
- - -Kubernetes core/v1.Affinity - - -		 -(Optional) -

If specified, the pod’s scheduling constraints

-
-schedulerName
- -string - -		 -(Optional) -

If specified, the pod will be dispatched by specified scheduler. -If not specified, the pod will be dispatched by default scheduler.

-
-tolerations
- - -[]Kubernetes core/v1.Toleration - - -		 -(Optional) -

If specified, the pod’s tolerations.

-
-hostAliases
- - -[]Kubernetes core/v1.HostAlias - - -		 -(Optional) -

HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts -file if specified. This is only valid for non-hostNetwork pods.

-
-priorityClassName
- -string - -		 -(Optional) -

If specified, indicates the pod’s priority. “system-node-critical” and -“system-cluster-critical” are two special keywords which indicate the -highest priorities with the former being the highest priority. Any other -name must be defined by creating a PriorityClass object with that name. -If not specified, the pod priority will be default or zero if there is no -default.

-
-priority
- -int32 - -		 -(Optional) -

The priority value. Various system components use this field to find the -priority of the pod. When Priority Admission Controller is enabled, it -prevents users from setting this field. The admission controller populates -this field from PriorityClassName. -The higher the value, the higher the priority.

-
-dnsConfig
- - -Kubernetes core/v1.PodDNSConfig - - -		 -(Optional) -

Specifies the DNS parameters of a pod. -Parameters specified here will be merged to the generated DNS -configuration based on DNSPolicy.

-
-readinessGates
- - -[]Kubernetes core/v1.PodReadinessGate - - -		 -(Optional) -

If specified, all readiness gates will be evaluated for pod readiness. -A pod is ready when all its containers are ready AND -all conditions specified in the readiness gates have status equal to “True” -More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md

-
-runtimeClassName
- -string - -		 -(Optional) -

RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used -to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. -If unset or empty, the “legacy” RuntimeClass will be used, which is an implicit class with an -empty definition that uses the default runtime handler. -More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md -This is a beta feature as of Kubernetes v1.14.

-
-enableServiceLinks
- -bool - -		 -(Optional) -

EnableServiceLinks indicates whether information about services should be injected into pod’s -environment variables, matching the syntax of Docker links. -Optional: Defaults to true.

-
-preemptionPolicy
- - -Kubernetes core/v1.PreemptionPolicy - - -		 -(Optional) -

PreemptionPolicy is the Policy for preempting pods with lower priority. -One of Never, PreemptLowerPriority. -Defaults to PreemptLowerPriority if unset. -This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.

-
-overhead
- - -Kubernetes core/v1.ResourceList - - -		 -(Optional) -

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. -This field will be autopopulated at admission time by the RuntimeClass admission controller. If -the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. -The RuntimeClass admission controller will reject Pod create requests which have the overhead already -set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value -defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. -More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md -This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.

-
-topologySpreadConstraints
- - -[]Kubernetes core/v1.TopologySpreadConstraint - - -		 -(Optional) -

TopologySpreadConstraints describes how a group of pods ought to spread across topology -domains. Scheduler will schedule pods in a way which abides by the constraints. -This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread -feature. -All topologySpreadConstraints are ANDed.

-
-
-

Source -

-

-

Source is the minimum resource shape to adhere to the Source Specification. -This duck type is intended to allow implementors of Sources and -Importers to verify their own resources meet the expectations. -This is not a real resource. -NOTE: The Source Specification is in progress and the shape and names could -be modified until it has been accepted.

-

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

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

-
-ceOverrides
- - -CloudEventOverrides - - -		 -(Optional) -

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

-
-
-status
- - -SourceStatus - - -		 -
-

SourceSpec -

-

-(Appears on: -ApiServerSourceSpec, -ContainerSourceSpec, -PingSourceSpec, -SinkBindingSpec, -SinkBindingSpec, -Source) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-sink
- - -Destination - - -		 -

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

-
-ceOverrides
- - -CloudEventOverrides - - -		 -(Optional) -

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

-
-

SourceStatus -

-

-(Appears on: -ApiServerSourceStatus, -ApiServerSourceStatus, -AwsSqsSourceStatus, -ContainerSourceStatus, -CouchDbSourceStatus, -GitHubBindingStatus, -GitHubSourceStatus, -GitLabBindingStatus, -GitLabSourceStatus, -KafkaSourceStatus, -PingSourceStatus, -PingSourceStatus, -PrometheusSourceStatus, -SinkBindingStatus, -SinkBindingStatus, -Source) -

-

-

SourceStatus shows how we expect folks to embed Addressable in -their Status field.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-

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

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

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

-
-ceAttributes
- - -[]CloudEventAttributes - - -		 -(Optional) -

CloudEventAttributes are the specific attributes that the Source uses -as part of its CloudEvents.

-
-

Status -

-

-(Appears on: -BrokerStatus, -BrokerStatus, -CamelSourceStatus, -CertificateStatus, -ChannelStatus, -ChannelableCombinedStatus, -ChannelableStatus, -ChannelableStatus, -ConfigMapPropagationStatus, -ConfigurationStatus, -ConfigurationStatus, -EventTypeStatus, -EventTypeStatus, -InMemoryChannelStatus, -IngressStatus, -KResource, -KafkaBindingStatus, -MetricStatus, -ParallelStatus, -ParallelStatus, -PodAutoscalerStatus, -RevisionStatus, -RevisionStatus, -RouteStatus, -RouteStatus, -SequenceStatus, -SequenceStatus, -ServerlessServiceStatus, -ServiceStatus, -ServiceStatus, -SourceStatus, -SubscriptionStatus, -SubscriptionStatus, -TriggerStatus, -TriggerStatus) -

-

-

Status shows how we expect folks to embed Conditions in -their Status field. -WARNING: Adding fields to this struct will add them to all Knative resources.

-

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

ObservedGeneration is the ‘Generation’ of the Service that -was last processed by the controller.

-
-conditions
- - -Conditions - - -		 -(Optional) -

Conditions the latest available observations of a resource’s current state.

-
-

WithPod -

-

-

WithPod is the shell that demonstrates how PodSpecable types wrap -a PodSpec.

-

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

WithPodSpec -

-

-(Appears on: -WithPod) -

-

-

WithPodSpec is the shell around the PodSpecable within WithPod.

-

- - - - - - - - - - - - - -
FieldDescription
-template
- - -PodSpecable - - -		 -
-
-

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

-
-

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

-

-

-Resource Types: - -

Configuration -

-

-

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

-

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

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

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

Revision -

-

-

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

-

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

-

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

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

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

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

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

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

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

Route -

-

-

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

-

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

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

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

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

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

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

-
-

Service -

-

-

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

-

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

-

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

-

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

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

-

ServiceSpec inlines an unrestricted ConfigurationSpec.

-
-RouteSpec
- - -RouteSpec - - -		 -

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

-

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

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

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

-

-Resource Types: - -

Parallel -

-

-

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

-

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

Spec defines the desired state of the Parallel.

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

Branches is the list of Filter/Subscribers pairs.

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

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

-
-
-status
- - -ParallelStatus - - -		 -(Optional) -

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

-
-

ParallelBranch -

-

-(Appears on: -ParallelSpec) -

-

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-filter
- - -Destination - - -		 -

Filter is the expression guarding the branch

-
-subscriber
- - -Destination - - -		 -

Subscriber receiving the event when the filter passes

-
-reply
- - -Destination - - -		 -(Optional) -

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

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

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

-
-

ParallelBranchStatus -

-

-(Appears on: -ParallelStatus) -

-

-

ParallelBranchStatus represents the current state of a Parallel branch

-

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

FilterSubscriptionStatus corresponds to the filter subscription status.

-
-filterChannelStatus
- - -ParallelChannelStatus - - -		 -

FilterChannelStatus corresponds to the filter channel status.

-
-subscriberSubscriptionStatus
- - -ParallelSubscriptionStatus - - -		 -

SubscriptionStatus corresponds to the subscriber subscription status.

-
-

ParallelChannelStatus -

-

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

-

-

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

Channel is the reference to the underlying channel.

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

ReadyCondition indicates whether the Channel is ready or not.

-
-

ParallelSpec -

-

-(Appears on: -Parallel) -

-

-

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

Branches is the list of Filter/Subscribers pairs.

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

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

-
-

ParallelStatus -

-

-(Appears on: -Parallel) -

-

-

ParallelStatus represents the current state of a Parallel.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-

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

-
-ingressChannelStatus
- - -ParallelChannelStatus - - -		 -

IngressChannelStatus corresponds to the ingress channel status.

-
-branchStatuses
- - -[]ParallelBranchStatus - - -		 -

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

-
-AddressStatus
- - -AddressStatus - - -		 -

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

-

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

-
-

ParallelSubscriptionStatus -

-

-(Appears on: -ParallelBranchStatus) -

-

-

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

Subscription is the reference to the underlying Subscription.

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

ReadyCondition indicates whether the Subscription is ready or not.

-
-

Sequence -

-

-

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

-

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

Spec defines the desired state of the Sequence.

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

Steps is the list of Destinations (processors / functions) that will be called in the order -provided.

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

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

-
-
-status
- - -SequenceStatus - - -		 -(Optional) -

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

-
-

SequenceChannelStatus -

-

-(Appears on: -SequenceStatus) -

-

-

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

Channel is the reference to the underlying channel.

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

ReadyCondition indicates whether the Channel is ready or not.

-
-

SequenceSpec -

-

-(Appears on: -Sequence) -

-

-

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

Steps is the list of Destinations (processors / functions) that will be called in the order -provided.

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

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

-
-

SequenceStatus -

-

-(Appears on: -Sequence) -

-

-

SequenceStatus represents the current state of a Sequence.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-

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

-
-subscriptionStatuses
- - -[]SequenceSubscriptionStatus - - -		 -

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

-
-channelStatuses
- - -[]SequenceChannelStatus - - -		 -

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

-
-AddressStatus
- - -AddressStatus - - -		 -

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

-

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

-
-

SequenceStep -

-

-(Appears on: -SequenceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Destination
- - -Destination - - -		 -

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

-

Subscriber receiving the step event

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

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

-
-

SequenceSubscriptionStatus -

-

-(Appears on: -SequenceStatus) -

-

-

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

Subscription is the reference to the underlying Subscription.

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

ReadyCondition indicates whether the Subscription is ready or not.

-
-
-

messaging.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

Channel -

-

-

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

-

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

Spec defines the desired state of the Channel.

-
-
- - - - - - - - - -
-channelTemplate
- - -ChannelTemplateSpec - - -		 -

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

-
-ChannelableSpec
- - -ChannelableSpec - - -		 -

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

-

Channel conforms to ChannelableSpec

-
-
-status
- - -ChannelStatus - - -		 -(Optional) -

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

-
-

InMemoryChannel -

-

-

InMemoryChannel is a resource representing an in memory channel

-

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

Spec defines the desired state of the Channel.

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

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

-

Channel conforms to Duck type Channelable.

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

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

-
-

Subscription -

-

-

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

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -messaging.knative.dev/v1beta1 - -
-kind
-string -		Subscription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -SubscriptionSpec - - -		 -
-
- - - - - - - - - - - - - - - - - -
-channel
- - -Kubernetes core/v1.ObjectReference - - -		 -

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

-

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

-
-subscriber
- - -Destination - - -		 -(Optional) -

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

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

Delivery configuration

-
-
-status
- - -SubscriptionStatus - - -		 -
-

ChannelDefaulter -

-

-

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

-

-

ChannelSpec -

-

-(Appears on: -Channel) -

-

-

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

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-channelTemplate
- - -ChannelTemplateSpec - - -		 -

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

-
-ChannelableSpec
- - -ChannelableSpec - - -		 -

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

-

Channel conforms to ChannelableSpec

-
-

ChannelStatus -

-

-(Appears on: -Channel) -

-

-

ChannelStatus represents the current state of a Channel.

-

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

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

-

Channel conforms to ChannelableStatus

-
-channel
- - -KReference - - -		 -

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

-
-

ChannelTemplateSpec -

-

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

-

-

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

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

-
-
- -
-
-

ChannelTemplateSpecInternal -

-

-

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

-

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

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

-
-
- -
-
-

InMemoryChannelSpec -

-

-(Appears on: -InMemoryChannel) -

-

-

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

-

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

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

-

Channel conforms to Duck type Channelable.

-
-

InMemoryChannelStatus -

-

-(Appears on: -InMemoryChannel) -

-

-

ChannelStatus represents the current state of a Channel.

-

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

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

-

Channel conforms to Duck type Channelable.

-
-

SubscriptionSpec -

-

-(Appears on: -Subscription) -

-

-

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

-

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

-

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

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

-

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

-
-subscriber
- - -Destination - - -		 -(Optional) -

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

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

Delivery configuration

-
-

SubscriptionStatus -

-

-(Appears on: -Subscription) -

-

-

SubscriptionStatus (computed) for a subscription

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-

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

-
-physicalSubscription
- - -SubscriptionStatusPhysicalSubscription - - -		 -

PhysicalSubscription is the fully resolved values that this Subscription represents.

-
-

SubscriptionStatusPhysicalSubscription -

-

-(Appears on: -SubscriptionStatus) -

-

-

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

-

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

SubscriberURI is the fully resolved URI for spec.subscriber.

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

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

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

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

-
-
-

sources.knative.dev/v1alpha2

-

-

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

-

-Resource Types: - -

ApiServerSource -

-

-

ApiServerSource is the Schema for the apiserversources API

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -sources.knative.dev/v1alpha2 - -
-kind
-string -		ApiServerSource
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ApiServerSourceSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - -
-SourceSpec
- - -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
- - -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
- - -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
- - -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
- - -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
- - -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
- - -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
- - -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
- - -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
- - -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
- - -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
- - -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
- - -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
- - -SourceStatus - - -		 -

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

-

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

-
-
-

configs.internal.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

ConfigMapPropagation -

-

-

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

-

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

Spec defines the desired state of the ConfigMapPropagation

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

OriginalNamespace is the namespace where the original configMaps are in

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

Selector only selects original configMaps with corresponding labels

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

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

-
-

ConfigMapPropagationSpec -

-

-(Appears on: -ConfigMapPropagation) -

-

-

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

OriginalNamespace is the namespace where the original configMaps are in

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

Selector only selects original configMaps with corresponding labels

-
-

ConfigMapPropagationStatus -

-

-(Appears on: -ConfigMapPropagation) -

-

-

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-

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

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

CopyConfigMaps is the status for each copied configmap.

-
-

ConfigMapPropagationStatusCopyConfigMap -

-

-(Appears on: -ConfigMapPropagationStatus) -

-

-

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

-

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

Name is copy configmap’s name

-
-source
- -string - -		 -

Source is “originalNamespace/originalConfigMapName”

-
-operation
- -string - -		 -

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

-
-ready
- -string - -		 -

Ready represents the operation is ready or not

-
-reason
- -string - -		 -

Reason indicates reasons if the operation is not ready

-
-resourceVersionFromSource
- -string - -		 -

ResourceVersion is the resourceVersion of original configmap

-
-
-

duck.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

AddressStatus -

-

-(Appears on: -AddressableType, -ChannelStatus, -ChannelableCombinedStatus, -ChannelableStatus, -InMemoryChannelStatus, -KafkaChannelStatus, -NatssChannelStatus) -

-

-

AddressStatus shows how we expect folks to embed Addressable in -their Status field.

-

- - - - - - - - - - - - - -
FieldDescription
-address
- - -Addressable - - -		 -
-

Addressable -

-

-(Appears on: -AddressStatus, -BrokerStatus, -RouteStatusFields) -

-

-

Addressable provides a generic mechanism for a custom resource -definition to indicate a destination for message delivery.

-

Addressable is the schema for the destination information. This is -typically stored in the object’s status, as this information may -be generated by the controller.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Addressable
- - -Addressable - - -		 -
-hostname
- -string - -		 -
-

AddressableType -

-

-

AddressableType is a skeleton type wrapping Addressable in the manner we expect -resource writers defining compatible resources to embed it. We will -typically use this type to deserialize Addressable ObjectReferences and -access the Addressable 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. -
-status
- - -AddressStatus - - -		 -
-

Binding -

-

-

Binding is a duck type that specifies the partial schema to which all -Binding implementations should adhere.

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -BindingSpec - - -		 -
-
- - - - - -
-subject
- -knative.dev/pkg/tracker.Reference - -		 -

Subject references the resource(s) whose “runtime contract” should be -augmented by Binding implementations.

-
-
-

BindingSpec -

-

-(Appears on: -Binding, -GitHubBindingSpec, -GitLabBindingSpec, -KafkaBindingSpec, -SinkBindingSpec, -SinkBindingSpec) -

-

-

BindingSpec specifies the spec portion of the Binding partial-schema.

-

- - - - - - - - - - - - - -
FieldDescription
-subject
- -knative.dev/pkg/tracker.Reference - -		 -

Subject references the resource(s) whose “runtime contract” should be -augmented by Binding implementations.

-
-

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

-
-

LegacyTarget -

-

-

LegacyTarget is a skeleton type wrapping LegacyTargetable in the manner we -want to support unless they get migrated into supporting Legacy. -We will typically use this type to deserialize LegacyTargetable -ObjectReferences and access the LegacyTargetable data. This is not a -real resource. -** Do not use this for any new resources **

-

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

LegacyTargetable -

-

-(Appears on: -LegacyTarget) -

-

-

LegacyTargetable left around until we migrate to Addressable in the -dependent resources. Addressable has more structure in the way it -defines the fields. LegacyTargetable only assumed a single string -in the Status field and we’re moving towards defining proper structs -under Status rather than strings. -This is to support existing resources until they migrate.

-

Do not use this for anything new, use Addressable

-

LegacyTargetable is the old schema for the addressable portion -of the payload

-

For new resources use Addressable.

-

- - - - - - - - - - - - - -
FieldDescription
-domainInternal
- -string - -		 -
-

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, -KafkaChannelSpec, -NatssChannelSpec, -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, -KafkaChannelStatus, -NatssChannelStatus, -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) -
-

Target -

-

-

Target is a skeleton type wrapping Targetable in the manner we expect -resource writers defining compatible resources to embed it. We will -typically use this type to deserialize Targetable ObjectReferences and -access the Targetable 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. -
-status
- - -TargetStatus - - -		 -
-

TargetStatus -

-

-(Appears on: -Target) -

-

-

TargetStatus shows how we expect folks to embed Targetable in -their Status field.

-

- - - - - - - - - - - - - -
FieldDescription
-targetable
- - -Targetable - - -		 -
-

Targetable -

-

-(Appears on: -TargetStatus) -

-

-

Targetable is an earlier version of the Callable interface. -Callable is a higher-level interface which implements Addressable -but further promises that the destination may synchronously return -response messages in reply to a message.

-

Targetable implementations should instead implement Addressable and -include an eventing.knative.dev/returns=any annotation.

-

Targetable is retired; implement Addressable for now.

-

- - - - - - - - - - - - - -
FieldDescription
-domainInternal
- -string - -		 -
-
-

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

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

Parallel -

-

-

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

-

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

Spec defines the desired state of the Parallel.

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

Branches is the list of Filter/Subscribers pairs.

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

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

-
-
-status
- - -ParallelStatus - - -		 -(Optional) -

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

-
-

ParallelBranch -

-

-(Appears on: -ParallelSpec) -

-

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-filter
- - -Destination - - -		 -(Optional) -

Filter is the expression guarding the branch

-
-subscriber
- - -Destination - - -		 -

Subscriber receiving the event when the filter passes

-
-reply
- - -Destination - - -		 -(Optional) -

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

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

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

-
-

ParallelBranchStatus -

-

-(Appears on: -ParallelStatus) -

-

-

ParallelBranchStatus represents the current state of a Parallel branch

-

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

FilterSubscriptionStatus corresponds to the filter subscription status.

-
-filterChannelStatus
- - -ParallelChannelStatus - - -		 -

FilterChannelStatus corresponds to the filter channel status.

-
-subscriberSubscriptionStatus
- - -ParallelSubscriptionStatus - - -		 -

SubscriptionStatus corresponds to the subscriber subscription status.

-
-

ParallelChannelStatus -

-

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

-

-

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

Channel is the reference to the underlying channel.

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

ReadyCondition indicates whether the Channel is ready or not.

-
-

ParallelSpec -

-

-(Appears on: -Parallel) -

-

-

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

Branches is the list of Filter/Subscribers pairs.

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

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

-
-

ParallelStatus -

-

-(Appears on: -Parallel) -

-

-

ParallelStatus represents the current state of a Parallel.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-

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

-
-ingressChannelStatus
- - -ParallelChannelStatus - - -		 -

IngressChannelStatus corresponds to the ingress channel status.

-
-branchStatuses
- - -[]ParallelBranchStatus - - -		 -

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

-
-AddressStatus
- - -AddressStatus - - -		 -

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

-

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

-
-

ParallelSubscriptionStatus -

-

-(Appears on: -ParallelBranchStatus) -

-

-

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

Subscription is the reference to the underlying Subscription.

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

ReadyCondition indicates whether the Subscription is ready or not.

-
-

Sequence -

-

-

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

-

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

Spec defines the desired state of the Sequence.

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

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

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

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

-
-
-status
- - -SequenceStatus - - -		 -(Optional) -

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

-
-

SequenceChannelStatus -

-

-(Appears on: -SequenceStatus) -

-

-

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

Channel is the reference to the underlying channel.

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

ReadyCondition indicates whether the Channel is ready or not.

-
-

SequenceSpec -

-

-(Appears on: -Sequence) -

-

-

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

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

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

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

-
-reply
- - -Destination - - -		 -(Optional) -

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

-
-

SequenceStatus -

-

-(Appears on: -Sequence) -

-

-

SequenceStatus represents the current state of a Sequence.

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-Status
- - -Status - - -		 -

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

-

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

-
-subscriptionStatuses
- - -[]SequenceSubscriptionStatus - - -		 -

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

-
-channelStatuses
- - -[]SequenceChannelStatus - - -		 -

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

-
-AddressStatus
- - -AddressStatus - - -		 -

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

-

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

-
-

SequenceStep -

-

-(Appears on: -SequenceSpec) -

-

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-Destination
- - -Destination - - -		 -

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

-

Subscriber receiving the step event

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

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

-
-

SequenceSubscriptionStatus -

-

-(Appears on: -SequenceStatus) -

-

-

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

Subscription is the reference to the underlying Subscription.

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

ReadyCondition indicates whether the Subscription is ready or not.

-
-
-

camel.apache.org/v1

-

-

Package v1 contains API Schema definitions for the camel v1 API group

-

-Resource Types: - -

Artifact -

-

-(Appears on: -BuildStatus, -IntegrationKitStatus) -

-

-

Artifact –

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-id
- -string - -		 -
-location
- -string - -		 -
-target
- -string - -		 -
-checksum
- -string - -		 -
-

BaseTask -

-

-(Appears on: -BuilderTask, -ContainerTask) -

-

-

BaseTask –

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-name
- -string - -		 -
-affinity
- - -Kubernetes core/v1.Affinity - - -		 -
-volumes
- - -[]Kubernetes core/v1.Volume - - -		 -
-volumeMounts
- - -[]Kubernetes core/v1.VolumeMount - - -		 -
-

Build -

-

-

Build is the Schema for the builds API

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -BuildSpec - - -		 -
-
- - - - - -
-tasks
- - -[]Task - - -		 -

INSERT ADDITIONAL SPEC FIELDS - desired state of cluster -Important: Run “operator-sdk generate k8s” to regenerate code after modifying this file

-
-
-status
- - -BuildStatus - - -		 -
-

BuildCondition -

-

-(Appears on: -BuildStatus) -

-

-

BuildCondition describes the state of a resource at a certain point.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-type
- - -BuildConditionType - - -		 -

Type of integration condition.

-
-status
- - -Kubernetes core/v1.ConditionStatus - - -		 -

Status of the condition, one of True, False, Unknown.

-
-lastUpdateTime
- - -Kubernetes meta/v1.Time - - -		 -

The last time this condition was updated.

-
-lastTransitionTime
- - -Kubernetes meta/v1.Time - - -		 -

Last time the condition transitioned from one status to another.

-
-reason
- -string - -		 -

The reason for the condition’s last transition.

-
-message
- -string - -		 -

A human readable message indicating details about the transition.

-
-

BuildConditionType -(string alias)

-

-(Appears on: -BuildCondition) -

-

-

BuildConditionType –

-

-

BuildPhase -(string alias)

-

-(Appears on: -BuildStatus) -

-

-

BuildPhase –

-

-

BuildSpec -

-

-(Appears on: -Build) -

-

-

BuildSpec defines the desired state of Build

-

- - - - - - - - - - - - - -
FieldDescription
-tasks
- - -[]Task - - -		 -

INSERT ADDITIONAL SPEC FIELDS - desired state of cluster -Important: Run “operator-sdk generate k8s” to regenerate code after modifying this file

-
-

BuildStatus -

-

-(Appears on: -Build) -

-

-

BuildStatus defines the observed state of Build

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-phase
- - -BuildPhase - - -		 -
-image
- -string - -		 -
-digest
- -string - -		 -
-baseImage
- -string - -		 -
-artifacts
- - -[]Artifact - - -		 -
-error
- -string - -		 -
-failure
- - -Failure - - -		 -
-startedAt
- - -Kubernetes meta/v1.Time - - -		 -
-platform
- -string - -		 -
-conditions
- - -[]BuildCondition - - -		 -
-duration
- -string - -		 -

Change to Duration / ISO 8601 when CRD uses OpenAPI spec v3 -https://github.com/OAI/OpenAPI-Specification/issues/845

-
-

BuilderTask -

-

-(Appears on: -Task) -

-

-

BuilderTask –

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-BaseTask
- - -BaseTask - - -		 -

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

-
-meta
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-image
- -string - -		 -
-baseImage
- -string - -		 -
-runtime
- - -RuntimeSpec - - -		 -
-sources
- - -[]SourceSpec - - -		 -
-resources
- - -[]ResourceSpec - - -		 -
-dependencies
- -[]string - -		 -
-steps
- -[]string - -		 -
-maven
- - -MavenSpec - - -		 -
-buildDir
- -string - -		 -
-properties
- -map[string]string - -		 -
-timeout
- - -Kubernetes meta/v1.Duration - - -		 -
-

CamelArtifact -

-

-(Appears on: -CamelArtifact, -CamelCatalogSpec) -

-

-

CamelArtifact –

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-CamelArtifactDependency
- - -CamelArtifactDependency - - -		 -

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

-
-schemes
- - -[]CamelScheme - - -		 -
-languages
- -[]string - -		 -
-dataformats
- -[]string - -		 -
-dependencies
- - -[]CamelArtifact - - -		 -
-javaTypes
- -[]string - -		 -
-

CamelArtifactDependency -

-

-(Appears on: -CamelArtifact) -

-

-

CamelArtifactDependency represent a maven’s dependency

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-MavenArtifact
- - -MavenArtifact - - -		 -

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

-
-exclusions
- - -[]CamelArtifactExclusion - - -		 -
-

CamelArtifactExclusion -

-

-(Appears on: -CamelArtifactDependency) -

-

-

CamelArtifactExclusion –

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-groupId
- -string - -		 -
-artifactId
- -string - -		 -
-

CamelCatalog -

-

-

CamelCatalog is the Schema for the camelcatalogs API

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-status
- - -CamelCatalogStatus - - -		 -
-spec
- - -CamelCatalogSpec - - -		 -
-
- - - - - - - - - - - - - -
-runtime
- - -RuntimeSpec - - -		 -
-artifacts
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.CamelArtifact - - -		 -
-loaders
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.CamelLoader - - -		 -
-
-

CamelCatalogSpec -

-

-(Appears on: -CamelCatalog) -

-

-

CamelCatalogSpec defines the desired state of CamelCatalog

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-runtime
- - -RuntimeSpec - - -		 -
-artifacts
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.CamelArtifact - - -		 -
-loaders
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.CamelLoader - - -		 -
-

CamelCatalogStatus -

-

-(Appears on: -CamelCatalog) -

-

-

CamelCatalogStatus defines the observed state of CamelCatalog

-

-

CamelLoader -

-

-(Appears on: -CamelCatalogSpec) -

-

-

CamelLoader –

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-MavenArtifact
- - -MavenArtifact - - -		 -

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

-
-languages
- -[]string - -		 -
-dependencies
- - -[]MavenArtifact - - -		 -
-

CamelScheme -

-

-(Appears on: -CamelArtifact) -

-

-

CamelScheme –

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-id
- -string - -		 -
-passive
- -bool - -		 -
-http
- -bool - -		 -
-

Capability -

-

-(Appears on: -RuntimeSpec) -

-

-

Capability –

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-dependencies
- - -[]MavenArtifact - - -		 -
-metadata
- -map[string]string - -		 -
-

Configurable -

-

-

Configurable –

-

-

ConfigurationSpec -

-

-(Appears on: -IntegrationKitSpec, -IntegrationPlatformSpec, -IntegrationSpec, -IntegrationStatus) -

-

-

ConfigurationSpec –

-

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

ContainerTask -

-

-(Appears on: -ImageTask) -

-

-

ContainerTask –

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-BaseTask
- - -BaseTask - - -		 -

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

-
-image
- -string - -		 -
-command
- -[]string - -		 -
-args
- -[]string - -		 -
-env
- - -[]Kubernetes core/v1.EnvVar - - -		 -
-workingDir
- -string - -		 -
-securityContext
- - -Kubernetes core/v1.SecurityContext - - -		 -
-

DataSpec -

-

-(Appears on: -ResourceSpec, -SourceSpec) -

-

-

DataSpec –

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-name
- -string - -		 -
-content
- -string - -		 -
-contentRef
- -string - -		 -
-contentKey
- -string - -		 -
-compression
- -bool - -		 -
-

Failure -

-

-(Appears on: -BuildStatus, -IntegrationKitStatus, -IntegrationStatus) -

-

-

Failure –

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-reason
- -string - -		 -
-time
- - -Kubernetes meta/v1.Time - - -		 -
-recovery
- - -FailureRecovery - - -		 -
-

FailureRecovery -

-

-(Appears on: -Failure) -

-

-

FailureRecovery –

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-attempt
- -int - -		 -
-attemptMax
- -int - -		 -
-attemptTime
- - -Kubernetes meta/v1.Time - - -		 -
-

ImageTask -

-

-(Appears on: -Task) -

-

-

ImageTask –

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-ContainerTask
- - -ContainerTask - - -		 -

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

-
-builtImage
- -string - -		 -
-

Integration -

-

-

Integration is the Schema for the integrations API

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -IntegrationSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-replicas
- -int32 - -		 -
-sources
- - -[]SourceSpec - - -		 -
-resources
- - -[]ResourceSpec - - -		 -
-kit
- -string - -		 -
-dependencies
- -[]string - -		 -
-profile
- - -TraitProfile - - -		 -
-traits
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec - - -		 -
-configuration
- - -[]ConfigurationSpec - - -		 -
-repositories
- -[]string - -		 -
-serviceAccountName
- -string - -		 -
-
-status
- - -IntegrationStatus - - -		 -
-

IntegrationCondition -

-

-(Appears on: -IntegrationStatus) -

-

-

IntegrationCondition describes the state of a resource at a certain point.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-type
- - -IntegrationConditionType - - -		 -

Type of integration condition.

-
-status
- - -Kubernetes core/v1.ConditionStatus - - -		 -

Status of the condition, one of True, False, Unknown.

-
-lastUpdateTime
- - -Kubernetes meta/v1.Time - - -		 -

The last time this condition was updated.

-
-lastTransitionTime
- - -Kubernetes meta/v1.Time - - -		 -

Last time the condition transitioned from one status to another.

-
-reason
- -string - -		 -

The reason for the condition’s last transition.

-
-message
- -string - -		 -

A human readable message indicating details about the transition.

-
-

IntegrationConditionType -(string alias)

-

-(Appears on: -IntegrationCondition) -

-

-

IntegrationConditionType –

-

-

IntegrationKit -

-

-

IntegrationKit is the Schema for the integrationkits API

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -IntegrationKitSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-image
- -string - -		 -
-dependencies
- -[]string - -		 -
-profile
- - -TraitProfile - - -		 -
-traits
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec - - -		 -
-configuration
- - -[]ConfigurationSpec - - -		 -
-repositories
- -[]string - -		 -
-
-status
- - -IntegrationKitStatus - - -		 -
-

IntegrationKitCondition -

-

-(Appears on: -IntegrationKitStatus) -

-

-

IntegrationKitCondition describes the state of a resource at a certain point.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-type
- - -IntegrationKitConditionType - - -		 -

Type of integration condition.

-
-status
- - -Kubernetes core/v1.ConditionStatus - - -		 -

Status of the condition, one of True, False, Unknown.

-
-lastUpdateTime
- - -Kubernetes meta/v1.Time - - -		 -

The last time this condition was updated.

-
-lastTransitionTime
- - -Kubernetes meta/v1.Time - - -		 -

Last time the condition transitioned from one status to another.

-
-reason
- -string - -		 -

The reason for the condition’s last transition.

-
-message
- -string - -		 -

A human readable message indicating details about the transition.

-
-

IntegrationKitConditionType -(string alias)

-

-(Appears on: -IntegrationKitCondition) -

-

-

IntegrationKitConditionType –

-

-

IntegrationKitPhase -(string alias)

-

-(Appears on: -IntegrationKitStatus) -

-

-

IntegrationKitPhase –

-

-

IntegrationKitSpec -

-

-(Appears on: -IntegrationKit) -

-

-

IntegrationKitSpec defines the desired state of IntegrationKit

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-image
- -string - -		 -
-dependencies
- -[]string - -		 -
-profile
- - -TraitProfile - - -		 -
-traits
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec - - -		 -
-configuration
- - -[]ConfigurationSpec - - -		 -
-repositories
- -[]string - -		 -
-

IntegrationKitStatus -

-

-(Appears on: -IntegrationKit) -

-

-

IntegrationKitStatus defines the observed state of IntegrationKit

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-phase
- - -IntegrationKitPhase - - -		 -
-baseImage
- -string - -		 -
-image
- -string - -		 -
-digest
- -string - -		 -
-artifacts
- - -[]Artifact - - -		 -
-failure
- - -Failure - - -		 -
-runtimeVersion
- -string - -		 -
-runtimeProvider
- - -RuntimeProvider - - -		 -
-platform
- -string - -		 -
-conditions
- - -[]IntegrationKitCondition - - -		 -
-version
- -string - -		 -
-

IntegrationPhase -(string alias)

-

-(Appears on: -IntegrationStatus) -

-

-

IntegrationPhase –

-

-

IntegrationPlatform -

-

-

IntegrationPlatform is the Schema for the integrationplatforms API

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -IntegrationPlatformSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-cluster
- - -IntegrationPlatformCluster - - -		 -
-profile
- - -TraitProfile - - -		 -
-build
- - -IntegrationPlatformBuildSpec - - -		 -
-resources
- - -IntegrationPlatformResourcesSpec - - -		 -
-traits
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec - - -		 -
-configuration
- - -[]ConfigurationSpec - - -		 -
-
-status
- - -IntegrationPlatformStatus - - -		 -
-

IntegrationPlatformBuildPublishStrategy -(string alias)

-

-(Appears on: -IntegrationPlatformBuildSpec) -

-

-

IntegrationPlatformBuildPublishStrategy enumerates all implemented publish strategies

-

-

IntegrationPlatformBuildSpec -

-

-(Appears on: -IntegrationPlatformSpec) -

-

-

IntegrationPlatformBuildSpec contains platform related build information

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-buildStrategy
- - -IntegrationPlatformBuildStrategy - - -		 -
-publishStrategy
- - -IntegrationPlatformBuildPublishStrategy - - -		 -
-runtimeVersion
- -string - -		 -
-runtimeProvider
- - -RuntimeProvider - - -		 -
-baseImage
- -string - -		 -
-properties
- -map[string]string - -		 -
-registry
- - -IntegrationPlatformRegistrySpec - - -		 -
-timeout
- - -Kubernetes meta/v1.Duration - - -		 -
-persistentVolumeClaim
- -string - -		 -
-maven
- - -MavenSpec - - -		 -
-httpProxySecret
- -string - -		 -
-kanikoBuildCache
- -bool - -		 -
-

IntegrationPlatformBuildStrategy -(string alias)

-

-(Appears on: -IntegrationPlatformBuildSpec) -

-

-

IntegrationPlatformBuildStrategy enumerates all implemented build strategies

-

-

IntegrationPlatformCluster -(string alias)

-

-(Appears on: -IntegrationPlatformSpec) -

-

-

IntegrationPlatformCluster is the kind of orchestration cluster the platform is installed into

-

-

IntegrationPlatformCondition -

-

-(Appears on: -IntegrationPlatformStatus) -

-

-

IntegrationPlatformCondition describes the state of a resource at a certain point.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-type
- - -IntegrationPlatformConditionType - - -		 -

Type of integration condition.

-
-status
- - -Kubernetes core/v1.ConditionStatus - - -		 -

Status of the condition, one of True, False, Unknown.

-
-lastUpdateTime
- - -Kubernetes meta/v1.Time - - -		 -

The last time this condition was updated.

-
-lastTransitionTime
- - -Kubernetes meta/v1.Time - - -		 -

Last time the condition transitioned from one status to another.

-
-reason
- -string - -		 -

The reason for the condition’s last transition.

-
-message
- -string - -		 -

A human readable message indicating details about the transition.

-
-

IntegrationPlatformConditionType -(string alias)

-

-(Appears on: -IntegrationPlatformCondition) -

-

-

IntegrationPlatformConditionType –

-

-

IntegrationPlatformPhase -(string alias)

-

-(Appears on: -IntegrationPlatformStatus) -

-

-

IntegrationPlatformPhase –

-

-

IntegrationPlatformRegistrySpec -

-

-(Appears on: -IntegrationPlatformBuildSpec) -

-

-

IntegrationPlatformRegistrySpec –

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-insecure
- -bool - -		 -
-address
- -string - -		 -
-secret
- -string - -		 -
-ca
- -string - -		 -
-organization
- -string - -		 -
-

IntegrationPlatformResourcesSpec -

-

-(Appears on: -IntegrationPlatformSpec) -

-

-

IntegrationPlatformResourcesSpec contains platform related resources

-

- - - - - - - - - - - - - -
FieldDescription
-kits
- -[]string - -		 -
-

IntegrationPlatformSpec -

-

-(Appears on: -IntegrationPlatform, -IntegrationPlatformStatus) -

-

-

IntegrationPlatformSpec defines the desired state of IntegrationPlatform

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-cluster
- - -IntegrationPlatformCluster - - -		 -
-profile
- - -TraitProfile - - -		 -
-build
- - -IntegrationPlatformBuildSpec - - -		 -
-resources
- - -IntegrationPlatformResourcesSpec - - -		 -
-traits
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec - - -		 -
-configuration
- - -[]ConfigurationSpec - - -		 -
-

IntegrationPlatformStatus -

-

-(Appears on: -IntegrationPlatform) -

-

-

IntegrationPlatformStatus defines the observed state of IntegrationPlatform

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-IntegrationPlatformSpec
- - -IntegrationPlatformSpec - - -		 -

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

-
-phase
- - -IntegrationPlatformPhase - - -		 -
-conditions
- - -[]IntegrationPlatformCondition - - -		 -
-version
- -string - -		 -
-

IntegrationSpec -

-

-(Appears on: -CamelSourceOriginSpec, -Integration) -

-

-

IntegrationSpec defines the desired state of Integration

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-replicas
- -int32 - -		 -
-sources
- - -[]SourceSpec - - -		 -
-resources
- - -[]ResourceSpec - - -		 -
-kit
- -string - -		 -
-dependencies
- -[]string - -		 -
-profile
- - -TraitProfile - - -		 -
-traits
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec - - -		 -
-configuration
- - -[]ConfigurationSpec - - -		 -
-repositories
- -[]string - -		 -
-serviceAccountName
- -string - -		 -
-

IntegrationStatus -

-

-(Appears on: -Integration) -

-

-

IntegrationStatus defines the observed state of Integration

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-phase
- - -IntegrationPhase - - -		 -
-digest
- -string - -		 -
-image
- -string - -		 -
-dependencies
- -[]string - -		 -
-profile
- - -TraitProfile - - -		 -
-kit
- -string - -		 -
-platform
- -string - -		 -
-generatedSources
- - -[]SourceSpec - - -		 -
-generatedResources
- - -[]ResourceSpec - - -		 -
-failure
- - -Failure - - -		 -
-runtimeVersion
- -string - -		 -
-runtimeProvider
- - -RuntimeProvider - - -		 -
-configuration
- - -[]ConfigurationSpec - - -		 -
-conditions
- - -[]IntegrationCondition - - -		 -
-version
- -string - -		 -
-replicas
- -int32 - -		 -
-capabilities
- -[]string - -		 -
-

Language -(string alias)

-

-(Appears on: -SourceSpec) -

-

-

Language –

-

-

MavenArtifact -

-

-(Appears on: -CamelArtifactDependency, -CamelLoader, -Capability, -RuntimeSpec) -

-

-

MavenArtifact –

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-groupId
- -string - -		 -
-artifactId
- -string - -		 -
-version
- -string - -		 -
-

MavenSpec -

-

-(Appears on: -BuilderTask, -IntegrationPlatformBuildSpec) -

-

-

MavenSpec –

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-localRepository
- -string - -		 -
-settings
- - -ValueSource - - -		 -
-timeout
- - -Kubernetes meta/v1.Duration - - -		 -
-

PlatformInjectable -

-

-

PlatformInjectable –

-

-

ResourceCondition -

-

-

ResourceCondition is a common type for all conditions

-

-

ResourceSpec -

-

-(Appears on: -BuilderTask, -IntegrationSpec, -IntegrationStatus) -

-

-

ResourceSpec –

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-DataSpec
- - -DataSpec - - -		 -
-type
- - -ResourceType - - -		 -
-mountPath
- -string - -		 -
-

ResourceType -(string alias)

-

-(Appears on: -ResourceSpec) -

-

-

ResourceType –

-

-

RuntimeProvider -(string alias)

-

-(Appears on: -IntegrationKitStatus, -IntegrationPlatformBuildSpec, -IntegrationStatus, -RuntimeSpec) -

-

-

RuntimeProvider –

-

-

RuntimeSpec -

-

-(Appears on: -BuilderTask, -CamelCatalogSpec) -

-

-

RuntimeSpec –

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-version
- -string - -		 -
-provider
- - -RuntimeProvider - - -		 -
-applicationClass
- -string - -		 -
-dependencies
- - -[]MavenArtifact - - -		 -
-metadata
- -map[string]string - -		 -
-capabilities
- - -map[string]github.com/apache/camel-k/pkg/apis/camel/v1.Capability - - -		 -
-

SourceSpec -

-

-(Appears on: -BuilderTask, -IntegrationSpec, -IntegrationStatus) -

-

-

SourceSpec –

-

- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-DataSpec
- - -DataSpec - - -		 -
-language
- - -Language - - -		 -
-loader
- -string - -		 -

Loader is an optional id of the org.apache.camel.k.RoutesLoader that will -interpret this source at runtime

-
-interceptors
- -[]string - -		 -

Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader -uses to pre/post process sources

-
-

Task -

-

-(Appears on: -BuildSpec) -

-

-

Task –

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-builder
- - -BuilderTask - - -		 -
-image
- - -ImageTask - - -		 -
-

TraitProfile -(string alias)

-

-(Appears on: -IntegrationKitSpec, -IntegrationPlatformSpec, -IntegrationSpec, -IntegrationStatus) -

-

-

TraitProfile represents lists of traits that are enabled for the specific installation/integration

-

-

TraitSpec -

-

-(Appears on: -IntegrationKitSpec, -IntegrationPlatformSpec, -IntegrationSpec) -

-

-

A TraitSpec contains the configuration of a trait

-

- - - - - - - - - - - - - -
FieldDescription
-configuration
- -map[string]string - -		 -
-

ValueSource -

-

-(Appears on: -MavenSpec) -

-

-

ValueSource –

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-configMapKeyRef
- - -Kubernetes core/v1.ConfigMapKeySelector - - -		 -

Selects a key of a ConfigMap.

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

Selects a key of a secret.

-
-
-

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

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

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

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

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

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

-

- - - - - - - - - - - - - - - - - - - - - - - @@ -19594,10 +175,10 @@ GitHubSourceStatus
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 + +Kubernetes core/v1.SecretKeySelector 		-

SecretToken is the Kubernetes secret containing the GitHub -secret token

+(Optional) +

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

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

+

Annotations to add to the pod, mostly used for Kube2IAM role
-githubAPIURL
+sink
-string + +Kubernetes core/v1.ObjectReference + 		(Optional) -

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

+

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.
-secure
+serviceAccountName
-bool +string 		-(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).

+

ServiceAccoutName is the name of the ServiceAccount that will be used to +run the Receive Adapter Deployment.
@@ -19584,8 +165,8 @@ do the right thing).

 status
- -GitHubSourceStatus + +AwsSqsSourceStatus
-

GitLabSource +

CamelSource

-

GitLabSource is the Schema for the gitlabsources API

+

CamelSource is the Schema for the camelsources API

@@ -19622,7 +203,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -19653,98 +234,40 @@ GitLabSourceSpec
GitLabSourceCamelSource
@@ -19642,8 +223,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -GitLabSourceSpec + +CamelSourceSpec
- - - - - - - - - - - - - - - -
-serviceAccountName
- -string - -		 -(Optional) -

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

-
-projectUrl
- -string - -		 -

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

-
-eventTypes
- -[]string - -		 -

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

-
-accessToken
- - -SecretValueFromSource - - -		 -

AccessToken is the Kubernetes secret containing the GitLab -access token

-
-secretToken
+source
- -SecretValueFromSource + +CamelSourceOriginSpec 		-

SecretToken is the Kubernetes secret containing the GitLab -secret token

+

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

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

+(Optional) +

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

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

+

CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.
@@ -19754,8 +277,8 @@ name to use as the sink.

status
- -GitLabSourceStatus + +CamelSourceStatus @@ -19764,10 +287,10 @@ GitLabSourceStatus -

PingSource +

CouchDbSource

-

PingSource is the Schema for the PingSources API.

+

CouchDbSource is the Schema for the githubsources API

@@ -19792,7 +315,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -19823,79 +346,68 @@ PingSourceSpec
PingSourceCouchDbSource
@@ -19812,8 +335,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -PingSourceSpec + +CouchDbSourceSpec
- - - -
-schedule
- -string - -		 -

Schedule is the cronjob schedule.

-
-data
+serviceAccountName
string 		-

Data is the data posted to the target function.

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

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

+

CouchDbCredentials is the credential to use to access CouchDb. +Must be a secret. Only Name and Namespace are used.
-ceOverrides
+feed
- -CloudEventOverrides + +FeedType 		-(Optional) -

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

+

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

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

+

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

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

+(Optional) +

Sink is a reference to an object that will resolve to a domain name to use as the sink.
@@ -19905,8 +417,8 @@ Deprecated: v1beta1 drops this field.

status
- -PingSourceStatus + +CouchDbSourceStatus @@ -19915,10 +427,10 @@ PingSourceStatus -

PrometheusSource +

GitHubSource

-

PrometheusSource is the Schema for the prometheussources API

+

GitHubSource is the Schema for the githubsources API

@@ -19943,7 +455,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -19984,93 +496,110 @@ string

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.

+in which the GitHubSource exists.

PrometheusSourceGitHubSource
@@ -19963,8 +475,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -PrometheusSourceSpec + +GitHubSourceSpec
-serverURL
+ownerAndRepository
string 		-

ServerURL is the URL of the Prometheus server

+

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
-promQL
+eventTypes
-string +[]string 		-

PromQL is the Prometheus query for this source

+

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

The name of the file containing the authenication token

+

AccessToken is the Kubernetes secret containing the GitHub +access token
-caCertConfigMap
+secretToken
-string + +SecretValueFromSource + 		-(Optional) -

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

+

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

A crontab-formatted schedule for running the PromQL query

+(Optional) +

API URL if using github enterprise (default https://api.github.com)
-step
+secure
-string +bool 		(Optional) -

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

+

Secure can be set to true to configure the webhook to use https, +or false to use http. Omitting it relies on the scheme of the +Knative Service created (e.g. if auto-TLS is enabled it should +do the right thing).
-sink
+SourceSpec
- -Destination - +knative.dev/pkg/apis/duck/v1.SourceSpec 		-(Optional) -

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

+

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

+

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

status
- -PrometheusSourceStatus + +GitHubSourceStatus @@ -20090,15 +619,10 @@ PrometheusSourceStatus -

SinkBinding +

GitLabSource

-

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.

+

GitLabSource is the Schema for the gitlabsources API

@@ -20123,7 +647,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -20154,32 +678,96 @@ SinkBindingSpec
SinkBindingGitLabSource
@@ -20143,8 +667,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -SinkBindingSpec + +GitLabSourceSpec
+ + + + + + + + + + + + + + + + + + + +
-SourceSpec
+serviceAccountName
+ +string + +		 +(Optional) +

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

+
+projectUrl
+ +string + +		 +

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

+
+eventTypes
- -SourceSpec +[]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 		-

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

+

AccessToken is the Kubernetes secret containing the GitLab +access token
-BindingSpec
+secretToken
- -BindingSpec + +SecretValueFromSource 		-

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

+

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.
@@ -20189,8 +777,8 @@ BindingSpec status
- -SinkBindingStatus + +GitLabSourceStatus @@ -20199,14 +787,10 @@ SinkBindingStatus -

ApiServerResource +

PrometheusSource

-(Appears on: -ApiServerSourceSpec) -

-

-

ApiServerResource defines the resource to watch

+

PrometheusSource is the Schema for the prometheussources API

@@ -20219,211 +803,159 @@ SinkBindingStatus +string - + - +
+
+
apiVersion
- -string - -		 -

API version of the resource to watch.

+ +sources.knative.dev/v1alpha1 +
kind
- string - -		 -

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

PrometheusSource
-labelSelector
+metadata
- -Kubernetes meta/v1.LabelSelector + +Kubernetes meta/v1.ObjectMeta 		-

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

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-controllerSelector
+spec
- -Kubernetes meta/v1.OwnerReference + +PrometheusSourceSpec 		-

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
+serviceAccountName
-bool +string 		-

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

+(Optional) +

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

ApiServerSourceSpec -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceSpec defines the desired state of ApiServerSource

-

- - - - + + - - -
FieldDescription +serverURL
+ +string + +		 +

ServerURL is the URL of the Prometheus server

+
-resources
+promQL
- -[]ApiServerResource - +string 		-

Resources is the list of resources to watch

+

PromQL is the Prometheus query for this source
-serviceAccountName
+authTokenFile
string 		(Optional) -

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

+

The name of the file containing the authenication token
-sink
+caCertConfigMap
- -Destination - +string 		(Optional) -

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

+

The name of the config map containing the CA certificate of the +Prometheus service’s signer.
-ceOverrides
+schedule
- -CloudEventOverrides - +string 		-(Optional) -

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

+

A crontab-formatted schedule for running the PromQL query
-owner
+step
- -APIVersionKind - +string 		(Optional) -

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

+

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

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

+(Optional) +

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

ApiServerSourceStatus -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceStatus defines the observed state of ApiServerSource

-

- - - - - + - - @@ -20532,9 +1064,7 @@ run the Receive Adapter Deployment.

- - - - + + + +
FieldDescription
-SourceStatus
+status
- -SourceStatus + +PrometheusSourceStatus 		-

-(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.
SourceStatus
- -SourceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus 		@@ -20573,9 +1103,7 @@ Source.

 integration
- -IntegrationSpec - +github.com/apache/camel-k/pkg/apis/camel/v1.IntegrationSpec 		@@ -20631,9 +1159,7 @@ CamelSourceOriginSpec sink
- -Destination - +knative.dev/pkg/apis/duck/v1beta1.Destination 		@@ -20645,9 +1171,7 @@ Destination ceOverrides
- -CloudEventOverrides - +knative.dev/pkg/apis/duck/v1.CloudEventOverrides 		@@ -20679,9 +1203,7 @@ modifications of the event sent to the sink.

 Status
- -Status - +knative.dev/pkg/apis/duck/v1.Status 		@@ -20782,9 +1304,7 @@ string sink
- -Destination - +knative.dev/pkg/apis/duck/v1.Destination 		@@ -20815,9 +1335,7 @@ Destination SourceStatus
- -SourceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus 		@@ -20945,21 +1463,6 @@ secret token

-sink
- - -Destination - - -		 -(Optional) -

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

-
githubAPIURL
string @@ -20985,6 +1488,24 @@ Knative Service created (e.g. if auto-TLS is enabled it should do the right thing).
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

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

+

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

+

GitHubSourceStatus @@ -21008,9 +1529,7 @@ do the right thing).

SourceStatus
- -SourceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus @@ -21141,9 +1660,7 @@ bool sink
- -Destination - +knative.dev/pkg/apis/duck/v1.Destination @@ -21175,9 +1692,7 @@ name to use as the sink.

SourceStatus
- -SourceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus @@ -21406,120 +1921,7 @@ string sink
- -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 - - - - - - - - -

KafkaSourceSpec -

-

-(Appears on: -KafkaSource) -

-

-

KafkaSourceSpec defines the desired state of the KafkaSource.

-

- - - - - - - - - - - - - - - - - - - - - - @@ -21549,162 +1952,19 @@ KafkaResourceSpec - - -
FieldDescription
-KafkaAuthSpec
- - -KafkaAuthSpec - - -		 -

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

-
-topics
- -[]string - -		 -

Topic topics to consume messages from

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

ConsumerGroupID is the consumer group ID.

-
-sink
- - -Destination - +knative.dev/pkg/apis/duck/v1.Destination 		@@ -21536,7 +1938,8 @@ string

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

+Adapter Deployment. +Deprecated: v1beta1 drops this field.
-

Resource limits and Request specifications of the Receive Adapter Deployment

-
-

KafkaSourceStatus -

-

-(Appears on: -KafkaSource) -

-

-

KafkaSourceStatus defines the observed state of KafkaSource.

-

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

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

 +
-limits
+status
- -PingLimitsSpec + +KafkaSourceStatus @@ -21713,14 +1973,14 @@ PingLimitsSpec -

PingSourceSpec +

KafkaSourceSpec

(Appears on: -PingSource) +KafkaSource)

-

PingSourceSpec defines the desired state of the PingSource.

+

KafkaSourceSpec defines the desired state of the KafkaSource.

@@ -21732,52 +1992,52 @@ PingLimitsSpec @@ -21797,8 +2057,8 @@ Deprecated: v1beta1 drops this field.

@@ -21809,14 +2069,14 @@ Deprecated: v1beta1 drops this field.

-schedule
+KafkaAuthSpec
-string + +KafkaAuthSpec + 		-

Schedule is the cronjob schedule.

+

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

Data is the data posted to the target function.

+

Topic topics to consume messages from
-sink
+consumerGroup
- -Destination - +string 		-

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

+(Optional) +

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

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

+

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

PingSourceStatus +

KafkaSourceStatus

(Appears on: -PingSource) +KafkaSource)

-

PingSourceStatus defines the observed state of PingSource.

+

KafkaSourceStatus defines the observed state of KafkaSource.

@@ -21830,9 +2090,7 @@ Deprecated: v1beta1 drops this field.

SourceStatus
- -SourceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus 		@@ -21957,9 +2215,7 @@ Prometheus duration strings are of the form [0-9]+[smhdwy].

 sink
- -Destination - +knative.dev/pkg/apis/duck/v1.Destination 		@@ -21991,9 +2247,7 @@ name to use as the sink.

 SourceStatus
- -SourceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus 		@@ -22015,7 +2269,7 @@ Source.

(Appears on: -GitHubSourceSpec) +GitLabSourceSpec)

SecretValueFromSource represents the source of a secret value

@@ -22047,7 +2301,7 @@ Kubernetes core/v1.SecretKeySelector

(Appears on: -GitLabSourceSpec) +GitHubSourceSpec)

SecretValueFromSource represents the source of a secret value

@@ -22075,89 +2329,6 @@ Kubernetes core/v1.SecretKeySelector
-

SinkBindingSpec -

-

-(Appears on: -SinkBinding) -

-

-

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

-

- - - - - - - - - - - - - - - - - -
FieldDescription
-SourceSpec
- - -SourceSpec - - -		 -

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

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

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

-

bindings.knative.dev/v1alpha1

@@ -22235,9 +2406,7 @@ GitHubBindingSpec BindingSpec
- -BindingSpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec @@ -22343,9 +2512,7 @@ GitLabBindingSpec BindingSpec
- -BindingSpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec @@ -22406,9 +2573,7 @@ GitLabBindingStatus BindingSpec
- -BindingSpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec @@ -22454,9 +2619,7 @@ access token

SourceStatus
- -SourceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus @@ -22488,9 +2651,7 @@ SourceStatus BindingSpec
- -BindingSpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec @@ -22536,9 +2697,7 @@ access token

SourceStatus
- -SourceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus @@ -22635,9 +2794,7 @@ KafkaBindingSpec BindingSpec
- -BindingSpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec @@ -22699,9 +2856,7 @@ KafkaBindingStatus BindingSpec
- -BindingSpec - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec @@ -22748,9 +2903,7 @@ KafkaAuthSpec Status
- -Status - +knative.dev/pkg/apis/duck/v1.Status @@ -22933,8 +3086,7 @@ SecretValueFromSource

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

SecretValueFromSource represents the source of a secret value

@@ -22966,7 +3118,8 @@ Kubernetes core/v1.SecretKeySelector

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

SecretValueFromSource represents the source of a secret value

@@ -22998,7 +3151,7 @@ Kubernetes core/v1.SecretKeySelector

(Appears on: -GitHubBindingSpec) +GitLabBindingSpec)

SecretValueFromSource represents the source of a secret value

@@ -23026,27 +3179,133 @@ Kubernetes core/v1.SecretKeySelector -
-

messaging.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

Channel +
+

messaging.knative.dev/v1alpha1

+

+

Package v1alpha1 is the v1alpha1 version of the API.

+

+Resource Types: + +

KafkaChannel +

+

+

KafkaChannel is a resource representing a Kafka Channel.

+

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

Spec defines the desired state of the Channel.

+
+
+ + + + + + + + + + + + + +
+numPartitions
+ +int32 + +		 +

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

+
+replicationFactor
+ +int16 + +		 +

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

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

KafkaChannel conforms to Duck type Subscribable.

+
+
+status
+ + +KafkaChannelStatus + + +		 +(Optional) +

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

+
+

NatssChannel

-

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

+

NatssChannel is a resource representing a NATSS Channel.

@@ -23071,7 +3330,7 @@ messaging.knative.dev/v1alpha1 kind
string - + @@ -23104,68 +3363,95 @@ ChannelSpec
ChannelNatssChannel
@@ -23092,8 +3351,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -ChannelSpec + +NatssChannelSpec
+ +
-channelTemplate
+subscribable
- -ChannelTemplateSpec - +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable 		-

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

+

NatssChannel conforms to Duck type Subscribable.

+
-subscribable
+status
- -Subscribable + +NatssChannelStatus -

Channel conforms to Duck type Subscribable.

+(Optional) +

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

+ + +

KafkaChannelSpec +

+

+(Appears on: +KafkaChannel) +

+

+

KafkaChannelSpec defines the specification for a KafkaChannel.

+

+ + + + + + + + -
FieldDescription
-delivery
+numPartitions
- -DeliverySpec - +int32 		-

Delivery options.

+

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

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

-status
+subscribable
- -ChannelStatus - +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable -(Optional) -

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

+

KafkaChannel conforms to Duck type Subscribable.

-

InMemoryChannel +

KafkaChannelStatus

-

InMemoryChannel is a resource representing an in memory channel

+(Appears on: +KafkaChannel) +

+

+

KafkaChannelStatus represents the current state of a KafkaChannel.

@@ -23177,97 +3463,159 @@ date.

- - - - + + +
-apiVersion
-string		 - -messaging.knative.dev/v1alpha1 - +Status
+ +knative.dev/pkg/apis/duck/v1.Status +
-kind
-string +

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

+

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

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

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

+

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

+

It generally has the form {channel}.{namespace}.svc.{cluster domain name}
-spec
+SubscribableTypeStatus
- -InMemoryChannelSpec - +knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus 		-

Spec defines the desired state of the Channel.

-
-
+

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

+

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

+
+

NatssChannelSpec +

+

+(Appears on: +NatssChannel) +

+

+

NatssChannelSpec defines the specification for a NatssChannel.

+

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

Channel conforms to Duck type Subscribable.

+

NatssChannel conforms to Duck type Subscribable.
+

NatssChannelStatus +

+

+(Appears on: +NatssChannel) +

+

+

NatssChannelStatus represents the current state of a NatssChannel.

+

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

For round tripping (v1beta1 <-> v1alpha1>

+

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

+

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

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

+

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

+

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

-status
+SubscribableTypeStatus
- -InMemoryChannelStatus - +knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus -(Optional) -

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

+

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

+

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

-

KafkaChannel +
+

messaging.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

KafkaChannel

KafkaChannel is a resource representing a Kafka Channel.

@@ -23286,7 +3634,7 @@ date.

string -messaging.knative.dev/v1alpha1 +messaging.knative.dev/v1beta1 @@ -23316,7 +3664,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + KafkaChannelSpec @@ -23350,15 +3698,16 @@ int16 -subscribable
+ChannelableSpec
- -Subscribable - +knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec -

KafkaChannel conforms to Duck type Subscribable.

+

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

+

Channel conforms to Duck type Channelable.

@@ -23368,7 +3717,7 @@ Subscribable status
- + KafkaChannelStatus @@ -23381,10 +3730,14 @@ date.

-

NatssChannel +

KafkaChannelSpec

-

NatssChannel is a resource representing a NATSS Channel.

+(Appears on: +KafkaChannel) +

+

+

KafkaChannelSpec defines the specification for a KafkaChannel.

@@ -23396,88 +3749,50 @@ date.

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

Spec defines the desired state of the Channel.

-
-
- +

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

+ + - -
-subscribable
+replicationFactor
- -Subscribable - +int16 		-

NatssChannel conforms to Duck type Subscribable.

-
+

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

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

+

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

+

Channel conforms to Duck type Channelable.
-

Subscription +

KafkaChannelStatus

-

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

+(Appears on: +KafkaChannel) +

+

+

KafkaChannelStatus represents the current state of a KafkaChannel.

@@ -23489,125 +3804,135 @@ corresponds to the subscriptions.channels.knative.dev CRD.

+ChannelableStatus
+ +knative.dev/eventing/pkg/apis/duck/v1.ChannelableStatus + + + +
-apiVersion
-string		 - -messaging.knative.dev/v1alpha1 - +

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

+

Channel conforms to Duck type Channelable.
+
+

bindings.knative.dev/v1beta1

+

+

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

+

+Resource Types: + +

KafkaAuthSpec +

+

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

+

+

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

Bootstrap servers are the Kafka servers the consumer will connect to.
-spec
+net
- -SubscriptionSpec + +KafkaNetSpec 		-
-
+
+

KafkaBinding +

+

+

KafkaBinding is the Schema for the kafkasources API.

+

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

TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

-

We should be able to drop this property with a CRD conversion webhook -in the future

-		FieldDescription
-channel
+metadata
- -Kubernetes core/v1.ObjectReference + +Kubernetes meta/v1.ObjectMeta 		-

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

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-subscriber
+spec
- -Destination + +KafkaBindingSpec 		-(Optional) -

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

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

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

+

+(Members of BindingSpec are embedded into this type.) +
-delivery
+KafkaAuthSpec
- -DeliverySpec + +KafkaAuthSpec 		-(Optional) -

Delivery configuration

+

+(Members of KafkaAuthSpec are embedded into this type.) +
@@ -23617,8 +3942,8 @@ DeliverySpec status
- -SubscriptionStatus + +KafkaBindingStatus @@ -23627,15 +3952,14 @@ SubscriptionStatus -

ChannelSpec +

KafkaBindingSpec

(Appears on: -Channel) +KafkaBinding)

-

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

+

KafkaBindingSpec defines the desired state of the KafkaBinding.

@@ -23647,54 +3971,42 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba - - - -
-channelTemplate
- - -ChannelTemplateSpec - - -		 -

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

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

Channel conforms to Duck type Subscribable.

+

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

Delivery options.

+

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

ChannelStatus +

KafkaBindingStatus

(Appears on: -Channel) +KafkaBinding)

-

ChannelStatus represents the current state of a Channel.

+

KafkaBindingStatus defines the observed state of KafkaBinding.

@@ -23708,80 +4020,24 @@ DeliverySpec - - - - - - - - - - - -
Status
- -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
- - -AddressStatus - - -		 -

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

-

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

-

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

-
-SubscribableTypeStatus
- - -SubscribableTypeStatus - - -		 -

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

-

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

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

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

InMemoryChannelSpec +

KafkaNetSpec

(Appears on: -InMemoryChannel) +KafkaAuthSpec)

-

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

@@ -23793,40 +4049,37 @@ arguments for a Channel.

-subscribable
+sasl
- -Subscribable + +KafkaSASLSpec 		-

Channel conforms to Duck type Subscribable.
-delivery
+tls
- -DeliverySpec + +KafkaTLSSpec 		-

For round tripping (v1beta1 <-> v1alpha1>
-

InMemoryChannelStatus +

KafkaSASLSpec

(Appears on: -InMemoryChannel) +KafkaNetSpec)

-

ChannelStatus represents the current state of a Channel.

@@ -23838,67 +4091,51 @@ DeliverySpec
-Status
+enable
- -Status - +bool 		-

-(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
+user
- -AddressStatus + +SecretValueFromSource 		-

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

-

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

-

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

+(Optional) +

User is the Kubernetes secret containing the SASL username.
-SubscribableTypeStatus
+password
- -SubscribableTypeStatus + +SecretValueFromSource 		-

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

-

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

+(Optional) +

Password is the Kubernetes secret containing the SASL password.
-

KafkaChannelSpec +

KafkaTLSSpec

(Appears on: -KafkaChannel) +KafkaNetSpec)

-

KafkaChannelSpec defines the specification for a KafkaChannel.

@@ -23910,49 +4147,67 @@ SubscribableTypeStatus + + + +
-numPartitions
+enable
-int32 +bool 		-

NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.
-replicationFactor
+cert
+ + +SecretValueFromSource + + +		 +(Optional) +

Cert is the Kubernetes secret containing the client certificate.

+
+key
-int16 + +SecretValueFromSource + 		-

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

+(Optional) +

Key is the Kubernetes secret containing the client key.
-subscribable
+caCert
- -Subscribable + +SecretValueFromSource 		-

KafkaChannel conforms to Duck type Subscribable.

+(Optional) +

CACert is the Kubernetes secret containing the server CA cert.
-

KafkaChannelStatus +

SecretValueFromSource

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

-

KafkaChannelStatus represents the current state of a KafkaChannel.

+

SecretValueFromSource represents the source of a secret value

@@ -23964,67 +4219,71 @@ Subscribable + + +
-Status
+secretKeyRef
- -Status + +Kubernetes core/v1.SecretKeySelector 		+

The Secret key to select from.

+
+
+

sources.knative.dev/v1beta1

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

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

-

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

- +Resource Types: + +

KafkaLimitsSpec +

+

+(Appears on: +KafkaResourceSpec) +

+

+

+ + + + + + +
FieldDescription
-AddressStatus
+cpu
- -AddressStatus - +string 		-

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

-

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

-

It generally has the form {channel}.{namespace}.svc.{cluster domain name}
-SubscribableTypeStatus
+memory
- -SubscribableTypeStatus - +string 		-

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

-

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

NatssChannelSpec +

KafkaRequestsSpec

(Appears on: -NatssChannel) +KafkaResourceSpec)

-

NatssChannelSpec defines the specification for a NatssChannel.

@@ -24036,27 +4295,29 @@ SubscribableTypeStatus + + + +
-subscribable
+cpu
- -Subscribable - +string + +		 +
+memory
+ +string 		-

NatssChannel conforms to Duck type Subscribable.
-

NatssChannelStatus +

KafkaResourceSpec

-(Appears on: -NatssChannel) -

-

-

NatssChannelStatus represents the current state of a NatssChannel.

@@ -24068,78 +4329,34 @@ Subscribable - - - -
-Status
- - -Status - - -		 -

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

-

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

-
-AddressStatus
+requests
- -AddressStatus + +KafkaRequestsSpec 		-

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

-

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

-

It generally has the form {channel}.{namespace}.svc.{cluster domain name}
-SubscribableTypeStatus
+limits
- -SubscribableTypeStatus + +KafkaLimitsSpec 		-

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

-

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

SubscriptionSpec +

KafkaSource

-(Appears on: -Subscription) -

-

-

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

-

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

+

KafkaSource is the Schema for the kafkasources API.

@@ -24151,93 +4368,112 @@ channel –> reply

+
-generation
+metadata
-int64 + +Kubernetes meta/v1.ObjectMeta + 		-(Optional) -

TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

-

We should be able to drop this property with a CRD conversion webhook -in the future

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-channel
+spec
- -Kubernetes core/v1.ObjectReference + +KafkaSourceSpec + + +		 +
+
+ + + + + + + + +
+KafkaAuthSpec
+ + +KafkaAuthSpec 		-

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

+

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

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

+

Topic topics to consume messages from
-reply
+consumerGroup
- -Destination - +string 		(Optional) -

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

+

ConsumerGroupID is the consumer group ID.

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

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

+

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

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

Delivery configuration
-

SubscriptionStatus +

KafkaSourceSpec

(Appears on: -Subscription) +KafkaSource)

-

SubscriptionStatus (computed) for a subscription

+

KafkaSourceSpec defines the desired state of the KafkaSource.

@@ -24249,86 +4485,97 @@ DeliverySpec - -
-Status
+KafkaAuthSpec
- -Status + +KafkaAuthSpec

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

-

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

PhysicalSubscription is the fully resolved values that this Subscription represents.

+

Topic topics to consume messages from
-

SubscriptionStatusPhysicalSubscription -

-

-(Appears on: -SubscriptionStatus) -

-

-

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

-

- - - - - - - - + +
FieldDescription
-subscriberURI
+consumerGroup
-knative.dev/pkg/apis.URL +string 		-

SubscriberURI is the fully resolved URI for spec.subscriber.

+(Optional) +

ConsumerGroupID is the consumer group ID.
-replyURI
+SourceSpec
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.SourceSpec 		-

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

+

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

+

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

KafkaSourceStatus +

+

+(Appears on: +KafkaSource) +

+

+

KafkaSourceStatus defines the observed state of KafkaSource.

+

+ + + + + + + + @@ -24336,5 +4583,5 @@ knative.dev/pkg/apis.URL

Generated with gen-crd-api-reference-docs -on git commit 709e07fc. +on git commit 9cefcda1.

diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index c674df363d..7a05180205 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,51 +1,53 @@

Packages:

-

duck.knative.dev/v1alpha1

+

flows.knative.dev/v1beta1

-

Package v1alpha1 is the v1alpha1 version of the API.

+

Package v1beta1 is the v1beta1 version of the API.

Resource Types: -

Channelable +

Parallel

-

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.

+

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

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

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

+

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

+

inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.
@@ -65,6 +67,7 @@ Kubernetes meta/v1.ObjectMeta @@ -73,43 +76,55 @@ Refer to the Kubernetes API documentation for the fields of the
+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ChannelableSpec + +ParallelSpec 		-

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

+

Spec defines the desired state of the Parallel.



+ + + +
-SubscribableTypeSpec
+branches
- -SubscribableTypeSpec + +[]ParallelBranch 		-

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

+

Branches is the list of Filter/Subscribers pairs.
-delivery
+channelTemplate
- -DeliverySpec + +ChannelTemplateSpec 		(Optional) -

DeliverySpec contains options controlling the event delivery

+

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

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

Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply
@@ -119,24 +134,26 @@ DeliverySpec 		status
- -ChannelableStatus + +ParallelStatus 		+(Optional) +

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

ChannelableCombined +

ParallelBranch

-

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.

+(Appears on: +ParallelSpec) +

+

@@ -148,62 +165,38 @@ This is not a real resource.

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

Filter is the expression guarding the branch
-spec
- - -ChannelableCombinedSpec - - -		 -

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

-
-
- - - @@ -217,34 +210,21 @@ DeliverySpec - -
-SubscribableTypeSpec
+subscriber
- -SubscribableTypeSpec - +knative.dev/pkg/apis/duck/v1.Destination 		-

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

-

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

+

Subscriber receiving the event when the filter passes
-SubscribableSpec
+reply
- -SubscribableSpec - +knative.dev/pkg/apis/duck/v1.Destination 		-

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

-

SubscribableSpec is for the v1beta1 spec compatibility.

+(Optional) +

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

DeliverySpec contains options controlling the event delivery

-
-
-status
- - -ChannelableCombinedStatus - - -		 +

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

ChannelableCombinedSpec +

ParallelBranchStatus

(Appears on: -ChannelableCombined) +ParallelStatus)

-

ChannelableSpec contains Spec of the Channelable object

+

ParallelBranchStatus represents the current state of a Parallel branch

@@ -256,60 +236,53 @@ ChannelableCombinedStatus
-SubscribableTypeSpec
+filterSubscriptionStatus
- -SubscribableTypeSpec + +ParallelSubscriptionStatus 		-

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

-

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

+

FilterSubscriptionStatus corresponds to the filter subscription status.
-SubscribableSpec
+filterChannelStatus
- -SubscribableSpec + +ParallelChannelStatus 		-

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

-

SubscribableSpec is for the v1beta1 spec compatibility.

+

FilterChannelStatus corresponds to the filter channel status.
-delivery
+subscriberSubscriptionStatus
- -DeliverySpec + +ParallelSubscriptionStatus 		-(Optional) -

DeliverySpec contains options controlling the event delivery

+

SubscriptionStatus corresponds to the subscriber subscription status.
-

ChannelableCombinedStatus +

ParallelChannelStatus

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

-

ChannelableStatus contains the Status of a Channelable object.

@@ -321,138 +294,97 @@ DeliverySpec + + +
-Status
+channel
-knative.dev/pkg/apis/duck/v1.Status + +Kubernetes core/v1.ObjectReference + 		-

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

-

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

+

Channel is the reference to the underlying channel.
-AddressStatus
+ready
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus +knative.dev/pkg/apis.Condition 		+

ReadyCondition indicates whether the Channel is ready or not.

+
+

ParallelSpec +

-(Members of AddressStatus are embedded into this type.) +(Appears on: +Parallel)

-

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

- +

+

+ + + + + + + - - - - - - -
FieldDescription
-SubscribableTypeStatus
+branches
- -SubscribableTypeStatus + +[]ParallelBranch 		-

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

-

SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

+

Branches is the list of Filter/Subscribers pairs.
-SubscribableStatus
+channelTemplate
- -SubscribableStatus - - -		 -

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

-

SubscribableStatus is the v1beta1 part of the Subscribers status.

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

+

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace).
-delivery
+reply
- -DeliverySpec - +knative.dev/pkg/apis/duck/v1.Destination 		(Optional) -

DeliverySpec contains options controlling the event delivery

+

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

ChannelableStatus +

ParallelStatus

(Appears on: -Channelable) +Parallel)

-

ChannelableStatus contains the Status of a Channelable object.

+

ParallelStatus represents the current state of a Parallel.

@@ -480,91 +412,56 @@ knative.dev/pkg/apis/duck/v1.Status - - -
-AddressStatus
+ingressChannelStatus
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus + +ParallelChannelStatus + 		-

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

-

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

+

IngressChannelStatus corresponds to the ingress channel status.
-SubscribableTypeStatus
+branchStatuses
- -SubscribableTypeStatus + +[]ParallelBranchStatus 		-

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

-

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

+

BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order.
-errorChannel
+AddressStatus
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.AddressStatus 		-(Optional) -

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

-
-

Resource -

-

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

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

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

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

Subscribable +

ParallelSubscriptionStatus

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

-

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

@@ -576,58 +473,35 @@ section of the resource.

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

This is the list of subscriptions for this subscribable.

+

Subscription is the reference to the underlying Subscription.
-

SubscribableStatus -

-

-(Appears on: -SubscribableTypeStatus) -

-

-

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

-

- - - - - - - -
FieldDescription
-subscribers
+ready
- -[]SubscriberStatus - +knative.dev/pkg/apis.Condition 		-

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

+

ReadyCondition indicates whether the Subscription is ready or not.
-

SubscribableType +

Sequence

-

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

+

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

@@ -647,6 +521,7 @@ Kubernetes meta/v1.ObjectMeta @@ -655,27 +530,55 @@ Refer to the Kubernetes API documentation for the fields of the
+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -SubscribableTypeSpec + +SequenceSpec 		-

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

+

Spec defines the desired state of the Sequence.



+ + + + + + + +
-subscribable
+steps
- -Subscribable + +[]SequenceStep + + +		 +

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

+
+channelTemplate
+ + +ChannelTemplateSpec 		+(Optional) +

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

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

Reply is a Reference to where the result of the last Subscriber gets sent to.
@@ -685,28 +588,26 @@ Subscribable 		status
- -SubscribableTypeStatus + +SequenceStatus 		-

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

+(Optional) +

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

SubscribableTypeSpec +

SequenceChannelStatus

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

-

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

@@ -718,30 +619,37 @@ configured as to be compatible with Subscribable contract.

+ + + +
-subscribable
+channel
- -Subscribable + +Kubernetes core/v1.ObjectReference 		+

Channel is the reference to the underlying channel.

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

ReadyCondition indicates whether the Channel is ready or not.
-

SubscribableTypeStatus +

SequenceSpec

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

-

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

@@ -753,30 +661,55 @@ Subscribable + + + + + + + +
-subscribableStatus
+steps
- -SubscribableStatus + +[]SequenceStep + + +		 +

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

+
+channelTemplate
+ + +ChannelTemplateSpec 		+(Optional) +

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

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

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

SubscriberSpec +

SequenceStatus

(Appears on: -Subscribable) +Sequence)

-

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

+

SequenceStatus represents the current state of a Sequence.

@@ -788,59 +721,94 @@ At least one of SubscriberURI and ReplyURI must be present

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

UID is used to understand the origin of the subscriber.

+

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

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
-generation
+subscriptionStatuses
-int64 + +[]SequenceSubscriptionStatus + 		-(Optional) -

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

+

SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order.
-subscriberURI
+channelStatuses
-knative.dev/pkg/apis.URL + +[]SequenceChannelStatus + 		-(Optional) +

ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order.
-replyURI
+AddressStatus
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.AddressStatus 		-(Optional) +

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

+

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

SequenceStep +

+

+(Appears on: +SequenceSpec) +

+

+

+ + + + + + + + @@ -854,31 +822,71 @@ DeliverySpec + + +
FieldDescription
-deadLetterSink
+Destination
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination 		-(Optional) +

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

+

Subscriber receiving the step event
(Optional) +

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

+
+

SequenceSubscriptionStatus +

+

+(Appears on: +SequenceStatus) +

+

+

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

Subscription is the reference to the underlying Subscription.

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

ReadyCondition indicates whether the Subscription is ready or not.
-

eventing.knative.dev/v1alpha1

+

messaging.knative.dev/v1beta1

-

Package v1alpha1 is the v1alpha1 version of the API.

+

Package v1beta1 is the v1beta1 version of the API.

Resource Types: -

Broker +

Channel

-

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

+

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

@@ -894,7 +902,7 @@ Addressable endpoint.

string @@ -903,7 +911,7 @@ eventing.knative.dev/v1alpha1 kind
string - +
-eventing.knative.dev/v1alpha1 +messaging.knative.dev/v1beta1
BrokerChannel
@@ -924,19 +932,19 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -BrokerSpec + +ChannelSpec 		-

Spec defines the desired state of the Broker.

+

Spec defines the desired state of the Channel.



- - - -
-channelTemplateSpec
+channelTemplate
ChannelTemplateSpec @@ -944,42 +952,24 @@ 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.

+

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

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

+

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

+

Channel conforms to ChannelableSpec
@@ -989,22 +979,23 @@ create subscriptions.

 status
- -BrokerStatus + +ChannelStatus 		(Optional) -

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

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

EventType +

InMemoryChannel

+

InMemoryChannel is a resource representing an in memory channel

@@ -1020,7 +1011,7 @@ date.

string @@ -1029,7 +1020,7 @@ eventing.knative.dev/v1alpha1 kind
string - + - - - - - - - - - -
-eventing.knative.dev/v1alpha1 +messaging.knative.dev/v1beta1
EventTypeInMemoryChannel
@@ -1050,103 +1041,57 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -EventTypeSpec + +InMemoryChannelSpec 		-

Spec defines the desired state of the EventType.

+

Spec defines the desired state of the Channel.



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

Type represents the CloudEvents type. It is authoritative.

+

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

+

Channel conforms to Duck type Channelable.
-source
- -string - -		 -(Optional) -

Source is a URI, it represents the CloudEvents source.

+
-schema
+status
-string + +InMemoryChannelStatus + 		(Optional) -

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

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

+

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

-

Trigger +

Subscription

-

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

+

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

@@ -1162,7 +1107,7 @@ Broker’s event pool.

string @@ -1171,7 +1116,7 @@ eventing.knative.dev/v1alpha1 kind
string - + @@ -1192,53 +1136,81 @@ Refer to the Kubernetes API documentation for the fields of the
-eventing.knative.dev/v1alpha1 +messaging.knative.dev/v1beta1
TriggerSubscription
@@ -1183,7 +1128,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -TriggerSpec + +SubscriptionSpec 		-

Spec defines the desired state of the Trigger.



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

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

+

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

+

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

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

+

Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a Destination as specified by the Reply.
-subscriber
+reply
knative.dev/pkg/apis/duck/v1.Destination 		-

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

+(Optional) +

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

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

Delivery configuration
@@ -1248,26 +1220,31 @@ is required.

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

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

BrokerSpec +

ChannelDefaulter +

+

+

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

+

+

ChannelSpec

(Appears on: -Broker) +Channel)

+

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

@@ -1279,7 +1256,7 @@ date.

- - - -
-channelTemplateSpec
+channelTemplate
ChannelTemplateSpec @@ -1287,54 +1264,36 @@ 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.

+

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

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

+

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

+

Channel conforms to ChannelableSpec
-

BrokerStatus +

ChannelStatus

(Appears on: -Broker) +Channel)

-

BrokerStatus represents the current state of a Broker.

+

ChannelStatus represents the current state of a Channel.

@@ -1346,54 +1305,40 @@ create subscriptions.

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

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

-

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

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

+

Channel conforms to ChannelableStatus
-triggerChannel
+channel
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.KReference 		-

TriggerChannel is an objectref to the object for the TriggerChannel

+

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

EventTypeSpec +

ChannelTemplateSpec

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

@@ -1407,75 +1352,81 @@ Kubernetes core/v1.ObjectReference -type
+spec
-string +k8s.io/apimachinery/pkg/runtime.RawExtension -

Type represents the CloudEvents type. It is authoritative.

+(Optional) +

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

+
+
+ +
+ + +

ChannelTemplateSpecInternal +

+

+

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

+

+ + - - + + + + - - - -
-source
- -string - -		 -(Optional) -

Source is a URI, it represents the CloudEvents source.

-		FieldDescription
-schema
+metadata
-string + +Kubernetes meta/v1.ObjectMeta + 		(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.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-broker
+spec
-string +k8s.io/apimachinery/pkg/runtime.RawExtension 		(Optional) -

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

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

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

+

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

+
+
+ +
-

EventTypeStatus +

InMemoryChannelSpec

(Appears on: -EventType) +InMemoryChannel)

-

EventTypeStatus represents the current state of a EventType.

+

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

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

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

-

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

+

Channel conforms to Duck type Channelable.
-

TriggerFilter +

InMemoryChannelStatus

(Appears on: -TriggerSpec) +InMemoryChannel)

+

ChannelStatus represents the current state of a Channel.

@@ -1521,61 +1473,41 @@ knative.dev/pkg/apis/duck/v1.Status - - - -
-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
+ChannelableStatus
- -TriggerFilterAttributes + +ChannelableStatus 		-(Optional) -

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

-

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

+

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

+

Channel conforms to Duck type Channelable.
-

TriggerFilterAttributes -(map[string]string alias)

-

-(Appears on: -TriggerFilter) -

-

-

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

-

-

TriggerFilterSourceAndType +

SubscriptionSpec

(Appears on: -TriggerFilter) +Subscription)

-

TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and -source attributes. Only exact matches will pass the filter. Either or both type and source can -use the value “ to indicate all strings match.

+

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

+

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

@@ -1587,33 +1519,82 @@ use the value “ to indicate all strings match.

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

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

+

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

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

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

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

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

Delivery configuration
-

TriggerSpec +

SubscriptionStatus

(Appears on: -Trigger) +Subscription)

+

SubscriptionStatus (computed) for a subscription

@@ -1625,53 +1606,44 @@ string - - - -
-broker
+Status
-string +knative.dev/pkg/apis/duck/v1.Status 		-

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

+

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

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
-filter
+physicalSubscription
- -TriggerFilter + +SubscriptionStatusPhysicalSubscription 		-(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.

+

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

TriggerStatus +

SubscriptionStatusPhysicalSubscription

(Appears on: -Trigger) +SubscriptionStatus)

-

TriggerStatus represents the current state of a Trigger.

+

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

@@ -1683,54 +1655,58 @@ is required.

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

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

-

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

+

SubscriberURI is the fully resolved URI for spec.subscriber.
-subscriberURI
+replyUri
knative.dev/pkg/apis.URL 		-

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

+

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

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

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

eventing.knative.dev/v1beta1

+

sources.knative.dev/v1alpha2

-

Package v1beta1 is the v1beta1 version of the API.

+

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

Resource Types: -

Broker +

ApiServerSource

-

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

+

ApiServerSource is the Schema for the apiserversources API

@@ -1746,7 +1722,7 @@ Addressable endpoint.

string @@ -1755,7 +1731,7 @@ eventing.knative.dev/v1beta1 kind
string - + @@ -1776,68 +1751,113 @@ Refer to the Kubernetes API documentation for the fields of the + + + + + + + + + + + + +
-eventing.knative.dev/v1beta1 +sources.knative.dev/v1alpha2
BrokerApiServerSource
@@ -1767,7 +1743,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -BrokerSpec + +ApiServerSourceSpec 		-

Spec defines the desired state of the Broker.



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

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

+

+(Members of 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.
-delivery
+resources
- -DeliverySpec + +[]APIVersionKindSelector 		-(Optional) -

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

+

Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter.
-
+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
- -BrokerStatus + +ApiServerSourceStatus -(Optional) -

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

-

EventType +

ContainerSource

+

ContainerSource is the Schema for the containersources API

@@ -1853,7 +1873,7 @@ date.

string @@ -1862,7 +1882,7 @@ eventing.knative.dev/v1beta1 kind
string - + @@ -1883,89 +1902,44 @@ Refer to the Kubernetes API documentation for the fields of the
-eventing.knative.dev/v1beta1 +sources.knative.dev/v1alpha2
EventTypeContainerSource
@@ -1874,7 +1894,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -EventTypeSpec + +ContainerSourceSpec 		-

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

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

+

+(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.
-description
+template
-string + +Kubernetes core/v1.PodTemplateSpec + 		-(Optional) -

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

+

Template describes the pods that will be created
@@ -1975,25 +1949,20 @@ string 		status
- -EventTypeStatus + +ContainerSourceStatus 		-(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 +

PingSource

-

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

+

PingSource is the Schema for the PingSources API.

@@ -2009,7 +1978,7 @@ Broker’s event pool.

string @@ -2018,7 +1987,7 @@ eventing.knative.dev/v1beta1 kind
string - + @@ -2039,53 +2007,57 @@ Refer to the Kubernetes API documentation for the fields of the
-eventing.knative.dev/v1beta1 +sources.knative.dev/v1alpha2
TriggerPingSource
@@ -2030,7 +1999,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -TriggerSpec + +PingSourceSpec 		-

Spec defines the desired state of the Trigger.



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

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

+

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

+

Schedule is the cronjob schedule. Defaults to * * * * *.
-subscriber
+jsonData
-knative.dev/pkg/apis/duck/v1.Destination +string 		-

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

+(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”.
@@ -2095,26 +2067,25 @@ is required.

 status
- -TriggerStatus + +PingSourceStatus 		-(Optional) -

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

BrokerSpec +

SinkBinding

-(Appears on: -Broker) -

-

+

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.

@@ -2126,89 +2097,108 @@ date.

+ + + + - -
-config
- -knative.dev/pkg/apis/duck/v1.KReference - +apiVersion
+string		 + +sources.knative.dev/v1alpha2 +
-(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.

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

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

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

BrokerStatus -

-

-(Appears on: -Broker) -

-

-

BrokerStatus represents the current state of a Broker.

-

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

+
-Status
+BindingSpec
-knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec

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

-

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

+

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

+
-address
+status
-knative.dev/pkg/apis/duck/v1.Addressable + +SinkBindingStatus + -

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

-

EventTypeSpec +

APIVersionKind

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

+

APIVersionKind is an APIVersion and Kind tuple.

@@ -2220,89 +2210,95 @@ delivered into the Broker mesh.

+ +
-type
+apiVersion
string 		-

Type represents the CloudEvents type. It is authoritative.

+

APIVersion - the API version of the resource to watch.
-source
+kind
-knative.dev/pkg/apis.URL +string 		-(Optional) -

Source is a URI, it represents the CloudEvents source.

+

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.

+

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

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

+

APIVersion - the API version of the resource to watch.
-broker
+kind
string 		-(Optional) -

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

+

Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-description
+selector
-string + +Kubernetes meta/v1.LabelSelector + 		(Optional) -

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

+

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
-

EventTypeStatus +

ApiServerSourceSpec

(Appears on: -EventType) +ApiServerSource)

-

EventTypeStatus represents the current state of a EventType.

+

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -2314,134 +2310,91 @@ string - -
-Status
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.SourceSpec

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

-

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

+

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

TriggerFilter -

-

-(Appears on: -TriggerSpec) -

-

-

- - - - - - - - - -
FieldDescription
-attributes
+resources
- -TriggerFilterAttributes + +[]APIVersionKindSelector 		-(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.

+

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

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
+owner
-string + +APIVersionKind + 		-

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

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

+

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

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

+(Optional) +

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

TriggerStatus +

ApiServerSourceStatus

(Appears on: -Trigger) +ApiServerSource)

-

TriggerStatus represents the current state of a Trigger.

+

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -2453,45 +2406,34 @@ is required.

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

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

-

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

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

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

+

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

flows.knative.dev/v1alpha1

+

ContainerSourceSpec +

-

Package v1alpha1 is the v1alpha1 version of the API.

+(Appears on: +ContainerSource)

-Resource Types: - -

Parallel -

-

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

+

ContainerSourceSpec defines the desired state of ContainerSource

@@ -2503,101 +2445,84 @@ series through Channels and Subscriptions.

- - - - - +

ContainerSourceStatus +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceStatus defines the observed state of ContainerSource

+

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

Spec defines the desired state of the Parallel.

-
-
- - - - - - - +
-branches
+SourceSpec
- -[]ParallelBranch - +knative.dev/pkg/apis/duck/v1.SourceSpec 		-

Branches is the list of Filter/Subscribers pairs.

+

+(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.
-channelTemplate
+template
- -ChannelTemplateSpec + +Kubernetes core/v1.PodTemplateSpec 		-(Optional) -

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

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

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

+

Template describes the pods that will be created
-
+ + + + + +
FieldDescription
-status
+SourceStatus
- -ParallelStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus 		-(Optional) -

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

+

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

+

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

ParallelBranch +

PingSourceSpec

(Appears on: -ParallelSpec) +PingSource)

+

PingSourceSpec defines the desired state of the PingSource.

@@ -2609,65 +2534,58 @@ date.

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

Filter is the expression guarding the branch

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

Subscriber receiving the event when the filter passes

+

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

+

inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.
-reply
+schedule
-knative.dev/pkg/apis/duck/v1.Destination +string 		(Optional) -

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

+

Schedule is the cronjob schedule. Defaults to * * * * *.
-delivery
+jsonData
- -DeliverySpec - +string 		(Optional) -

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

+

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

ParallelBranchStatus +

PingSourceStatus

(Appears on: -ParallelStatus) +PingSource)

-

ParallelBranchStatus represents the current state of a Parallel branch

+

PingSourceStatus defines the observed state of PingSource.

@@ -2679,53 +2597,34 @@ Needed for Roundtripping v1alpha1 <-> v1beta1.

- - - - - - - -
-filterSubscriptionStatus
- - -ParallelSubscriptionStatus - - -		 -

FilterSubscriptionStatus corresponds to the filter subscription status.

-
-filterChannelStatus
- - -ParallelChannelStatus - - -		 -

FilterChannelStatus corresponds to the filter channel status.

-
-subscriberSubscriptionStatus
+SourceStatus
- -ParallelSubscriptionStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus 		-

SubscriptionStatus corresponds to the subscriber subscription status.

+

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

ParallelChannelStatus +

SinkBindingSpec

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

+

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

@@ -2737,37 +2636,48 @@ ParallelSubscriptionStatus
-channel
+SourceSpec
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.SourceSpec 		-

Channel is the reference to the underlying channel.

+

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

ReadyCondition indicates whether the Channel is ready or not.

+

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

ParallelSpec +

SinkBindingStatus

(Appears on: -Parallel) +SinkBinding)

+

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

@@ -2779,132 +2689,39 @@ knative.dev/pkg/apis.Condition - - - - - - - - - - - -
-branches
+SourceStatus
- -[]ParallelBranch - - -		 -

Branches is the list of Filter/Subscribers pairs.

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

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

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

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

-
-

ParallelStatus -

-

-(Appears on: -Parallel) -

-

-

ParallelStatus represents the current state of a Parallel.

-

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

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

-

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

-
-ingressChannelStatus
- - -ParallelChannelStatus - - -		 -

IngressChannelStatus corresponds to the ingress channel status.

-
-branchStatuses
- - -[]ParallelBranchStatus - - -		 -

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

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

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

-

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

+

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

ParallelSubscriptionStatus -

+
+

configs.internal.knative.dev/v1alpha1

-(Appears on: -ParallelBranchStatus) +

Package v1alpha1 is the v1alpha1 version of the API.

+Resource Types: + +

ConfigMapPropagation +

+

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

@@ -2916,44 +2733,21 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

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

Subscription is the reference to the underlying Subscription.

+ +configs.internal.knative.dev/v1alpha1 +
-ready
- -knative.dev/pkg/apis.Condition - -		 -

ReadyCondition indicates whether the Subscription is ready or not.

+kind
+string 		ConfigMapPropagation
-

Sequence -

-

-

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

-

- - - - - - - -
FieldDescription
metadata
@@ -2973,55 +2767,39 @@ Refer to the Kubernetes API documentation for the fields of the 		spec
- -SequenceSpec + +ConfigMapPropagationSpec 		-

Spec defines the desired state of the Sequence.

+

Spec defines the desired state of the ConfigMapPropagation



- - - -
-steps
+originalNamespace
- -[]SequenceStep - +string 		-

Steps is the list of Destinations (processors / functions) that will be called in the order -provided.

+

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

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

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

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

+

Selector only selects original configMaps with corresponding labels
@@ -3031,24 +2809,24 @@ knative.dev/pkg/apis/duck/v1.Destination 		status
- -SequenceStatus + +ConfigMapPropagationStatus 		(Optional) -

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

+

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

SequenceChannelStatus +

ConfigMapPropagationSpec

(Appears on: -SequenceStatus) +ConfigMapPropagation)

@@ -3062,37 +2840,39 @@ date.

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

Channel is the reference to the underlying channel.

+

OriginalNamespace is the namespace where the original configMaps are in

-ready
+selector
-knative.dev/pkg/apis.Condition + +Kubernetes meta/v1.LabelSelector + -

ReadyCondition indicates whether the Channel is ready or not.

+(Optional) +

Selector only selects original configMaps with corresponding labels

-

SequenceSpec +

ConfigMapPropagationStatus

(Appears on: -Sequence) +ConfigMapPropagation)

+

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

@@ -3104,55 +2884,44 @@ knative.dev/pkg/apis.Condition - - - -
-steps
+Status
- -[]SequenceStep - +knative.dev/pkg/apis/duck/v1.Status 		-

Steps is the list of Destinations (processors / functions) that will be called in the order -provided.

+

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

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
-channelTemplate
+copyConfigmaps
- -ChannelTemplateSpec + +[]ConfigMapPropagationStatusCopyConfigMap 		(Optional) -

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

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

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

+

CopyConfigMaps is the status for each copied configmap.
-

SequenceStatus +

ConfigMapPropagationStatusCopyConfigMap

(Appears on: -Sequence) +ConfigMapPropagationStatus)

-

SequenceStatus represents the current state of a Sequence.

+

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

@@ -3164,173 +2933,94 @@ knative.dev/pkg/apis/duck/v1.Destination - -
-Status
+name
-knative.dev/pkg/apis/duck/v1.Status +string 		-

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

-

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

+

Name is copy configmap’s name
-subscriptionStatuses
+source
- -[]SequenceSubscriptionStatus - +string 		-

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

+

Source is “originalNamespace/originalConfigMapName”
-channelStatuses
+operation
- -[]SequenceChannelStatus - +string 		-

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

+

Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop
-AddressStatus
+ready
-knative.dev/pkg/apis/duck/v1.AddressStatus +string 		-

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

-

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

+

Ready represents the operation is ready or not
-

SequenceStep -

-

-(Appears on: -SequenceSpec) -

-

-

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

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

-

Subscriber receiving the step event

+

Reason indicates reasons if the operation is not ready
-delivery
+resourceVersionFromSource
- -DeliverySpec - +string 		-(Optional) -

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

+

ResourceVersion is the resourceVersion of original configmap
-

SequenceSubscriptionStatus -

+
+

duck.knative.dev/v1

-(Appears on: -SequenceStatus) +

Package v1 is the v1 version of the API.

+Resource Types: + +

BackoffPolicyType +(string alias)

+(Appears on: +DeliverySpec)

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

Subscription is the reference to the underlying Subscription.

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

ReadyCondition indicates whether the Subscription is ready or not.

-
-
-

messaging.knative.dev/v1alpha1

-

Package v1alpha1 is the v1alpha1 version of the API.

+

BackoffPolicyType is the type for backoff policies

-Resource Types: - -

Channel +

Channelable

-

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

+

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

@@ -3342,23 +3032,6 @@ Resource Types: - - - - - - - - @@ -3376,54 +3048,43 @@ Refer to the Kubernetes API documentation for the fields of the
-apiVersion
-string		 - -messaging.knative.dev/v1alpha1 - -
-kind
-string -		Channel
metadata
@@ -3367,7 +3040,6 @@ Kubernetes meta/v1.ObjectMeta 		-(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ChannelSpec + +ChannelableSpec 		-

Spec defines the desired state of the Channel.

+

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



- - - -
-channelTemplate
- - -ChannelTemplateSpec - - -		 -

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

-
-subscribable
+SubscribableSpec
- -Subscribable + +SubscribableSpec 		-

Channel conforms to Duck type Subscribable.

+

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

Delivery options.

+(Optional) +

DeliverySpec contains options controlling the event delivery
@@ -3433,23 +3094,26 @@ DeliverySpec 		status
- -ChannelStatus + +ChannelableStatus 		-(Optional) -

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

InMemoryChannel +

ChannelableSpec

-

InMemoryChannel is a resource representing an in memory channel

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

+

+

ChannelableSpec contains Spec of the Channelable object

@@ -3461,101 +3125,129 @@ date.

- - - - + +
-apiVersion
-string		 - -messaging.knative.dev/v1alpha1 - +SubscribableSpec
+ + +SubscribableSpec + +
-kind
-string +

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

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

DeliverySpec contains options controlling the event delivery
+

ChannelableStatus +

+

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

+

+

ChannelableStatus contains the Status of a Channelable object.

+

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

Spec defines the desired state of the Channel.

-
-
- +

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

+

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

+ + - -
-subscribable
+AddressStatus
- -Subscribable - +knative.dev/pkg/apis/duck/v1.AddressStatus 		-

Channel conforms to Duck type Subscribable.

+

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

+

AddressStatus is the part where the Channelable fulfills the Addressable contract.
-delivery
+SubscribableStatus
- -DeliverySpec + +SubscribableStatus 		-

For round tripping (v1beta1 <-> v1alpha1>

-
+

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

+

Subscribers is populated with the statuses of each of the Channelable’s subscribers.
-status
+deadLetterChannel
- -InMemoryChannelStatus - +knative.dev/pkg/apis/duck/v1.KReference 		(Optional) -

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

+

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

Subscription +

DeliverySpec

-

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

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

+

+

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

@@ -3567,121 +3259,144 @@ corresponds to the subscriptions.channels.knative.dev CRD.

- - - -
-apiVersion
-string		 - -messaging.knative.dev/v1alpha1 - +deadLetterSink
+ +knative.dev/pkg/apis/duck/v1.Destination +
-kind
-string +(Optional) +

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

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

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

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

+ + + +
-generation
+backoffDelay
-int64 +string 		(Optional) -

TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

-

We should be able to drop this property with a CRD conversion webhook -in the future

+

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

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

+(Optional) +

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.

+

+ + + + + + + + - +

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

+
+
+
FieldDescription
-subscriber
+metadata
-knative.dev/pkg/apis/duck/v1.Destination + +Kubernetes meta/v1.ObjectMeta + 		-(Optional) -

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

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

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

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

Delivery configuration

+

This is the list of subscriptions for this subscribable.
@@ -3691,25 +3406,27 @@ DeliverySpec 		status
- -SubscriptionStatus + +SubscribableStatus 		+

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

ChannelSpec +

SubscribableSpec

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

-

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

+

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

@@ -3721,54 +3438,62 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba + +
-channelTemplate
+subscribers
- -ChannelTemplateSpec + +[]SubscriberSpec 		-

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

+

This is the list of subscriptions for this subscribable.
+

SubscribableStatus +

+

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

+

+

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

+

+ + - - + + + +
-subscribable
- - -Subscribable - - -		 -

Channel conforms to Duck type Subscribable.

-		FieldDescription
-delivery
+subscribers
- -DeliverySpec + +[]SubscriberStatus 		-

Delivery options.

+

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

ChannelStatus +

SubscriberSpec

(Appears on: -Channel) +SubscribableSpec)

-

ChannelStatus represents the current state of a Channel.

+

SubscriberSpec defines a single subscriber to a Subscribable.

+

At least one of SubscriberURI and ReplyURI must be present

@@ -3780,123 +3505,76 @@ DeliverySpec - - -
-Status
+uid
-knative.dev/pkg/apis/duck/v1.Status +k8s.io/apimachinery/pkg/types.UID 		-

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

-

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

+(Optional) +

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

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

-

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

-

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

+(Optional) +

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

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

-

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

+(Optional) +

SubscriberURI is the endpoint for the subscriber
-channel
+replyUri
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis.URL 		-

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

-
-

InMemoryChannelSpec -

-

-(Appears on: -InMemoryChannel) -

-

-

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

-

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

Channel conforms to Duck type Subscribable.

+(Optional) +

ReplyURI is the endpoint for the reply
delivery
- + DeliverySpec 		-

For round tripping (v1beta1 <-> v1alpha1>

+(Optional) +

DeliverySpec contains options controlling the event delivery
-

InMemoryChannelStatus +

SubscriberStatus

(Appears on: -InMemoryChannel) +SubscribableStatus)

-

ChannelStatus represents the current state of a Channel.

+

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

@@ -3908,74 +3586,74 @@ DeliverySpec + + + +
-Status
+uid
-knative.dev/pkg/apis/duck/v1.Status +k8s.io/apimachinery/pkg/types.UID 		-

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

-

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

+(Optional) +

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

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

-

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

-

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

+(Optional) +

Generation of the origin of the subscriber with uid:UID.
-SubscribableTypeStatus
+ready
- -SubscribableTypeStatus + +Kubernetes core/v1.ConditionStatus 		-

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

-

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

+

Status of the subscriber.

+
+message
+ +string + +		 +(Optional) +

A human readable message indicating details of Ready status.
-

SubscriptionSpec -

+
+

eventing.knative.dev/v1

-(Appears on: -Subscription) +

Package v1 is the v1 version of the API.

+Resource Types: + +

Broker +

-

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

-

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

+

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.

@@ -3987,89 +3665,104 @@ channel –> reply

+ + + + + + + + - +

Spec defines the desired state of the Broker.

+
+
+
-generation
+apiVersion
+string		 + +eventing.knative.dev/v1 + +
+kind
+string +		Broker
+metadata
-int64 + +Kubernetes meta/v1.ObjectMeta + 		(Optional) -

TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

-

We should be able to drop this property with a CRD conversion webhook -in the future

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-channel
+spec
- -Kubernetes core/v1.ObjectReference + +BrokerSpec 		-

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

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

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

+

Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.
-reply
+delivery
-knative.dev/pkg/apis/duck/v1.Destination + +DeliverySpec + 		(Optional) -

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

+

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

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

Delivery configuration

+

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

-

SubscriptionStatus +

Trigger

-(Appears on: -Subscription) -

-

-

SubscriptionStatus (computed) for a subscription

+

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

@@ -4081,101 +3774,116 @@ DeliverySpec + + + + - -
-Status
- -knative.dev/pkg/apis/duck/v1.Status - +apiVersion
+string		 + +eventing.knative.dev/v1 +
-

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

-

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

+kind
+string 		Trigger
-physicalSubscription
+metadata
- -SubscriptionStatusPhysicalSubscription + +Kubernetes meta/v1.ObjectMeta 		-

PhysicalSubscription is the fully resolved values that this Subscription represents.

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

SubscriptionStatusPhysicalSubscription -

-

-(Appears on: -SubscriptionStatus) -

-

-

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

-

- - - - - - - + + + + + + + + +
FieldDescription
+spec
+ + +TriggerSpec + + +		 +

Spec defines the desired state of the Trigger.

+
+
+ -
-subscriberURI
+broker
-knative.dev/pkg/apis.URL +string 		-

SubscriberURI is the fully resolved URI for spec.subscriber.

+

Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.
-replyURI
+filter
-knative.dev/pkg/apis.URL + +TriggerFilter + 		-

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

+(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.
-deadLetterSinkURI
+subscriber
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination 		-

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

+

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

configs.internal.knative.dev/v1alpha1

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

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

+
+

BrokerSpec +

-

Package v1alpha1 is the v1alpha1 version of the API.

+(Appears on: +Broker)

-Resource Types: - -

ConfigMapPropagation -

-

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

@@ -4187,100 +3895,134 @@ Resource Types: - - - - - - - - + + +
-apiVersion
-string		 - -configs.internal.knative.dev/v1alpha1 - -
-kind
-string -		ConfigMapPropagation
-metadata
+config
- -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis/duck/v1.KReference 		(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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

Spec defines the desired state of the ConfigMapPropagation

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

OriginalNamespace is the namespace where the original configMaps are in

+

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

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Broker that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
-selector
+address
- -Kubernetes meta/v1.LabelSelector - +knative.dev/pkg/apis/duck/v1.Addressable 		-(Optional) -

Selector only selects original configMaps with corresponding labels

+

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

TriggerFilter +

+

+(Appears on: +TriggerSpec) +

+

+

+ + + + + + +
FieldDescription
-status
+attributes
- -ConfigMapPropagationStatus + +TriggerFilterAttributes 		(Optional) -

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

+

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

ConfigMapPropagationSpec +

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: -ConfigMapPropagation) +Trigger)

@@ -4294,39 +4036,53 @@ This data may be out of date.

-originalNamespace
+broker
string -

OriginalNamespace is the namespace where the original configMaps are in

+

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

-selector
+filter
- -Kubernetes meta/v1.LabelSelector + +TriggerFilter (Optional) -

Selector only selects original configMaps with corresponding labels

+

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.

-

ConfigMapPropagationStatus +

TriggerStatus

(Appears on: -ConfigMapPropagation) +Trigger)

-

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

+

TriggerStatus represents the current state of a Trigger.

@@ -4348,34 +4104,44 @@ knative.dev/pkg/apis/duck/v1.Status (Members of Status are embedded into this type.)

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

-copyConfigmaps
+subscriberUri
- -[]ConfigMapPropagationStatusCopyConfigMap - +knative.dev/pkg/apis.URL 		-(Optional) -

CopyConfigMaps is the status for each copied configmap.

+

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

ConfigMapPropagationStatusCopyConfigMap -

+
+

eventing.knative.dev/v1beta1

-(Appears on: -ConfigMapPropagationStatus) +

Package v1beta1 is the v1beta1 version of the API.

+Resource Types: + +

Broker +

-

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

+

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.

@@ -4387,94 +4153,102 @@ knative.dev/pkg/apis/duck/v1.Status + + + + - +

Spec defines the desired state of the Broker.

+
+
+
-name
- -string - +apiVersion
+string		 + +eventing.knative.dev/v1beta1 +
-

Name is copy configmap’s name

+kind
+string 		Broker
-source
+metadata
-string + +Kubernetes meta/v1.ObjectMeta + 		-

Source is “originalNamespace/originalConfigMapName”

+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
-operation
+spec
-string + +BrokerSpec + 		-

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

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

Ready represents the operation is ready or not

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

Reason indicates reasons if the operation is not ready

+(Optional) +

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

+
-resourceVersionFromSource
+status
-string + +BrokerStatus + -

ResourceVersion is the resourceVersion of original configmap

+(Optional) +

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

-
-

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 +

EventType

-

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.

@@ -4486,6 +4260,23 @@ Channelable ObjectReferences and access their subscription and address data. Th + + + + + + + + @@ -4502,122 +4294,117 @@ Refer to the Kubernetes API documentation for the fields of the + + - -
+apiVersion
+string		 + +eventing.knative.dev/v1beta1 + +
+kind
+string +		EventType
metadata
@@ -4494,6 +4285,7 @@ Kubernetes meta/v1.ObjectMeta 		+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ChannelableSpec + +EventTypeSpec 		-

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

+

Spec defines the desired state of the EventType.



-
-SubscribableSpec
+type
- -SubscribableSpec - +string 		-

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

+

Type represents the CloudEvents type. It is authoritative.
-delivery
+source
- -DeliverySpec - +knative.dev/pkg/apis.URL 		(Optional) -

DeliverySpec contains options controlling the event delivery

+

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.
-status
+schemaData
- -ChannelableStatus - +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.
-

ChannelableSpec -

-

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

-

-

ChannelableSpec contains Spec of the Channelable object

-

- - - - + + - - + +
FieldDescription +broker
+ +string + +		 +(Optional) +

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

+
-SubscribableSpec
+description
- -SubscribableSpec - +string 		-

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

+(Optional) +

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

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

DeliverySpec contains options controlling the event delivery

+

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

-

ChannelableStatus +

Trigger

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

-

-

ChannelableStatus contains the Status of a Channelable object.

+

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

@@ -4629,88 +4416,116 @@ DeliverySpec + + + + + + + + + + + + + + +
-Status
+apiVersion
+string		 + +eventing.knative.dev/v1beta1 + +
+kind
+string +		Trigger
+metadata
-knative.dev/pkg/apis/duck/v1.Status + +Kubernetes meta/v1.ObjectMeta + 		-

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

-

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

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

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

-

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

+

Spec defines the desired state of the Trigger.

+
+
+ + + + -
+broker
+ +string + +		 +

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

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

-

Subscribers is populated with the statuses of each of the Channelable’s subscribers.

+(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.
-deadLetterChannel
+subscriber
-knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis/duck/v1.Destination 		-(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.

+

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.
-

DeliverySpec -

-

-(Appears on: -BrokerSpec, -BrokerSpec, -ChannelSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ChannelableSpec, -InMemoryChannelSpec, -ParallelBranch, -ParallelBranch, -SequenceStep, -SequenceStep, -SubscriberSpec, -SubscriberSpec, -SubscriptionSpec, -SubscriptionSpec) +

+status
+ + +TriggerStatus + + +		 +(Optional) +

Status represents the current state of the Trigger. This data may be out of +date.

+
+

BrokerSpec +

+

+(Appears on: +Broker)

-

DeliverySpec contains the delivery options for event senders, -such as channelable and source.

@@ -4722,65 +4537,89 @@ such as channelable and source.

+ +
-deadLetterSink
+config
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.KReference 		(Optional) -

DeadLetterSink is the sink receiving event that could not be sent to -a destination.

+

Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap.
-retry
+delivery
-int32 + +DeliverySpec + 		(Optional) -

Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink.

+

Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc.
+

BrokerStatus +

+

+(Appears on: +Broker) +

+

+

BrokerStatus represents the current state of a Broker.

+

+ + + + + + + +
FieldDescription
-backoffPolicy
+Status
- -BackoffPolicyType - +knative.dev/pkg/apis/duck/v1.Status 		-(Optional) -

BackoffPolicy is the retry backoff policy (linear, exponential).

+

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
-backoffDelay
+address
-string +knative.dev/pkg/apis/duck/v1.Addressable 		-(Optional) -

BackoffDelay is the delay before retrying. -More information on Duration format: https://www.ietf.org/rfc/rfc3339.txt

-

For linear policy, backoff delay is the time interval between retries. -For exponential policy , backoff delay is backoffDelay*2^.

+

Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh.
-

DeliveryStatus +

EventTypeSpec

-

DeliveryStatus contains the Status of an object supporting delivery options.

+(Appears on: +EventType) +

+

@@ -4792,105 +4631,89 @@ For exponential policy , backoff delay is backoffDelay*2^.

 - -
-deadLetterChannel
+type
-knative.dev/pkg/apis/duck/v1.KReference +string 		-(Optional) -

DeadLetterChannel is a KReference that is the reference to the native, platform specific channel -where failed events are sent to.

+

Type represents the CloudEvents type. It is authoritative.
-

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
+source
- -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis.URL 		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +(Optional) +

Source is a URI, it represents the CloudEvents source.
-spec
+schema
- -SubscribableSpec - +knative.dev/pkg/apis.URL 		-

SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract.

-
-
- +(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.

+ + -
-subscribers
+schemaData
- -[]SubscriberSpec - +string 		-

This is the list of subscriptions for this subscribable.

+(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.
-status
+description
- -SubscribableStatus - +string 		-

SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract.

+(Optional) +

Description is an optional field used to describe the EventType, in any meaningful way.
-

SubscribableSpec +

EventTypeStatus

(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -Subscribable) +EventType)

-

SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.

+

EventTypeStatus represents the current state of a EventType.

@@ -4902,30 +4725,29 @@ configured as to be compatible with Subscribable contract.

-subscribers
+Status
- -[]SubscriberSpec - +knative.dev/pkg/apis/duck/v1.Status 		-

This is the list of subscriptions for this subscribable.

+

+(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.
-

SubscribableStatus +

TriggerFilter

(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -Subscribable) +TriggerSpec)

-

SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.

@@ -4937,28 +4759,42 @@ section of the resource.

-subscribers
+attributes
- -[]SubscriberStatus + +TriggerFilterAttributes 		-

This is the list of subscription’s statuses for this channel.

+(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.
-

SubscriberSpec +

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: -SubscribableSpec) +Trigger)

-

SubscriberSpec defines a single subscriber to a Subscribable.

-

At least one of SubscriberURI and ReplyURI must be present

@@ -4970,77 +4806,53 @@ section of the resource.

- - - - - - - -
-uid
+broker
-k8s.io/apimachinery/pkg/types.UID +string 		-(Optional) -

UID is used to understand the origin of the subscriber.

+

Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.
-generation
+filter
-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 + +TriggerFilter + 		(Optional) -

ReplyURI is the endpoint for the reply

+

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.
-delivery
+subscriber
- -DeliverySpec - +knative.dev/pkg/apis/duck/v1.Destination 		-(Optional) -

DeliverySpec contains options controlling the event delivery

+

Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.
-

SubscriberStatus +

TriggerStatus

(Appears on: -SubscribableStatus, -SubscribableStatus) +Trigger)

-

SubscriberStatus defines the status of a single subscriber to a Channel.

+

TriggerStatus represents the current state of a Trigger.

@@ -5052,63 +4864,41 @@ DeliverySpec - - - - - - - -
-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
+Status
- -Kubernetes core/v1.ConditionStatus - +knative.dev/pkg/apis/duck/v1.Status 		-

Status of the subscriber.

+

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
-message
+subscriberUri
-string +knative.dev/pkg/apis.URL 		-(Optional) -

A human readable message indicating details of Ready status.

+

SubscriberURI is the resolved URI of the receiver for this Trigger.
-

flows.knative.dev/v1beta1

+

flows.knative.dev/v1

-

Package v1beta1 is the v1beta1 version of the API.

+

Package v1 is the v1 version of the API.

Resource Types: -

Parallel +

Parallel

Parallel defines conditional branches that will be wired in @@ -5141,7 +4931,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + ParallelSpec @@ -5155,7 +4945,7 @@ ParallelSpec branches
- + []ParallelBranch @@ -5168,7 +4958,7 @@ ParallelSpec channelTemplate
- + ChannelTemplateSpec @@ -5199,7 +4989,7 @@ when the case does not have a Reply

status
- + ParallelStatus @@ -5212,11 +5002,11 @@ date.

-

ParallelBranch +

ParallelBranch

(Appears on: -ParallelSpec) +ParallelSpec)

@@ -5268,7 +5058,7 @@ If not specified, sent the result to the Parallel Reply

delivery
- + DeliverySpec @@ -5276,17 +5066,16 @@ DeliverySpec (Optional)

Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. -Needed for Roundtripping v1alpha1 <-> v1beta1.

+This includes things like retries, DLQ, etc.

-

ParallelBranchStatus +

ParallelBranchStatus

(Appears on: -ParallelStatus) +ParallelStatus)

ParallelBranchStatus represents the current state of a Parallel branch

@@ -5303,7 +5092,7 @@ Needed for Roundtripping v1alpha1 <-> v1beta1.

filterSubscriptionStatus
- + ParallelSubscriptionStatus @@ -5316,7 +5105,7 @@ ParallelSubscriptionStatus filterChannelStatus
- + ParallelChannelStatus @@ -5329,7 +5118,7 @@ ParallelChannelStatus subscriberSubscriptionStatus
- + ParallelSubscriptionStatus @@ -5340,12 +5129,12 @@ ParallelSubscriptionStatus -

ParallelChannelStatus +

ParallelChannelStatus

(Appears on: -ParallelBranchStatus, -ParallelStatus) +ParallelBranchStatus, +ParallelStatus)

@@ -5383,11 +5172,11 @@ knative.dev/pkg/apis.Condition -

ParallelSpec +

ParallelSpec

(Appears on: -Parallel) +Parallel)

@@ -5403,7 +5192,7 @@ knative.dev/pkg/apis.Condition branches
- + []ParallelBranch @@ -5416,7 +5205,7 @@ knative.dev/pkg/apis.Condition channelTemplate
- + ChannelTemplateSpec @@ -5442,11 +5231,11 @@ when the case does not have a Reply

-

ParallelStatus +

ParallelStatus

(Appears on: -Parallel) +Parallel)

ParallelStatus represents the current state of a Parallel.

@@ -5479,7 +5268,7 @@ knative.dev/pkg/apis/duck/v1.Status ingressChannelStatus
- + ParallelChannelStatus @@ -5492,7 +5281,7 @@ ParallelChannelStatus branchStatuses
- + []ParallelBranchStatus @@ -5520,11 +5309,11 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

-

ParallelSubscriptionStatus +

ParallelSubscriptionStatus

(Appears on: -ParallelBranchStatus) +ParallelBranchStatus)

@@ -5562,7 +5351,7 @@ knative.dev/pkg/apis.Condition -

Sequence +

Sequence

Sequence defines a sequence of Subscribers that will be wired in @@ -5595,7 +5384,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + SequenceSpec @@ -5609,7 +5398,7 @@ SequenceSpec steps
- + []SequenceStep @@ -5623,7 +5412,7 @@ provided. Each step has its own delivery options

channelTemplate
- + ChannelTemplateSpec @@ -5653,7 +5442,7 @@ knative.dev/pkg/apis/duck/v1.Destination status
- + SequenceStatus @@ -5666,11 +5455,11 @@ date.

-

SequenceChannelStatus +

SequenceChannelStatus

(Appears on: -SequenceStatus) +SequenceStatus)

@@ -5708,11 +5497,11 @@ knative.dev/pkg/apis.Condition -

SequenceSpec +

SequenceSpec

(Appears on: -Sequence) +Sequence)

@@ -5728,7 +5517,7 @@ knative.dev/pkg/apis.Condition steps
- + []SequenceStep @@ -5742,7 +5531,7 @@ provided. Each step has its own delivery options

channelTemplate
- + ChannelTemplateSpec @@ -5767,11 +5556,11 @@ knative.dev/pkg/apis/duck/v1.Destination -

SequenceStatus +

SequenceStatus

(Appears on: -Sequence) +Sequence)

SequenceStatus represents the current state of a Sequence.

@@ -5804,7 +5593,7 @@ knative.dev/pkg/apis/duck/v1.Status subscriptionStatuses
- + []SequenceSubscriptionStatus @@ -5818,7 +5607,7 @@ Matches the Spec.Steps array in the order.

channelStatuses
- + []SequenceChannelStatus @@ -5846,11 +5635,11 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

-

SequenceStep +

SequenceStep

(Appears on: -SequenceSpec) +SequenceSpec)

@@ -5880,7 +5669,7 @@ knative.dev/pkg/apis/duck/v1.Destination delivery
- + DeliverySpec @@ -5893,11 +5682,11 @@ This includes things like retries, DLQ, etc.

-

SequenceSubscriptionStatus +

SequenceSubscriptionStatus

(Appears on: -SequenceStatus) +SequenceStatus)

@@ -5936,22 +5725,18 @@ knative.dev/pkg/apis.Condition
-

messaging.knative.dev/v1beta1

+

duck.knative.dev/v1alpha1

-

Package v1beta1 is the v1beta1 version of the API.

+

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types: - -

Channel +
    +

    Channelable

    -

    Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.

    +

    Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

    @@ -5963,23 +5748,6 @@ Resource Types: - - - - - - - - @@ -5997,44 +5764,43 @@ Refer to the Kubernetes API documentation for the fields of the
    -apiVersion
    -string    		 - -messaging.knative.dev/v1beta1 - -
    -kind
    -string -    		Channel
    metadata
    @@ -5988,7 +5756,6 @@ Kubernetes meta/v1.ObjectMeta     		-(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
    - -ChannelSpec + +ChannelableSpec     		-

    Spec defines the desired state of the Channel.

    +

    Spec is the part where the Channelable fulfills the Subscribable contract.



    -channelTemplate
    +SubscribableTypeSpec
    - -ChannelTemplateSpec + +SubscribableTypeSpec     		-

    ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

    +

    +(Members of SubscribableTypeSpec are embedded into this type.) +
    -ChannelableSpec
    +delivery
    - -ChannelableSpec + +DeliverySpec     		-

    -(Members of ChannelableSpec are embedded into this type.) -

    -

    Channel conforms to ChannelableSpec

    +(Optional) +

    DeliverySpec contains options controlling the event delivery
    @@ -6044,23 +5810,24 @@ ChannelableSpec     		status
    - -ChannelStatus + +ChannelableStatus     		-(Optional) -

    Status represents the current state of the Channel. This data may be out of -date.
    -

    InMemoryChannel +

    ChannelableCombined

    -

    InMemoryChannel is a resource representing an in memory channel

    +

    ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of 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.

    @@ -6072,23 +5839,6 @@ date.

    - - - - - - - - @@ -6106,57 +5855,87 @@ Refer to the Kubernetes API documentation for the fields of the + + + + +
    -apiVersion
    -string    		 - -messaging.knative.dev/v1beta1 - -
    -kind
    -string -    		InMemoryChannel
    metadata
    @@ -6097,7 +5847,6 @@ Kubernetes meta/v1.ObjectMeta     		-(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
    - -InMemoryChannelSpec + +ChannelableCombinedSpec     		-

    Spec defines the desired state of the Channel.

    +

    Spec is the part where the Channelable fulfills the Subscribable contract.



    -
    -ChannelableSpec
    +SubscribableTypeSpec
    - -ChannelableSpec + +SubscribableTypeSpec

    -(Members of ChannelableSpec are embedded into this type.) +(Members of SubscribableTypeSpec are embedded into this type.)

    -

    Channel conforms to Duck type Channelable.

    +

    SubscribableTypeSpec is for the v1alpha1 spec compatibility.
    -
    +SubscribableSpec
    + + +SubscribableSpec + + +    		 +

    +(Members of SubscribableSpec are embedded into this type.) +

    +

    SubscribableSpec is for the v1beta1 spec compatibility.

    +
    -status
    +delivery
    - -InMemoryChannelStatus + +DeliverySpec     		(Optional) -

    Status represents the current state of the Channel. This data may be out of -date.

    +

    DeliverySpec contains options controlling the event delivery

    +
    + + + + +status
    + + +ChannelableCombinedStatus + + + + -

    Subscription +

    ChannelableCombinedSpec

    -

    Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.

    +(Appears on: +ChannelableCombined) +

    +

    +

    ChannelableSpec contains Spec of the Channelable object

    @@ -6168,148 +5947,155 @@ corresponds to the subscriptions.channels.knative.dev CRD.

    - - - - + + +
    -apiVersion
    -string    		 - -messaging.knative.dev/v1beta1 - +SubscribableTypeSpec
    + + +SubscribableTypeSpec + +
    -kind
    -string +

    +(Members of SubscribableTypeSpec are embedded into this type.) +

    +

    SubscribableTypeSpec is for the v1alpha1 spec compatibility.

    		Subscription
    -metadata
    +SubscribableSpec
    - -Kubernetes meta/v1.ObjectMeta + +SubscribableSpec     		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

    +(Members of SubscribableSpec are embedded into this type.) +

    +

    SubscribableSpec is for the v1beta1 spec compatibility.
    -spec
    +delivery
    - -SubscriptionSpec + +DeliverySpec     		-
    -
    +(Optional) +

    DeliverySpec contains options controlling the event delivery

    +
    +

    ChannelableCombinedStatus +

    +

    +(Appears on: +ChannelableCombined) +

    +

    +

    ChannelableStatus contains the Status of a Channelable object.

    +

    + + + + + + + - -
    FieldDescription
    -channel
    +Status
    - -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.Status     		-

    Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status.

    -

    This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.)

    +

    +(Members of Status are embedded into this type.) +

    +

    inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
    -subscriber
    +AddressStatus
    -knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus     		-(Optional) -

    Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply.

    +

    +(Members of AddressStatus are embedded into this type.) +

    +

    AddressStatus is the part where the Channelable fulfills the Addressable contract.
    -reply
    +SubscribableTypeStatus
    -knative.dev/pkg/apis/duck/v1.Destination + +SubscribableTypeStatus +     		-(Optional) -

    Reply specifies (optionally) how to handle events returned from -the Subscriber target.

    +

    +(Members of SubscribableTypeStatus are embedded into this type.) +

    +

    SubscribableTypeStatus is the v1alpha1 part of the Subscribers status
    -delivery
    +SubscribableStatus
    - -DeliverySpec + +SubscribableStatus     		-(Optional) -

    Delivery configuration

    -
    +

    +(Members of SubscribableStatus are embedded into this type.) +

    +

    SubscribableStatus is the v1beta1 part of the Subscribers status.

    -status
    +errorChannel
    - -SubscriptionStatus + +Kubernetes core/v1.ObjectReference +(Optional) +

    ErrorChannel is set by the channel when it supports native error handling via a channel

    -

    ChannelDefaulter -

    -

    -

    ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.

    -

    -

    ChannelSpec +

    ChannelableSpec

    (Appears on: -Channel) +Channelable)

    -

    ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. -It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.

    +

    ChannelableSpec contains Spec of the Channelable object

    @@ -6321,44 +6107,43 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba
    -channelTemplate
    +SubscribableTypeSpec
    - -ChannelTemplateSpec + +SubscribableTypeSpec     		-

    ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

    +

    +(Members of SubscribableTypeSpec are embedded into this type.) +
    -ChannelableSpec
    +delivery
    - -ChannelableSpec + +DeliverySpec     		-

    -(Members of ChannelableSpec are embedded into this type.) -

    -

    Channel conforms to ChannelableSpec

    +(Optional) +

    DeliverySpec contains options controlling the event delivery
    -

    ChannelStatus +

    ChannelableStatus

    (Appears on: -Channel) +Channelable)

    -

    ChannelStatus represents the current state of a Channel.

    +

    ChannelableStatus contains the Status of a Channelable object.

    @@ -6370,79 +6155,71 @@ ChannelableSpec - - -
    -ChannelableStatus
    +Status
    - -ChannelableStatus - +knative.dev/pkg/apis/duck/v1.Status

    -(Members of ChannelableStatus are embedded into this type.) +(Members of Status are embedded into this type.)

    -

    Channel conforms to ChannelableStatus

    +

    inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
    -channel
    +AddressStatus
    -knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus     		-

    Channel is an KReference to the Channel CRD backing this Channel.

    -
    -

    ChannelTemplateSpec -

    -(Appears on: -BrokerSpec, -ChannelSpec, -ChannelSpec, -ParallelSpec, -ParallelSpec, -SequenceSpec, -SequenceSpec) +(Members of AddressStatus are embedded into this type.)

    +

    AddressStatus is the part where the Channelable fulfills the Addressable contract.

    + + + + +SubscribableTypeStatus
    + + +SubscribableTypeStatus + + + +

    +(Members of SubscribableTypeStatus are embedded into this type.)

    - - - - - +

    Subscribers is populated with the statuses of each of the Channelable’s subscribers.

    + - -
    FieldDescription
    -spec
    +errorChannel
    -k8s.io/apimachinery/pkg/runtime.RawExtension + +Kubernetes core/v1.ObjectReference +     		(Optional) -

    Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section.

    -
    -
    - -
    +

    ErrorChannel is set by the channel when it supports native error handling via a channel
    -

    ChannelTemplateSpecInternal +

    Resource

    -

    ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.

    +

    Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch +arbitrary other resources (such as any Source or Addressable). This is not a real resource.

    @@ -6462,40 +6239,21 @@ Kubernetes meta/v1.ObjectMeta - - - -
    -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    -spec
    - -k8s.io/apimachinery/pkg/runtime.RawExtension - -    		 -(Optional) -

    Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section.

    -
    -
    - -
    -
    -

    InMemoryChannelSpec +

    Subscribable

    (Appears on: -InMemoryChannel) +SubscribableTypeSpec)

    -

    InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.

    +

    Subscribable is the schema for the subscribable portion of the spec +section of the resource.

    @@ -6507,30 +6265,28 @@ arguments for a Channel.

    -ChannelableSpec
    +subscribers
    - -ChannelableSpec + +[]SubscriberSpec     		-

    -(Members of ChannelableSpec are embedded into this type.) -

    -

    Channel conforms to Duck type Channelable.

    +

    This is the list of subscriptions for this subscribable.
    -

    InMemoryChannelStatus +

    SubscribableStatus

    (Appears on: -InMemoryChannel) +SubscribableTypeStatus)

    -

    ChannelStatus represents the current state of a Channel.

    +

    SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.

    @@ -6542,41 +6298,25 @@ ChannelableSpec
    -ChannelableStatus
    +subscribers
    - -ChannelableStatus + +[]SubscriberStatus     		-

    -(Members of ChannelableStatus are embedded into this type.) -

    -

    Channel conforms to Duck type Channelable.

    +

    This is the list of subscription’s statuses for this channel.
    -

    SubscriptionSpec +

    SubscribableType

    -(Appears on: -Subscription) -

    -

    -

    SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result.

    -

    The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply

    +

    SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

    @@ -6588,82 +6328,74 @@ channel –> reply

    - +

    SubscribableTypeSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.

    +
    +
    +
    -channel
    +metadata
    - -Kubernetes core/v1.ObjectReference + +Kubernetes meta/v1.ObjectMeta     		-

    Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status.

    -

    This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.)

    +Refer to the Kubernetes API documentation for the fields of the +metadata field.
    -subscriber
    +spec
    -knative.dev/pkg/apis/duck/v1.Destination + +SubscribableTypeSpec +     		-(Optional) -

    Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply.

    -
    + +
    -reply
    +subscribable
    -knative.dev/pkg/apis/duck/v1.Destination + +Subscribable +     		-(Optional) -

    Reply specifies (optionally) how to handle events returned from -the Subscriber target.

    +
    -delivery
    +status
    - -DeliverySpec + +SubscribableTypeStatus -(Optional) -

    Delivery configuration

    +

    SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract.

    -

    SubscriptionStatus +

    SubscribableTypeSpec

    (Appears on: -Subscription) +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType)

    -

    SubscriptionStatus (computed) for a subscription

    +

    SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.

    @@ -6675,44 +6407,63 @@ DeliverySpec + + +
    -Status
    +subscribable
    -knative.dev/pkg/apis/duck/v1.Status + +Subscribable +     		+
    +

    SubscribableTypeStatus +

    -(Members of Status are embedded into this type.) +(Appears on: +ChannelableCombinedStatus, +ChannelableStatus, +SubscribableType)

    -

    inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

    - +

    +

    SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

    +

    + + + + + + +
    FieldDescription
    -physicalSubscription
    +subscribableStatus
    - -SubscriptionStatusPhysicalSubscription + +SubscribableStatus     		-

    PhysicalSubscription is the fully resolved values that this Subscription represents.
    -

    SubscriptionStatusPhysicalSubscription +

    SubscriberSpec

    (Appears on: -SubscriptionStatus) +Subscribable)

    -

    SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

    +

    SubscriberSpec defines a single subscriber to a Subscribable. +Ref is a reference to the Subscription this SubscriberSpec was created for +SubscriberURI is the endpoint for the subscriber +ReplyURI is the endpoint for the reply +At least one of SubscriberURI and ReplyURI must be present

    @@ -6724,56 +6475,98 @@ Subscription.

    + + + + + + + + + + + +
    -subscriberUri
    +uid
    -knative.dev/pkg/apis.URL +k8s.io/apimachinery/pkg/types.UID     		-

    SubscriberURI is the fully resolved URI for spec.subscriber.

    +(Optional) +

    UID is used to understand the origin of the subscriber.
    -replyUri
    +generation
    -knative.dev/pkg/apis.URL +int64     		-

    ReplyURI is the fully resolved URI for the spec.reply.

    +(Optional) +

    Generation of the origin of the subscriber with uid:UID.
    -deadLetterSinkUri
    +subscriberURI
    knative.dev/pkg/apis.URL     		-

    ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.

    +(Optional) +
    +replyURI
    + +knative.dev/pkg/apis.URL + +    		 +(Optional) +
    +deadLetterSink
    + +knative.dev/pkg/apis.URL + +    		 +(Optional) +
    +delivery
    + + +DeliverySpec + + +    		 +(Optional)
    -

    sources.knative.dev/v1alpha1

    +

    duck.knative.dev/v1beta1

    -

    Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group

    +

    Package v1beta1 is the v1beta1 version of the API.

    Resource Types: - -

    ApiServerSource +
      +

      BackoffPolicyType +(string alias)

      +

      +(Appears on: +DeliverySpec) +

      +

      +

      BackoffPolicyType is the type for backoff policies

      +

      +

      Channelable

      -

      ApiServerSource is the Schema for the apiserversources API

      +

      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.

      @@ -6785,23 +6578,6 @@ Resource Types: - - - - - - - - + +
      -apiVersion
      -string      		 - -sources.knative.dev/v1alpha1 - -
      -kind
      -string -      		ApiServerSource
      metadata
      @@ -6818,116 +6594,209 @@ Refer to the Kubernetes API documentation for the fields of the       		spec
      - -ApiServerSourceSpec + +ChannelableSpec       		+

      Spec is the part where the Channelable fulfills the Subscribable contract.



      + +
      -resources
      +SubscribableSpec
      - -[]ApiServerResource + +SubscribableSpec       		-

      Resources is the list of resources to watch

      +

      +(Members of SubscribableSpec are embedded into this type.) +
      -serviceAccountName
      +delivery
      -string + +DeliverySpec +       		(Optional) -

      ServiceAccountName is the name of the ServiceAccount to use to run this -source.

      +

      DeliverySpec contains options controlling the event delivery

      +
      -sink
      +status
      -knative.dev/pkg/apis/duck/v1beta1.Destination + +ChannelableStatus +       		-(Optional) -

      Sink is a reference to an object that will resolve to a domain name to use as the sink.
      +

      ChannelableSpec +

      +

      +(Appears on: +ChannelSpec, +Channelable, +InMemoryChannelSpec) +

      +

      +

      ChannelableSpec contains Spec of the Channelable object

      +

      + + + + + + + + + +
      FieldDescription
      -ceOverrides
      +SubscribableSpec
      -knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +SubscribableSpec +       		-(Optional) -

      CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

      +

      +(Members of SubscribableSpec are embedded into this type.) +
      -owner
      +delivery
      - -APIVersionKind + +DeliverySpec       		(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.

      +

      DeliverySpec contains options controlling the event delivery
      +

      ChannelableStatus +

      +

      +(Appears on: +ChannelStatus, +Channelable, +InMemoryChannelStatus) +

      +

      +

      ChannelableStatus contains the Status of a Channelable object.

      +

      + + + + + + + + -
      FieldDescription
      -mode
      +Status
      -string +knative.dev/pkg/apis/duck/v1.Status       		-

      Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

      +

      +(Members of 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.

      -status
      +SubscribableStatus
      - -ApiServerSourceStatus + +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.

      -

      PingSource +

      DeliverySpec

      -

      PingSource is the Schema for the PingSources API.

      +(Appears on: +BrokerSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriberSpec, +SubscriptionSpec) +

      +

      +

      DeliverySpec contains the delivery options for event senders, +such as channelable and source.

      @@ -6939,21 +6808,104 @@ ApiServerSourceStatus +deadLetterSink
      + +knative.dev/pkg/apis/duck/v1.Destination + + + + + + + + + + + - + +
      -apiVersion
      -string      		 - -sources.knative.dev/v1alpha1 - +(Optional) +

      DeadLetterSink is the sink receiving event that could not be sent to +a destination.
      -kind
      +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^.

      		PingSource
      +

      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
      @@ -6970,116 +6922,288 @@ Refer to the Kubernetes API documentation for the fields of the
      -spec
      +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
      - -PingSourceSpec - +int64       		-
      -
      - +(Optional) +

      Generation of the origin of the subscriber with uid:UID.

      + + + +
      -schedule
      +subscriberUri
      -string +knative.dev/pkg/apis.URL       		-

      Schedule is the cronjob schedule.

      +(Optional) +

      SubscriberURI is the endpoint for the subscriber
      -data
      +replyUri
      -string +knative.dev/pkg/apis.URL       		-

      Data is the data posted to the target function.

      +(Optional) +

      ReplyURI is the endpoint for the reply
      -sink
      +delivery
      -knative.dev/pkg/apis/duck/v1.Destination + +DeliverySpec +       		-

      Sink is a reference to an object that will resolve to a uri to use as the sink.

      +(Optional) +

      DeliverySpec contains options controlling the event delivery
      +

      SubscriberStatus +

      +

      +(Appears on: +SubscribableStatus, +SubscribableStatus) +

      +

      +

      SubscriberStatus defines the status of a single subscriber to a Channel.

      +

      + + + + + + + + - -
      FieldDescription
      -ceOverrides
      +uid
      -knative.dev/pkg/apis/duck/v1.CloudEventOverrides +k8s.io/apimachinery/pkg/types.UID       		(Optional) -

      CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

      +

      UID is used to understand the origin of the subscriber.
      -serviceAccountName
      +observedGeneration
      -string +int64       		-

      ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. -Deprecated: v1beta1 drops this field.

      +(Optional) +

      Generation of the origin of the subscriber with uid:UID.
      -resources
      +ready
      - -PingResourceSpec + +Kubernetes core/v1.ConditionStatus       		-

      Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

      -
      +

      Status of the subscriber.
      -status
      +message
      - -PingSourceStatus - +string       		+(Optional) +

      A human readable message indicating details of Ready status.
      -

      SinkBinding +
      +

      messaging.knative.dev/v1

      +

      +

      Package v1 is the v1 version of the API.

      +

      +Resource Types: + +

      Channel

      -

      SinkBinding describes a Binding that is also a Source. -The sink (from the Source duck) is resolved to a URL and -then projected into the subject by augmenting the runtime -contract of the referenced containers to have a K_SINK -environment variable holding the endpoint to which to send -cloud events.

      +

      Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.

      @@ -7095,7 +7219,7 @@ cloud events.

      string @@ -7104,7 +7228,7 @@ sources.knative.dev/v1alpha1 kind
      string - + @@ -7124,39 +7249,44 @@ Refer to the Kubernetes API documentation for the fields of the
      -sources.knative.dev/v1alpha1 +messaging.knative.dev/v1
      SinkBindingChannel
      @@ -7116,6 +7240,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
      - -SinkBindingSpec + +ChannelSpec       		+

      Spec defines the desired state of the Channel.



      -SourceSpec
      +channelTemplate
      -knative.dev/pkg/apis/duck/v1.SourceSpec + +ChannelTemplateSpec +       		-

      -(Members of SourceSpec are embedded into this type.) -

      +

      ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. +This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.
      -BindingSpec
      +ChannelableSpec
      -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +ChannelableSpec +

      -(Members of BindingSpec are embedded into this type.) +(Members of ChannelableSpec are embedded into this type.)

      +

      Channel conforms to ChannelableSpec
      @@ -7166,24 +7296,23 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec       		status
      - -SinkBindingStatus + +ChannelStatus       		+(Optional) +

      Status represents the current state of the Channel. This data may be out of +date.
      -

      ApiServerResource +

      InMemoryChannel

      -(Appears on: -ApiServerSourceSpec) -

      -

      -

      ApiServerResource defines the resource to watch

      +

      InMemoryChannel is a resource representing an in memory channel

      @@ -7196,79 +7325,90 @@ SinkBindingStatus +string + + + + - +

      Spec defines the desired state of the Channel.

      +
      +
      +
      apiVersion
      - -string - -      		 -

      API version of the resource to watch.

      + +messaging.knative.dev/v1 +
      kind
      - string +      		InMemoryChannel
      +metadata
      + + +Kubernetes meta/v1.ObjectMeta +       		-

      Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
      -labelSelector
      +spec
      - -Kubernetes meta/v1.LabelSelector + +InMemoryChannelSpec       		-

      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
      +ChannelableSpec
      - -Kubernetes meta/v1.OwnerReference + +ChannelableSpec       		-

      ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. -Deprecated: Per-resource owner refs will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

      +

      +(Members of ChannelableSpec are embedded into this type.) +

      +

      Channel conforms to Duck type Channelable.

      +
      -controller
      +status
      -bool + +InMemoryChannelStatus + -

      If true, send an event referencing the object controlling the resource -Deprecated: Per-resource controller flag will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

      +(Optional) +

      Status represents the current state of the Channel. This data may be out of +date.

      -

      ApiServerSourceSpec +

      Subscription

      -(Appears on: -ApiServerSource) -

      -

      -

      ApiServerSourceSpec defines the desired state of ApiServerSource

      +

      Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.

      @@ -7280,132 +7420,148 @@ v1alpha2, please use Spec.Owner as a GKV.

      + + + + + + + + - +
      +
      +
      -resources
      +apiVersion
      +string      		 + +messaging.knative.dev/v1 + +
      +kind
      +string +      		Subscription
      +metadata
      - -[]ApiServerResource + +Kubernetes meta/v1.ObjectMeta       		-

      Resources is the list of resources to watch

      +Refer to the Kubernetes API documentation for the fields of the +metadata field.
      -serviceAccountName
      +spec
      -string + +SubscriptionSpec +       		-(Optional) -

      ServiceAccountName is the name of the ServiceAccount to use to run this -source.

      -
      -
      -sink
      +channel
      -knative.dev/pkg/apis/duck/v1beta1.Destination + +Kubernetes core/v1.ObjectReference +       		-(Optional) -

      Sink is a reference to an object that will resolve to a domain name to use as the sink.

      +

      Reference to a channel that will be used to create the subscription +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference must meet the +contract to the ChannelableSpec duck type. If the resource does not +meet this contract it will be reflected in the Subscription’s status.

      +

      This field is immutable. We have no good answer on what happens to +the events that are currently in the channel being consumed from +and what the semantics there should be. For now, you can always +delete the Subscription and recreate it to point to a different +channel, giving the user more control over what semantics should +be used (drain the channel first, possibly have events dropped, +etc.)
      -ceOverrides
      +subscriber
      -knative.dev/pkg/apis/duck/v1.CloudEventOverrides +knative.dev/pkg/apis/duck/v1.Destination       		(Optional) -

      CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

      +

      Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a Destination as specified by the Reply.
      -owner
      +reply
      - -APIVersionKind - +knative.dev/pkg/apis/duck/v1.Destination       		(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.

      +

      Reply specifies (optionally) how to handle events returned from +the Subscriber target.
      -mode
      +delivery
      -string + +DeliverySpec +       		-

      Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

      +(Optional) +

      Delivery configuration
      -

      ApiServerSourceStatus -

      -

      -(Appears on: -ApiServerSource) -

      -

      -

      ApiServerSourceStatus defines the observed state of ApiServerSource

      -

      - - - - - + - -
      FieldDescription
      -SourceStatus
      +status
      -knative.dev/pkg/apis/duck/v1.SourceStatus + +SubscriptionStatus +       		-

      -(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 +

      ChannelDefaulter +

      +

      +

      ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.

      +

      +

      ChannelSpec

      (Appears on: -PingResourceSpec) +Channel)

      +

      ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. +It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.

      @@ -7417,33 +7573,44 @@ Source.

      -cpu
      +channelTemplate
      -string + +ChannelTemplateSpec +       		+

      ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. +This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.
      -memory
      +ChannelableSpec
      -string + +ChannelableSpec +       		+

      +(Members of ChannelableSpec are embedded into this type.) +

      +

      Channel conforms to ChannelableSpec
      -

      PingRequestsSpec +

      ChannelStatus

      (Appears on: -PingResourceSpec) +Channel)

      +

      ChannelStatus represents the current state of a Channel.

      @@ -7455,31 +7622,40 @@ string
      -cpu
      +ChannelableStatus
      -string + +ChannelableStatus +       		+

      +(Members of ChannelableStatus are embedded into this type.) +

      +

      Channel conforms to ChannelableStatus
      -memory
      +channel
      -string +knative.dev/pkg/apis/duck/v1.KReference       		+

      Channel is an KReference to the Channel CRD backing this Channel.
      -

      PingResourceSpec +

      ChannelTemplateSpec

      (Appears on: -PingSourceSpec) +ChannelSpec, +ParallelSpec, +SequenceSpec)

      @@ -7493,38 +7669,28 @@ string -requests
      - - -PingRequestsSpec - - - - - - - - -limits
      +spec
      - -PingLimitsSpec - +k8s.io/apimachinery/pkg/runtime.RawExtension +(Optional) +

      Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section.

      +
      +
      + +
      -

      PingSourceSpec +

      ChannelTemplateSpecInternal

      -(Appears on: -PingSource) -

      -

      -

      PingSourceSpec defines the desired state of the PingSource.

      +

      ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.

      @@ -7536,126 +7702,48 @@ PingLimitsSpec - - - - - - - - - - - - - - - - - - - - - -
      -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
      +metadata
      - -PingResourceSpec + +Kubernetes meta/v1.ObjectMeta       		-

      Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

      +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
      -

      PingSourceStatus -

      -

      -(Appears on: -PingSource) -

      -

      -

      PingSourceStatus defines the observed state of PingSource.

      -

      - - - - - - - -
      FieldDescription
      -SourceStatus
      +spec
      -knative.dev/pkg/apis/duck/v1.SourceStatus +k8s.io/apimachinery/pkg/runtime.RawExtension       		-

      -(Members of SourceStatus are embedded into this type.) -

      -

      inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

      +(Optional) +

      Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section.

      +
      +
      + +
      -

      SinkBindingSpec +

      InMemoryChannelSpec

      (Appears on: -SinkBinding) +InMemoryChannel)

      -

      SinkBindingSpec holds the desired state of the SinkBinding (from the client).

      +

      InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.

      @@ -7667,40 +7755,30 @@ Source.

      - - - -
      -SourceSpec
      - -knative.dev/pkg/apis/duck/v1.SourceSpec - -      		 -

      -(Members of SourceSpec are embedded into this type.) -

      -
      -BindingSpec
      +ChannelableSpec
      -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +ChannelableSpec +

      -(Members of BindingSpec are embedded into this type.) +(Members of ChannelableSpec are embedded into this type.)

      +

      Channel conforms to Duck type Channelable.
      -

      SinkBindingStatus +

      InMemoryChannelStatus

      (Appears on: -SinkBinding) +InMemoryChannel)

      -

      SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

      +

      ChannelStatus represents the current state of a Channel.

      @@ -7712,38 +7790,41 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
      -SourceStatus
      +ChannelableStatus
      -knative.dev/pkg/apis/duck/v1.SourceStatus + +ChannelableStatus +

      -(Members of SourceStatus are embedded into this type.) +(Members of ChannelableStatus are embedded into this type.)

      +

      Channel conforms to Duck type Channelable.
      -
      -

      sources.knative.dev/v1alpha2

      +

      SubscriptionSpec +

      -

      Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group

      +(Appears on: +Subscription)

      -Resource Types: - -

      ApiServerSource -

      -

      ApiServerSource is the Schema for the apiserversources API

      +

      SubscriptionSpec specifies the Channel for incoming events, a Subscriber target +for processing those events and where to put the result of the processing. Only +From (where the events are coming from) is always required. You can optionally +only Process the events (results in no output events) by leaving out the Result. +You can also perform an identity transformation on the incoming events by leaving +out the Subscriber and only specifying Result.

      +

      The following are all valid specifications: +channel –[subscriber]–> reply +Sink, no outgoing events: +channel – subscriber +no-op function (identity transformation): +channel –> reply

      @@ -7755,146 +7836,192 @@ Resource Types: - - - - +

      +

      SubscriptionStatus (computed) for a subscription

      +

      +
      -apiVersion
      -string      		 - -sources.knative.dev/v1alpha2 - +channel
      + + +Kubernetes core/v1.ObjectReference + +
      -kind
      -string +

      Reference to a channel that will be used to create the subscription +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference must meet the +contract to the ChannelableSpec duck type. If the resource does not +meet this contract it will be reflected in the Subscription’s status.

      +

      This field is immutable. We have no good answer on what happens to +the events that are currently in the channel being consumed from +and what the semantics there should be. For now, you can always +delete the Subscription and recreate it to point to a different +channel, giving the user more control over what semantics should +be used (drain the channel first, possibly have events dropped, +etc.)

      		ApiServerSource
      -metadata
      +subscriber
      - -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis/duck/v1.Destination       		-Refer to the Kubernetes API documentation for the fields of the -metadata field. +(Optional) +

      Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a Destination as specified by the Reply.
      -spec
      +reply
      - -ApiServerSourceSpec - +knative.dev/pkg/apis/duck/v1.Destination       		-
      -
      - +(Optional) +

      Reply specifies (optionally) how to handle events returned from +the Subscriber target.

      + + + + +
      -SourceSpec
      +delivery
      -knative.dev/pkg/apis/duck/v1.SourceSpec + +DeliverySpec +       		+(Optional) +

      Delivery configuration

      +
      +

      SubscriptionStatus +

      -(Members of SourceSpec are embedded into this type.) +(Appears on: +Subscription)

      -

      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.

      -
      + + + + + + + +
      FieldDescription
      -resources
      +Status
      - -[]APIVersionKindSelector - +knative.dev/pkg/apis/duck/v1.Status       		-

      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.

      +

      +(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.
      -owner
      +physicalSubscription
      - -APIVersionKind + +SubscriptionStatusPhysicalSubscription       		-(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.

      +

      PhysicalSubscription is the fully resolved values that this Subscription represents.
      +

      SubscriptionStatusPhysicalSubscription +

      +

      +(Appears on: +SubscriptionStatus) +

      +

      +

      SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

      +

      + + + + + + + + - -
      FieldDescription
      -mode
      +subscriberUri
      -string +knative.dev/pkg/apis.URL       		-(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

      +

      SubscriberURI is the fully resolved URI for spec.subscriber.
      -serviceAccountName
      +replyUri
      -string +knative.dev/pkg/apis.URL       		-(Optional) -

      ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set.

      -
      +

      ReplyURI is the fully resolved URI for the spec.reply.

      -status
      +deadLetterSinkUri
      - -ApiServerSourceStatus - +knative.dev/pkg/apis.URL +

      ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.

      -

      ContainerSource +
      +

      sources.knative.dev/v1alpha1

      +

      +

      Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group

      +

      +Resource Types: + +

      ApiServerSource

      -

      ContainerSource is the Schema for the containersources API

      +

      ApiServerSource is the Schema for the apiserversources API

      @@ -7910,7 +8037,7 @@ ApiServerSourceStatus string @@ -7919,7 +8046,7 @@ sources.knative.dev/v1alpha2 kind
      string - + @@ -7950,33 +8077,82 @@ ContainerSourceSpec
      -sources.knative.dev/v1alpha2 +sources.knative.dev/v1alpha1
      ContainerSourceApiServerSource
      @@ -7939,8 +8066,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
      - -ContainerSourceSpec + +ApiServerSourceSpec
      + + + + + + + + + + + + + + + +
      -SourceSpec
      +resources
      -knative.dev/pkg/apis/duck/v1.SourceSpec + +[]ApiServerResource +       		-

      -(Members of SourceSpec are embedded into this type.) -

      -

      inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

      +

      Resources is the list of resources to watch
      -template
      +serviceAccountName
      - -Kubernetes core/v1.PodTemplateSpec +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       		-

      Template describes the pods that will be created

      +(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.
      @@ -7986,8 +8162,8 @@ Kubernetes core/v1.PodTemplateSpec status
      - -ContainerSourceStatus + +ApiServerSourceStatus @@ -7996,7 +8172,7 @@ ContainerSourceStatus -

      PingSource +

      PingSource

      PingSource is the Schema for the PingSources API.

      @@ -8015,7 +8191,7 @@ ContainerSourceStatus string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1alpha1 @@ -8044,7 +8220,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
      - + PingSourceSpec @@ -8055,46 +8231,75 @@ PingSourceSpec + + + + + + + + + + + +
      -SourceSpec
      +schedule
      -knative.dev/pkg/apis/duck/v1.SourceSpec +string       		-

      -(Members of SourceSpec are embedded into this type.) -

      -

      inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

      +

      Schedule is the cronjob schedule.
      -schedule
      +data
      string       		+

      Data is the data posted to the target function.

      +
      +sink
      + +knative.dev/pkg/apis/duck/v1.Destination + +      		 +

      Sink is a reference to an object that will resolve to a uri to use as the sink.

      +
      +ceOverrides
      + +knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +      		 (Optional) -

      Schedule is the cronjob schedule. Defaults to * * * * *.

      +

      CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.
      -jsonData
      +serviceAccountName
      string       		-(Optional) -

      JsonData is json encoded data used as the body of the event posted to -the sink. Default is empty. If set, datacontenttype will also be set -to “application/json”.

      +

      ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. +Deprecated: v1beta1 drops this field.

      +
      +resources
      + + +PingResourceSpec + + +      		 +

      Resource limits and Request specifications of the Receive Adapter Deployment +Deprecated: v1beta1 drops this field.
      @@ -8104,7 +8309,7 @@ to “application/json”.

      status
      - + PingSourceStatus @@ -8114,7 +8319,7 @@ PingSourceStatus -

      SinkBinding +

      SinkBinding

      SinkBinding describes a Binding that is also a Source. @@ -8138,7 +8343,7 @@ cloud events.

      string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1alpha1 @@ -8167,7 +8372,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
      - + SinkBindingSpec @@ -8187,11 +8392,6 @@ knative.dev/pkg/apis/duck/v1.SourceSpec

      (Members of SourceSpec are embedded into this type.)

      -

      inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

      @@ -8205,9 +8405,6 @@ 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.

      @@ -8217,7 +8414,7 @@ should be augmented by Binding implementations.

      status
      - + SinkBindingStatus @@ -8227,15 +8424,14 @@ SinkBindingStatus -

      APIVersionKind +

      ApiServerResource

      (Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) +ApiServerSourceSpec)

      -

      APIVersionKind is an APIVersion and Kind tuple.

      +

      ApiServerResource defines the resource to watch

      @@ -8253,7 +8449,7 @@ string @@ -8268,71 +8464,56 @@ string More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      - -
      -

      APIVersion - the API version of the resource to watch.

      +

      API version of the resource to watch.
      -

      APIVersionKindSelector -

      -

      -(Appears on: -ApiServerSourceSpec) -

      -

      -

      APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

      -

      - - - - - - - -
      FieldDescription
      -apiVersion
      +labelSelector
      -string + +Kubernetes meta/v1.LabelSelector +       		-

      APIVersion - the API version of the resource to watch.

      +

      LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
      -kind
      +controllerSelector
      -string + +Kubernetes meta/v1.OwnerReference +       		-

      Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      +

      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.
      -selector
      +controller
      - -Kubernetes meta/v1.LabelSelector - +bool       		-(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

      +

      If true, send an event referencing the object controlling the resource +Deprecated: Per-resource controller flag will no longer be supported in +v1alpha2, please use Spec.Owner as a GKV.
      -

      ApiServerSourceSpec +

      ApiServerSourceSpec

      (Appears on: -ApiServerSource) +ApiServerSource)

      ApiServerSourceSpec defines the desired state of ApiServerSource

      @@ -8343,92 +8524,95 @@ More info: +[]ApiServerResource + + + + +

      Resources is the list of resources to watch

      + + -SourceSpec
      +serviceAccountName
      -knative.dev/pkg/apis/duck/v1.SourceSpec +string -

      -(Members of SourceSpec are embedded into this type.) -

      -

      inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

      +(Optional) +

      ServiceAccountName is the name of the ServiceAccount to use to run this +source.

      -resources
      +sink
      - -[]APIVersionKindSelector - +knative.dev/pkg/apis/duck/v1beta1.Destination -

      Resource are the resources this source will track and send related -lifecycle events from the Kubernetes ApiServer, with an optional label -selector to help filter.

      +(Optional) +

      Sink is a reference to an object that will resolve to a domain name to use as the sink.

      -owner
      +ceOverrides
      - -APIVersionKind - +knative.dev/pkg/apis/duck/v1.CloudEventOverrides (Optional) -

      ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

      +

      CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.

      -mode
      +owner
      -string + +APIVersionKind + (Optional) -

      EventMode controls the format of the event. -Reference sends a dataref event type for the resource under watch. -Resource send the full resource lifecycle event. -Defaults to Reference

      +

      ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

      -serviceAccountName
      +mode
      string -(Optional) -

      ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set.

      +

      Mode is the mode the receive adapter controller runs under: Ref or Resource. +Ref sends only the reference to the resource. +Resource send the full resource.

      -

      ApiServerSourceStatus +

      ApiServerSourceStatus

      (Appears on: -ApiServerSource) +ApiServerSource)

      ApiServerSourceStatus defines the observed state of ApiServerSource

      @@ -8463,14 +8647,13 @@ Source.

      -

      ContainerSourceSpec +

      PingLimitsSpec

      (Appears on: -ContainerSource) +PingResourceSpec)

      -

      ContainerSourceSpec defines the desired state of ContainerSource

      @@ -8482,45 +8665,33 @@ Source.

      -SourceSpec
      +cpu
      -knative.dev/pkg/apis/duck/v1.SourceSpec +string       		-

      -(Members of SourceSpec are embedded into this type.) -

      -

      inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.
      -template
      +memory
      - -Kubernetes core/v1.PodTemplateSpec - +string       		-

      Template describes the pods that will be created
      -

      ContainerSourceStatus +

      PingRequestsSpec

      (Appears on: -ContainerSource) +PingResourceSpec)

      -

      ContainerSourceStatus defines the observed state of ContainerSource

      @@ -8532,31 +8703,73 @@ Kubernetes core/v1.PodTemplateSpec + + + + + + +
      -SourceStatus
      +cpu
      -knative.dev/pkg/apis/duck/v1.SourceStatus +string + +      		 +
      +memory
      + +string       		+
      +

      PingResourceSpec +

      -(Members of SourceStatus are embedded into this type.) +(Appears on: +PingSourceSpec)

      -

      inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source.

      +

      +

      + + + + + + + + + + + + + + +
      FieldDescription
      +requests
      + + +PingRequestsSpec + + +      		 +
      +limits
      + + +PingLimitsSpec + + +
      -

      PingSourceSpec +

      PingSourceSpec

      (Appears on: -PingSource) +PingSource)

      PingSourceSpec defines the desired state of the PingSource.

      @@ -8571,55 +8784,84 @@ Source.

      -SourceSpec
      +schedule
      -knative.dev/pkg/apis/duck/v1.SourceSpec +string -

      -(Members of SourceSpec are embedded into this type.) -

      -

      inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

      +

      Schedule is the cronjob schedule.

      -schedule
      +data
      string +

      Data is the data posted to the target function.

      + + + + +sink
      + +knative.dev/pkg/apis/duck/v1.Destination + + + +

      Sink is a reference to an object that will resolve to a uri to use as the sink.

      + + + + +ceOverrides
      + +knative.dev/pkg/apis/duck/v1.CloudEventOverrides + + + (Optional) -

      Schedule is the cronjob schedule. Defaults to * * * * *.

      +

      CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.

      -jsonData
      +serviceAccountName
      string -(Optional) -

      JsonData is json encoded data used as the body of the event posted to -the sink. Default is empty. If set, datacontenttype will also be set -to “application/json”.

      +

      ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. +Deprecated: v1beta1 drops this field.

      + + + + +resources
      + + +PingResourceSpec + + + + +

      Resource limits and Request specifications of the Receive Adapter Deployment +Deprecated: v1beta1 drops this field.

      -

      PingSourceStatus +

      PingSourceStatus

      (Appears on: -PingSource) +PingSource)

      PingSourceStatus defines the observed state of PingSource.

      @@ -8654,11 +8896,11 @@ Source.

      -

      SinkBindingSpec +

      SinkBindingSpec

      (Appears on: -SinkBinding) +SinkBinding)

      SinkBindingSpec holds the desired state of the SinkBinding (from the client).

      @@ -8682,11 +8924,6 @@ knative.dev/pkg/apis/duck/v1.SourceSpec

      (Members of SourceSpec are embedded into this type.)

      -

      inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

      @@ -8700,18 +8937,15 @@ 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 +

      SinkBindingStatus

      (Appears on: -SinkBinding) +SinkBinding)

      SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

      @@ -8735,13 +8969,6 @@ 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.

      @@ -8749,5 +8976,5 @@ Source.

      Generated with gen-crd-api-reference-docs -on git commit a00ee26a. +on git commit e018fe79.

      diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 1e0204fc17..aeb6ace010 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -4,9 +4,6 @@ autoscaling.internal.knative.dev/v1alpha1
    • -networking.internal.knative.dev/v1alpha1 -
      • -
    • serving.knative.dev/v1
    • @@ -149,7 +146,7 @@ Defaults to ReachabilityUnknown

      protocolType
      -knative.dev/serving/pkg/apis/networking.ProtocolType +knative.dev/networking/pkg/apis/networking.ProtocolType @@ -434,7 +431,7 @@ Defaults to ReachabilityUnknown

      protocolType
      -knative.dev/serving/pkg/apis/networking.ProtocolType +knative.dev/networking/pkg/apis/networking.ProtocolType @@ -711,23 +708,27 @@ int32 to the ScaleTarget of a PodAutoscaler

      -

      networking.internal.knative.dev/v1alpha1

      +

      serving.knative.dev/v1

      Resource Types: -

      Certificate +

      Configuration

      -

      Certificate is responsible for provisioning a SSL certificate for the -given hosts. It is a Knative abstraction for various SSL certificate -provisioning solutions (such as cert-manager or self-signed SSL certificate).

      +

      Configuration represents the “floating HEAD” of a linear history of Revisions. +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

      @@ -743,7 +744,7 @@ provisioning solutions (such as cert-manager or self-signed SSL certificate).

      @@ -752,7 +753,7 @@ networking.internal.knative.dev/v1alpha1 kind
      string - + @@ -775,39 +774,28 @@ Refer to the Kubernetes API documentation for the fields of the
      -networking.internal.knative.dev/v1alpha1 +serving.knative.dev/v1
      CertificateConfiguration
      @@ -765,8 +766,6 @@ Kubernetes meta/v1.ObjectMeta (Optional) -

      Standard object’s metadata. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

      Refer to the Kubernetes API documentation for the fields of the metadata field.       		spec
      - -CertificateSpec + +ConfigurationSpec       		(Optional) -

      Spec is the desired state of the Certificate. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status



      - - - -
      -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
      +template
      -string + +RevisionTemplateSpec +       		-

      SecretName is the name of the secret resource to store the SSL certificate in.

      +(Optional) +

      Template holds the latest specification for the Revision to be stamped out.
      @@ -817,27 +805,24 @@ string       		status
      - -CertificateStatus + +ConfigurationStatus       		(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 +

      Revision

      -

      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.

      +

      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

      @@ -853,7 +838,7 @@ which some highlighted modifications.

      string @@ -862,7 +847,7 @@ networking.internal.knative.dev/v1alpha1 kind
      string - + @@ -885,77 +868,58 @@ Refer to the Kubernetes API documentation for the fields of the
      -networking.internal.knative.dev/v1alpha1 +serving.knative.dev/v1
      IngressRevision
      @@ -875,8 +860,6 @@ Kubernetes meta/v1.ObjectMeta (Optional) -

      Standard object’s metadata. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

      Refer to the Kubernetes API documentation for the fields of the metadata field.       		spec
      - -IngressSpec + +RevisionSpec       		(Optional) -

      Spec is the desired state of the Ingress. -More info: https://github.com/kubernetes/community/blob/master/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
      +PodSpec
      - -[]IngressTLS + +Kubernetes core/v1.PodSpec       		-(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.

      +

      +(Members of PodSpec are embedded into this type.) +
      -rules
      +containerConcurrency
      - -[]IngressRule - +int64       		(Optional) -

      A list of host rules used to configure the Ingress.

      +

      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.
      -visibility
      +timeoutSeconds
      - -IngressVisibility - +int64       		-

      Visibility setting.

      +(Optional) +

      TimeoutSeconds holds the max duration the instance is allowed for +responding to a request. If unspecified, a system default will +be provided.
      @@ -965,26 +929,26 @@ IngressVisibility       		status
      - -IngressStatus + +RevisionStatus       		(Optional) -

      Status is the current state of the Ingress. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
      -

      ServerlessService +

      Route

      -

      ServerlessService is a proxy for the K8s service objects containing the -endpoints for the revision, whether those are endpoints of the activator or -revision pods. -See: https://knative.page.link/naxz for details.

      +

      Route is responsible for configuring ingress over a collection of Revisions. +Some of the Revisions a Route distributes traffic over may be specified by +referencing the Configuration responsible for creating them; in these cases +the Route is additionally responsible for monitoring the Configuration for +“latest ready revision” changes, and smoothly rolling out latest revisions. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

      @@ -1000,7 +964,7 @@ See: https://knative.page.link/naxz string @@ -1009,7 +973,7 @@ networking.internal.knative.dev/v1alpha1 kind
      string - + @@ -1032,68 +994,30 @@ Refer to the Kubernetes API documentation for the fields of the
      -networking.internal.knative.dev/v1alpha1 +serving.knative.dev/v1
      ServerlessServiceRoute
      @@ -1022,8 +986,6 @@ Kubernetes meta/v1.ObjectMeta (Optional) -

      Standard object’s metadata. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

      Refer to the Kubernetes API documentation for the fields of the metadata field.       		spec
      - -ServerlessServiceSpec + +RouteSpec       		(Optional) -

      Spec is the desired state of the ServerlessService. -More info: hhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

      +

      Spec holds the desired state of the Route (from the client).



      - - - - - - - - - - - -
      -mode
      - - -ServerlessServiceOperationMode - - -      		 -

      Mode describes the mode of operation of the ServerlessService.

      -
      -objectRef
      +traffic
      - -Kubernetes core/v1.ObjectReference + +[]TrafficTarget       		-

      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.

      +(Optional) +

      Traffic specifies how to distribute traffic over a collection of +revisions and configurations.
      @@ -1103,27 +1027,31 @@ O means — assign all.

      		 status
      - -ServerlessServiceStatus + +RouteStatus       		(Optional) -

      Status is the current state of the ServerlessService. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

      +

      Status communicates the observed state of the Route (from the controller).
      -

      CertificateSpec +

      Service

      -(Appears on: -Certificate) -

      -

      -

      CertificateSpec defines the desired state of a Certificate.

      +

      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

      @@ -1135,1480 +1063,109 @@ More info: CertificateStatus - -

      -(Appears on: -Certificate) -

      -

      -

      CertificateStatus defines the observed state of a Certificate.

      -

      -
      - - - - - - - - +
      +
      +
      FieldDescription
      -Status
      +metadata
      -knative.dev/pkg/apis/duck/v1.Status + +Kubernetes meta/v1.ObjectMeta +       		-

      -(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

      +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
      -notAfter
      +spec
      - -Kubernetes meta/v1.Time + +ServiceSpec       		(Optional) -

      The expiration time of the TLS certificate stored in the secret named -by this resource in spec.secretName.

      -
      - - -
      -http01Challenges
      +ConfigurationSpec
      - -[]HTTP01Challenge + +ConfigurationSpec       		-

      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.

      +(Members of ConfigurationSpec are embedded into this type.)

      - - - - - - - - - - - - - -
      FieldDescription
      -url
      - -knative.dev/pkg/apis.URL - -      		 -

      URL is the URL that the HTTP01 challenge is expected to serve on.

      +

      ServiceSpec inlines an unrestricted ConfigurationSpec.
      -serviceName
      +RouteSpec
      -string + +RouteSpec +       		-

      ServiceName is the name of the service to serve HTTP01 challenge requests.

      +

      +(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).
      -serviceNamespace
      - -string - -      		 -

      ServiceNamespace is the namespace of the service to serve HTTP01 challenge requests.

      +
      -servicePort
      +status
      -k8s.io/apimachinery/pkg/util/intstr.IntOrString + +ServiceStatus + -

      ServicePort is the port of the service to serve HTTP01 challenge requests.

      +(Optional) -

      HTTPIngressPath +

      ConfigurationSpec

      (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, +Configuration, ServiceSpec)

      @@ -5656,5 +4213,5 @@ ServiceStatus

      Generated with gen-crd-api-reference-docs -on git commit 12fd00119. +on git commit d74ecbeb1.