diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index 23ea84f56..fc553e067 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -161,8 +161,7 @@ This data may be out of date.

ConfigMapPropagationSpec

-(Appears on: -ConfigMapPropagation) +(Appears on:ConfigMapPropagation)

@@ -204,8 +203,7 @@ Kubernetes meta/v1.LabelSelector

ConfigMapPropagationStatus

-(Appears on: -ConfigMapPropagation) +(Appears on:ConfigMapPropagation)

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

@@ -253,8 +251,7 @@ knative.dev/pkg/apis/duck/v1.Status

ConfigMapPropagationStatusCopyConfigMap

-(Appears on: -ConfigMapPropagationStatus) +(Appears on:ConfigMapPropagationStatus)

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

@@ -345,8 +342,7 @@ Resource Types:

BackoffPolicyType (string alias)

-(Appears on: -DeliverySpec) +(Appears on:DeliverySpec)

BackoffPolicyType is the type for backoff policies

@@ -460,11 +456,7 @@ ChannelableStatus

ChannelableSpec

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

ChannelableSpec contains Spec of the Channelable object

@@ -513,10 +505,7 @@ global delivery spec.

ChannelableStatus

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

ChannelableStatus contains the Status of a Channelable object.

@@ -593,13 +582,7 @@ Failed messages are delivered here.

DeliverySpec

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

DeliverySpec contains the delivery options for event senders, @@ -779,9 +762,7 @@ configured as to be compatible with Subscribable contract.

SubscribableSpec

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

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

@@ -812,9 +793,7 @@ configured as to be compatible with Subscribable contract.

SubscribableStatus

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

SubscribableStatus is the schema for the subscribable’s status portion of the status @@ -846,8 +825,7 @@ section of the resource.

SubscriberSpec

-(Appears on: -SubscribableSpec) +(Appears on:SubscribableSpec)

SubscriberSpec defines a single subscriber to a Subscribable.

@@ -928,8 +906,7 @@ DeliverySpec

SubscriberStatus

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

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

@@ -1200,8 +1177,7 @@ ChannelableCombinedStatus

ChannelableCombinedSpec

-(Appears on: -ChannelableCombined) +(Appears on:ChannelableCombined)

ChannelableSpec contains Spec of the Channelable object

@@ -1265,8 +1241,7 @@ DeliverySpec

ChannelableCombinedStatus

-(Appears on: -ChannelableCombined) +(Appears on:ChannelableCombined)

ChannelableStatus contains the Status of a Channelable object.

@@ -1360,8 +1335,7 @@ Kubernetes core/v1.ObjectReference

ChannelableSpec

-(Appears on: -Channelable) +(Appears on:Channelable)

ChannelableSpec contains Spec of the Channelable object

@@ -1408,8 +1382,7 @@ DeliverySpec

ChannelableStatus

-(Appears on: -Channelable) +(Appears on:Channelable)

ChannelableStatus contains the Status of a Channelable object.

@@ -1517,8 +1490,7 @@ Refer to the Kubernetes API documentation for the fields of the

Subscribable

-(Appears on: -SubscribableTypeSpec) +(Appears on:SubscribableTypeSpec)

Subscribable is the schema for the subscribable portion of the spec @@ -1550,8 +1522,7 @@ section of the resource.

SubscribableStatus

-(Appears on: -SubscribableTypeStatus) +(Appears on:SubscribableTypeStatus)

SubscribableStatus is the schema for the subscribable’s status portion of the status @@ -1658,10 +1629,7 @@ configured as to be compatible with Subscribable contract.

SubscribableTypeSpec

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

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

@@ -1691,10 +1659,7 @@ Subscribable

SubscribableTypeStatus

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

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

@@ -1724,8 +1689,7 @@ SubscribableStatus

SubscriberSpec

-(Appears on: -Subscribable) +(Appears on:Subscribable)

SubscriberSpec defines a single subscriber to a Subscribable. @@ -1824,8 +1788,7 @@ Resource Types:

BackoffPolicyType (string alias)

-(Appears on: -DeliverySpec) +(Appears on:DeliverySpec)

BackoffPolicyType is the type for backoff policies

@@ -1937,10 +1900,7 @@ ChannelableStatus

ChannelableSpec

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

ChannelableSpec contains Spec of the Channelable object

@@ -1987,10 +1947,7 @@ DeliverySpec

ChannelableStatus

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

ChannelableStatus contains the Status of a Channelable object.

@@ -2067,16 +2024,7 @@ Failed messages are delivered here.

DeliverySpec

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

DeliverySpec contains the delivery options for event senders, @@ -2256,10 +2204,7 @@ configured as to be compatible with Subscribable contract.

SubscribableSpec

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

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

@@ -2290,10 +2235,7 @@ configured as to be compatible with Subscribable contract.

SubscribableStatus

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

SubscribableStatus is the schema for the subscribable’s status portion of the status @@ -2325,8 +2267,7 @@ section of the resource.

SubscriberSpec

-(Appears on: -SubscribableSpec) +(Appears on:SubscribableSpec)

SubscriberSpec defines a single subscriber to a Subscribable.

@@ -2407,9 +2348,7 @@ DeliverySpec

SubscriberStatus

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

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

@@ -2717,8 +2656,7 @@ date.

BrokerSpec

-(Appears on: -Broker) +(Appears on:Broker)

@@ -2764,8 +2702,7 @@ This includes things like retries, DLQ, etc.

BrokerStatus

-(Appears on: -Broker) +(Appears on:Broker)

BrokerStatus represents the current state of a Broker.

@@ -2811,8 +2748,7 @@ delivered into the Broker mesh.

TriggerFilter

-(Appears on: -TriggerSpec) +(Appears on:TriggerSpec)

@@ -2847,8 +2783,7 @@ specified values.

TriggerFilterAttributes (map[string]string alias)

-(Appears on: -TriggerFilter) +(Appears on:TriggerFilter)

TriggerFilterAttributes is a map of context attribute names to values for @@ -2858,8 +2793,7 @@ to indicate all strings match.

TriggerSpec

-(Appears on: -Trigger) +(Appears on:Trigger)

@@ -2914,8 +2848,7 @@ is required.

TriggerStatus

-(Appears on: -Trigger) +(Appears on:Trigger)

TriggerStatus represents the current state of a Trigger.

@@ -3359,8 +3292,7 @@ date.

BrokerSpec

-(Appears on: -Broker) +(Appears on:Broker)

@@ -3406,8 +3338,7 @@ This includes things like retries, DLQ, etc.

BrokerStatus

-(Appears on: -Broker) +(Appears on:Broker)

BrokerStatus represents the current state of a Broker.

@@ -3453,8 +3384,7 @@ delivered into the Broker mesh.

EventTypeSpec

-(Appears on: -EventType) +(Appears on:EventType)

@@ -3546,8 +3476,7 @@ string

EventTypeStatus

-(Appears on: -EventType) +(Appears on:EventType)

EventTypeStatus represents the current state of a EventType.

@@ -3581,8 +3510,7 @@ knative.dev/pkg/apis/duck/v1.Status

TriggerFilter

-(Appears on: -TriggerSpec) +(Appears on:TriggerSpec)

@@ -3617,8 +3545,7 @@ specified values.

TriggerFilterAttributes (map[string]string alias)

-(Appears on: -TriggerFilter) +(Appears on:TriggerFilter)

TriggerFilterAttributes is a map of context attribute names to values for @@ -3628,8 +3555,7 @@ to indicate all strings match.

TriggerSpec

-(Appears on: -Trigger) +(Appears on:Trigger)

@@ -3685,8 +3611,7 @@ is required.

TriggerStatus

-(Appears on: -Trigger) +(Appears on:Trigger)

TriggerStatus represents the current state of a Trigger.

@@ -3842,8 +3767,7 @@ date.

ParallelBranch

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

@@ -3911,8 +3835,7 @@ This includes things like retries, DLQ, etc.

ParallelBranchStatus

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

ParallelBranchStatus represents the current state of a Parallel branch

@@ -3969,9 +3892,7 @@ ParallelSubscriptionStatus

ParallelChannelStatus

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

@@ -4012,8 +3933,7 @@ knative.dev/pkg/apis.Condition

ParallelSpec

-(Appears on: -Parallel) +(Appears on:Parallel)

@@ -4071,8 +3991,7 @@ when the case does not have a Reply

ParallelStatus

-(Appears on: -Parallel) +(Appears on:Parallel)

ParallelStatus represents the current state of a Parallel.

@@ -4149,8 +4068,7 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

ParallelSubscriptionStatus

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

@@ -4295,8 +4213,7 @@ date.

SequenceChannelStatus

-(Appears on: -SequenceStatus) +(Appears on:SequenceStatus)

@@ -4337,8 +4254,7 @@ knative.dev/pkg/apis.Condition

SequenceSpec

-(Appears on: -Sequence) +(Appears on:Sequence)

@@ -4396,8 +4312,7 @@ knative.dev/pkg/apis/duck/v1.Destination

SequenceStatus

-(Appears on: -Sequence) +(Appears on:Sequence)

SequenceStatus represents the current state of a Sequence.

@@ -4475,8 +4390,7 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

SequenceStep

-(Appears on: -SequenceSpec) +(Appears on:SequenceSpec)

@@ -4522,8 +4436,7 @@ This includes things like retries, DLQ, etc.

SequenceSubscriptionStatus

-(Appears on: -SequenceStatus) +(Appears on:SequenceStatus)

@@ -4675,8 +4588,7 @@ date.

ParallelBranch

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

@@ -4745,8 +4657,7 @@ Needed for Roundtripping v1alpha1 <-> v1beta1.

ParallelBranchStatus

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

ParallelBranchStatus represents the current state of a Parallel branch

@@ -4803,9 +4714,7 @@ ParallelSubscriptionStatus

ParallelChannelStatus

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

@@ -4846,8 +4755,7 @@ knative.dev/pkg/apis.Condition

ParallelSpec

-(Appears on: -Parallel) +(Appears on:Parallel)

@@ -4905,8 +4813,7 @@ when the case does not have a Reply

ParallelStatus

-(Appears on: -Parallel) +(Appears on:Parallel)

ParallelStatus represents the current state of a Parallel.

@@ -4983,8 +4890,7 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

ParallelSubscriptionStatus

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

@@ -5129,8 +5035,7 @@ date.

SequenceChannelStatus

-(Appears on: -SequenceStatus) +(Appears on:SequenceStatus)

@@ -5171,8 +5076,7 @@ knative.dev/pkg/apis.Condition

SequenceSpec

-(Appears on: -Sequence) +(Appears on:Sequence)

@@ -5230,8 +5134,7 @@ knative.dev/pkg/apis/duck/v1.Destination

SequenceStatus

-(Appears on: -Sequence) +(Appears on:Sequence)

SequenceStatus represents the current state of a Sequence.

@@ -5309,8 +5212,7 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

SequenceStep

-(Appears on: -SequenceSpec) +(Appears on:SequenceSpec)

@@ -5356,8 +5258,7 @@ This includes things like retries, DLQ, etc.

SequenceSubscriptionStatus

-(Appears on: -SequenceStatus) +(Appears on:SequenceStatus)

@@ -5764,8 +5665,7 @@ specify any implementation.

ChannelSpec

-(Appears on: -Channel) +(Appears on:Channel)

ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. @@ -5814,8 +5714,7 @@ ChannelableSpec

ChannelStatus

-(Appears on: -Channel) +(Appears on:Channel)

ChannelStatus represents the current state of a Channel.

@@ -5860,10 +5759,7 @@ knative.dev/pkg/apis/duck/v1.KReference

ChannelTemplateSpec

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

@@ -5894,106 +5790,10 @@ 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
- - -ChannelTemplateSpecInternalSpec - - -		 -

Spec includes the Channel CR ChannelableSpec and the physical channel spec. -In order to create a new ChannelTemplateSpecInternalSpec, you must use NewChannelTemplateSpecInternalSpec

-
-
- -
-
-

ChannelTemplateSpecInternalSpec -

-

-(Appears on: -ChannelTemplateSpecInternal) -

-

-

ChannelTemplateSpecInternalSpec merges the “general” spec from Channel CR and the template of the physical channel spec. -Note that this struct properly implements only Marshalling, unmarshalling doesn’t work!

-

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

ChannelableSpec includes the fields from the Channel Spec section

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

PhysicalChannelSpec includes the fields from the physical channel Spec. Passed -in verbatim to the Channel CRD as Spec section.

-

InMemoryChannelSpec

-(Appears on: -InMemoryChannel) +(Appears on:InMemoryChannel)

InMemoryChannelSpec defines which subscribers have expressed interest in @@ -6029,8 +5829,7 @@ ChannelableSpec

InMemoryChannelStatus

-(Appears on: -InMemoryChannel) +(Appears on:InMemoryChannel)

ChannelStatus represents the current state of a Channel.

@@ -6064,8 +5863,7 @@ ChannelableStatus

SubscriptionSpec

-(Appears on: -Subscription) +(Appears on:Subscription)

SubscriptionSpec specifies the Channel for incoming events, a Subscriber target @@ -6162,8 +5960,7 @@ DeliverySpec

SubscriptionStatus

-(Appears on: -Subscription) +(Appears on:Subscription)

SubscriptionStatus (computed) for a subscription

@@ -6210,8 +6007,7 @@ SubscriptionStatusPhysicalSubscription

SubscriptionStatusPhysicalSubscription

-(Appears on: -SubscriptionStatus) +(Appears on:SubscriptionStatus)

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this @@ -6629,8 +6425,7 @@ specify any implementation.

ChannelSpec

-(Appears on: -Channel) +(Appears on:Channel)

ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. @@ -6679,8 +6474,7 @@ ChannelableSpec

ChannelStatus

-(Appears on: -Channel) +(Appears on:Channel)

ChannelStatus represents the current state of a Channel.

@@ -6725,10 +6519,7 @@ knative.dev/pkg/apis/duck/v1.KReference

ChannelTemplateSpec

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

@@ -6759,59 +6550,10 @@ 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) +(Appears on:InMemoryChannel)

InMemoryChannelSpec defines which subscribers have expressed interest in @@ -6847,8 +6589,7 @@ ChannelableSpec

InMemoryChannelStatus

-(Appears on: -InMemoryChannel) +(Appears on:InMemoryChannel)

ChannelStatus represents the current state of a Channel.

@@ -6882,8 +6623,7 @@ ChannelableStatus

SubscriptionSpec

-(Appears on: -Subscription) +(Appears on:Subscription)

SubscriptionSpec specifies the Channel for incoming events, a Subscriber target @@ -6980,8 +6720,7 @@ DeliverySpec

SubscriptionStatus

-(Appears on: -Subscription) +(Appears on:Subscription)

SubscriptionStatus (computed) for a subscription

@@ -7028,8 +6767,7 @@ SubscriptionStatusPhysicalSubscription

SubscriptionStatusPhysicalSubscription

-(Appears on: -SubscriptionStatus) +(Appears on:SubscriptionStatus)

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this @@ -7463,8 +7201,7 @@ SinkBindingStatus

APIVersionKind

-(Appears on: -ApiServerSourceSpec) +(Appears on:ApiServerSourceSpec)

APIVersionKind is an APIVersion and Kind tuple.

@@ -7505,8 +7242,7 @@ More info: APIVersionKindSelector

-(Appears on: -ApiServerSourceSpec) +(Appears on:ApiServerSourceSpec)

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

@@ -7563,8 +7299,7 @@ More info: ApiServerSourceSpec

-(Appears on: -ApiServerSource) +(Appears on:ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -7659,8 +7394,7 @@ source. Defaults to default if not set.

ApiServerSourceStatus

-(Appears on: -ApiServerSource) +(Appears on:ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -7698,8 +7432,7 @@ Source.

ContainerSourceSpec

-(Appears on: -ContainerSource) +(Appears on:ContainerSource)

ContainerSourceSpec defines the desired state of ContainerSource

@@ -7748,8 +7481,7 @@ Kubernetes core/v1.PodTemplateSpec

ContainerSourceStatus

-(Appears on: -ContainerSource) +(Appears on:ContainerSource)

ContainerSourceStatus defines the observed state of ContainerSource

@@ -7787,8 +7519,7 @@ Source.

SinkBindingSpec

-(Appears on: -SinkBinding) +(Appears on:SinkBinding)

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

@@ -7840,8 +7571,7 @@ should be augmented by Binding implementations.

SinkBindingStatus

-(Appears on: -SinkBinding) +(Appears on:SinkBinding)

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

@@ -8149,8 +7879,7 @@ SinkBindingStatus

ApiServerResource

-(Appears on: -ApiServerSourceSpec) +(Appears on:ApiServerSourceSpec)

ApiServerResource defines the resource to watch

@@ -8234,8 +7963,7 @@ v1alpha2, please use Spec.Owner as a GKV.

ApiServerSourceSpec

-(Appears on: -ApiServerSource) +(Appears on:ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -8333,8 +8061,7 @@ string

ApiServerSourceStatus

-(Appears on: -ApiServerSource) +(Appears on:ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -8372,8 +8099,7 @@ Source.

SinkBindingSpec

-(Appears on: -SinkBinding) +(Appears on:SinkBinding)

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

@@ -8417,8 +8143,7 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec

SinkBindingStatus

-(Appears on: -SinkBinding) +(Appears on:SinkBinding)

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

@@ -8951,9 +8676,7 @@ SinkBindingStatus

APIVersionKind

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

APIVersionKind is an APIVersion and Kind tuple.

@@ -8994,8 +8717,7 @@ More info: APIVersionKindSelector

-(Appears on: -ApiServerSourceSpec) +(Appears on:ApiServerSourceSpec)

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

@@ -9052,8 +8774,7 @@ More info: ApiServerSourceSpec

-(Appears on: -ApiServerSource) +(Appears on:ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -9148,8 +8869,7 @@ source. Defaults to default if not set.

ApiServerSourceStatus

-(Appears on: -ApiServerSource) +(Appears on:ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -9187,8 +8907,7 @@ Source.

ContainerSourceSpec

-(Appears on: -ContainerSource) +(Appears on:ContainerSource)

ContainerSourceSpec defines the desired state of ContainerSource

@@ -9237,8 +8956,7 @@ Kubernetes core/v1.PodTemplateSpec

ContainerSourceStatus

-(Appears on: -ContainerSource) +(Appears on:ContainerSource)

ContainerSourceStatus defines the observed state of ContainerSource

@@ -9276,8 +8994,7 @@ Source.

PingSourceSpec

-(Appears on: -PingSource) +(Appears on:PingSource)

PingSourceSpec defines the desired state of the PingSource.

@@ -9339,8 +9056,7 @@ to “application/json”.

PingSourceStatus

-(Appears on: -PingSource) +(Appears on:PingSource)

PingSourceStatus defines the observed state of PingSource.

@@ -9378,8 +9094,7 @@ Source.

SinkBindingSpec

-(Appears on: -SinkBinding) +(Appears on:SinkBinding)

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

@@ -9431,8 +9146,7 @@ should be augmented by Binding implementations.

SinkBindingStatus

-(Appears on: -SinkBinding) +(Appears on:SinkBinding)

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

@@ -9986,8 +9700,7 @@ SinkBindingStatus

APIVersionKind

-(Appears on: -ApiServerSourceSpec) +(Appears on:ApiServerSourceSpec)

APIVersionKind is an APIVersion and Kind tuple.

@@ -10028,8 +9741,7 @@ More info: APIVersionKindSelector

-(Appears on: -ApiServerSourceSpec) +(Appears on:ApiServerSourceSpec)

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

@@ -10086,8 +9798,7 @@ More info: ApiServerSourceSpec

-(Appears on: -ApiServerSource) +(Appears on:ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -10182,8 +9893,7 @@ source. Defaults to default if not set.

ApiServerSourceStatus

-(Appears on: -ApiServerSource) +(Appears on:ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -10221,8 +9931,7 @@ Source.

ContainerSourceSpec

-(Appears on: -ContainerSource) +(Appears on:ContainerSource)

ContainerSourceSpec defines the desired state of ContainerSource

@@ -10271,8 +9980,7 @@ Kubernetes core/v1.PodTemplateSpec

ContainerSourceStatus

-(Appears on: -ContainerSource) +(Appears on:ContainerSource)

ContainerSourceStatus defines the observed state of ContainerSource

@@ -10310,8 +10018,7 @@ Source.

PingSourceSpec

-(Appears on: -PingSource) +(Appears on:PingSource)

PingSourceSpec defines the desired state of the PingSource.

@@ -10387,8 +10094,7 @@ to “application/json”.

PingSourceStatus

-(Appears on: -PingSource) +(Appears on:PingSource)

PingSourceStatus defines the observed state of PingSource.

@@ -10426,8 +10132,7 @@ Source.

SinkBindingSpec

-(Appears on: -SinkBinding) +(Appears on:SinkBinding)

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

@@ -10479,8 +10184,7 @@ should be augmented by Binding implementations.

SinkBindingStatus

-(Appears on: -SinkBinding) +(Appears on:SinkBinding)

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

@@ -10683,8 +10387,7 @@ PingSourceStatus

PingSourceSpec

-(Appears on: -PingSource) +(Appears on:PingSource)

PingSourceSpec defines the desired state of the PingSource.

@@ -10784,8 +10487,7 @@ Mutually exclusive with Data.

PingSourceStatus

-(Appears on: -PingSource) +(Appears on:PingSource)

PingSourceStatus defines the observed state of PingSource.

@@ -10823,5 +10525,5 @@ Source.

Generated with gen-crd-api-reference-docs -on git commit a414aee50. +on git commit 86bc23919.

diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index 7f0a0c72e..058244d5b 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -23,8 +23,10 @@ Resource Types:

PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative components instantiate autoscalers. This definition is an abstraction that may be backed -by multiple definitions. For more information, see the Knative Pluggability presentation: -https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit

+by multiple definitions. + +For more information on Knative Autoscalers and Pluggability, +see the Knative Pluggability presentation.

@@ -252,8 +254,7 @@ MetricStatus

MetricSpec

-(Appears on: -Metric) +(Appears on:Metric)

MetricSpec contains all values a metric collector needs to operate.

@@ -304,8 +305,7 @@ string

MetricStatus

-(Appears on: -Metric) +(Appears on:Metric)

MetricStatus reflects the status of metric collection for this specific entity.

@@ -336,8 +336,7 @@ knative.dev/pkg/apis/duck/v1.Status

PodAutoscalerSpec

-(Appears on: -PodAutoscaler) +(Appears on:PodAutoscaler)

PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).

@@ -409,8 +408,7 @@ knative.dev/networking/pkg/apis/networking.ProtocolType

PodAutoscalerStatus

-(Appears on: -PodAutoscaler) +(Appears on:PodAutoscaler)

PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).

@@ -582,8 +580,7 @@ PodScalableStatus

PodScalableSpec

-(Appears on: -PodScalable) +(Appears on:PodScalable)

PodScalableSpec is the specification for the desired state of a @@ -636,8 +633,7 @@ Kubernetes core/v1.PodTemplateSpec

PodScalableStatus

-(Appears on: -PodScalable) +(Appears on:PodScalable)

PodScalableStatus is the observed state of a PodScalable (or at @@ -666,8 +662,7 @@ int32

ReachabilityType (string alias)

-(Appears on: -PodAutoscalerSpec) +(Appears on:PodAutoscalerSpec)

ReachabilityType is the enumeration type for the different states of reachability @@ -707,14 +702,18 @@ Resource Types:

  • Service
    • +

    For an overview of the different Resource Types in Knative Serving and how they interact with one another, see this explanation of 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

    + +For more information on how Configuration interacts with other Resource Types, see the "Configuration" sub-heading in the Resource Types Overview.

    @@ -808,7 +807,8 @@ ConfigurationStatus

    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

    + +

    For more information on how Revision interacts with other Resource Types, see the "Revision" sub-heading in the Resource Types Overview.

    @@ -934,7 +934,8 @@ 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

    + +For more information on how Route interacts with other Resource Types, see the "Route" sub-heading in the Resource Types Overview.

    @@ -1037,7 +1038,8 @@ 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

    + +

    For more information on how Service interacts with other Resource Types, see the "Service" sub-heading in the Resource Types Overview.

    @@ -1149,9 +1151,7 @@ ServiceStatus

    ConfigurationSpec

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

    ConfigurationSpec holds the desired state of the Configuration (from the client).

    @@ -1183,8 +1183,7 @@ RevisionTemplateSpec

    ConfigurationStatus

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

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

    @@ -1230,9 +1229,7 @@ ConfigurationStatusFields

    ConfigurationStatusFields

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

    ConfigurationStatusFields holds the fields of Configuration’s status that @@ -1278,8 +1275,7 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.<

    ContainerStatus

    -(Appears on: -RevisionStatus) +(Appears on:RevisionStatus)

    ContainerStatus holds the information of container name and image digest value

    @@ -1317,9 +1313,7 @@ string

    RevisionSpec

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

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

    @@ -1381,8 +1375,7 @@ be provided.

    RevisionStatus

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

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

    @@ -1452,7 +1445,7 @@ 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.

    +(see Kubernetes Deprecation Policy) for deprecation.

    @@ -1471,7 +1464,7 @@ 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

    +See the Proposal for multiple containers in a revision for some context on this field.

    @@ -1479,12 +1472,11 @@ ref: http://bit.ly/image-digests

    RevisionTemplateSpec

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

    +Based on the PodTemplateSpec in Kubernetes

    @@ -1575,9 +1567,7 @@ be provided.

    RouteSpec

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

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

    @@ -1610,8 +1600,7 @@ revisions and configurations.

    RouteStatus

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

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

    @@ -1657,9 +1646,7 @@ RouteStatusFields

    RouteStatusFields

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

    RouteStatusFields holds the fields of Route’s status that @@ -1750,8 +1737,7 @@ and is scaled down, but may be rapidly pinned to a route to be made active again

    ServiceSpec

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

    ServiceSpec represents the configuration for the Service object. @@ -1810,8 +1796,7 @@ defaults).

    ServiceStatus

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

    ServiceStatus represents the Status stanza of the Service resource.

    @@ -1876,9 +1861,7 @@ specific to RouteStatus.

    TrafficTarget

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

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

    @@ -2038,9 +2021,7 @@ Kubernetes meta/v1.ObjectMeta @@ -2055,7 +2036,7 @@ DomainMappingSpec @@ -2129,8 +2115,7 @@ string

    DomainMappingSpec

    -(Appears on: -DomainMapping) +(Appears on:DomainMapping)

    DomainMappingSpec describes the DomainMapping the user wishes to exist.

    @@ -2151,8 +2136,13 @@ knative.dev/pkg/apis/duck/v1.KReference @@ -2160,8 +2150,7 @@ Currently, Ref must be a KSvc.

    DomainMappingStatus

    -(Appears on: -DomainMapping) +(Appears on:DomainMapping)

    DomainMappingStatus describes the current state of the DomainMapping.

    @@ -2216,5 +2205,5 @@ knative.dev/pkg/apis/duck/v1.Addressable

    Generated with gen-crd-api-reference-docs -on git commit 560a4f678. +on git commit 6dba44a70.

    diff --git a/hack/gen-api-reference-docs.sh b/hack/gen-api-reference-docs.sh index 1ab4d8619..3e5d3b003 100755 --- a/hack/gen-api-reference-docs.sh +++ b/hack/gen-api-reference-docs.sh @@ -149,6 +149,8 @@ main() { gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ "${out_dir}/${KNATIVE_SERVING_OUT_FILE}" "${knative_serving_root}" "./pkg/apis" + cp "${out_dir}/${KNATIVE_SERVING_OUT_FILE}" "$SCRIPTDIR/../docs/reference/api/${KNATIVE_SERVING_OUT_FILE}" + local knative_eventing_root knative_eventing_root="${clone_root}/src/${KNATIVE_EVENTING_IMPORT_PATH}" clone_at_commit "https://${KNATIVE_EVENTING_REPO}.git" "${KNATIVE_EVENTING_COMMIT}" \ @@ -156,6 +158,8 @@ main() { gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ "${out_dir}/${KNATIVE_EVENTING_OUT_FILE}" "${knative_eventing_root}" "./pkg/apis" + cp "${out_dir}/${KNATIVE_EVENTING_OUT_FILE}" "$SCRIPTDIR/../docs/reference/api/${KNATIVE_EVENTING_OUT_FILE}" + # local knative_eventing_contrib_root # knative_eventing_contrib_root="${clone_root}/src/${KNATIVE_EVENTING_CONTRIB_IMPORT_PATH}" # clone_at_commit "https://${KNATIVE_EVENTING_CONTRIB_REPO}.git" "${KNATIVE_EVENTING_CONTRIB_COMMIT}" \ @@ -163,14 +167,8 @@ main() { # gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ # "${out_dir}/${KNATIVE_EVENTING_CONTRIB_OUT_FILE}" "${knative_eventing_contrib_root}" "." - log "SUCCESS: Generated docs written to ${out_dir}/." - log "Opening the ${out_dir}/ directory. You can now copy these API files" - log "from ${out_dir}/, into the 'docs/reference/' directory of knative/docs." - if command -v xdg-open >/dev/null; then - xdg-open "${out_dir}/" - elif command -v open >/dev/null; then - open "${out_dir}/" - fi + echo "Applying patches..." + git apply $SCRIPTDIR/patches/*.patch } main "$@" diff --git a/hack/patches/serving.patch b/hack/patches/serving.patch new file mode 100644 index 000000000..93af56c30 --- /dev/null +++ b/hack/patches/serving.patch @@ -0,0 +1,123 @@ +diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md +index 91f96fb9..3534d450 100644 +--- a/docs/reference/api/serving.md ++++ b/docs/reference/api/serving.md +@@ -23,8 +23,10 @@ Resource Types: +

    +

    PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative + components instantiate autoscalers. This definition is an abstraction that may be backed +-by multiple definitions. For more information, see the Knative Pluggability presentation: +-https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit

    ++by multiple definitions. ++ ++For more information on Knative Autoscalers and Pluggability, ++see the Knative Pluggability presentation.

    +

    +
    (Optional)

    Standard object’s metadata. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata

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

    Spec is the desired state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

    +Refer to the Kubernetes API documentation for more info on the DomainMappingSpec field.

    @@ -2067,8 +2048,13 @@ knative.dev/pkg/apis/duck/v1.KReference
    -

    Ref points to an Addressable. -Currently, Ref must be a KSvc.

    +

    Ref specifies the target of the Domain Mapping.

    +

    The object identified by the Ref must be an Addressable with a URL of the +form {name}.{namespace}.{domain} where {domain} is the cluster domain, +and {name} and {namespace} are the name and namespace of a Kubernetes +Service.

    +

    This contract is satisfied by Knative types such as Knative Services and +Knative Routes, and by Kubernetes Services.
    @@ -2086,7 +2072,7 @@ DomainMappingStatus     		(Optional)

    Status is the current state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

    +Refer to the Kubernetes API documentation for more info on the DomainMappingStatus field.
    -

    Ref points to an Addressable. -Currently, Ref must be a KSvc.

    +

    Ref specifies the target of the Domain Mapping.

    +

    The object identified by the Ref must be an Addressable with a URL of the +form {name}.{namespace}.{domain} where {domain} is the cluster domain, +and {name} and {namespace} are the name and namespace of a Kubernetes +Service.

    +

    This contract is satisfied by Knative types such as Knative Services and +Knative Routes, and by Kubernetes Services.
    + +@@ -707,14 +709,18 @@ Resource Types: +
  • + Service +
    • ++

    For an overview of the different Resource Types in Knative Serving and how they interact with one another, see this explanation of 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

    ++ ++For more information on how Configuration interacts with other Resource Types, see the "Configuration" sub-heading in the Resource Types Overview.

    +

    +
    + +@@ -808,7 +814,8 @@ ConfigurationStatus +

    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

    ++ ++

    For more information on how Revision interacts with other Resource Types, see the "Revision" sub-heading in the Resource Types Overview.

    +

    +
    + +@@ -934,7 +941,8 @@ 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

    ++ ++For more information on how Route interacts with other Resource Types, see the "Route" sub-heading in the Resource Types Overview.

    +

    +
    + +@@ -1037,7 +1045,8 @@ 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

    ++ ++

    For more information on how Service interacts with other Resource Types, see the "Service" sub-heading in the Resource Types Overview.

    +

    +
    + +@@ -1452,7 +1461,7 @@ 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.

    ++(see Kubernetes Deprecation Policy) for deprecation.

    + + + +@@ -1471,7 +1480,7 @@ 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

    ++See the Proposal for multiple containers in a revision for some context on this field.

    + + + +@@ -1484,7 +1493,7 @@ ref: http://bit.ly/image-digests

    +

    +

    +

    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

    ++Based on the PodTemplateSpec in Kubernetes

    +

    +
    + +@@ -2038,9 +2047,7 @@ Kubernetes meta/v1.ObjectMeta + + + +@@ -2055,7 +2062,7 @@ DomainMappingSpec +
    + (Optional) +

    Standard object’s metadata. +-More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata

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

    Spec is the desired state of the DomainMapping. +-More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

    ++Refer to the Kubernetes API documentation for more info on the DomainMappingSpec field. +
    +
    + +@@ -2086,7 +2093,7 @@ DomainMappingStatus + + +
    + (Optional) +

    Status is the current state of the DomainMapping. +-More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

    ++Refer to the Kubernetes API documentation for more info on the DomainMappingStatus field.

    +