From 292d0050fe95f8a075a62331c74786bf028383c9 Mon Sep 17 00:00:00 2001 From: Sam O'Dell <31352624+samodell@users.noreply.github.com> Date: Tue, 21 Jan 2020 16:23:23 -0800 Subject: [PATCH] Reference docs 0.12 (#2117) * v0.12 ref docs * mend --- docs/reference/eventing/eventing-contrib.md | 2 +- docs/reference/eventing/eventing.md | 2151 ++++++++++++------- docs/reference/serving.md | 926 ++++---- 3 files changed, 1805 insertions(+), 1274 deletions(-) diff --git a/docs/reference/eventing/eventing-contrib.md b/docs/reference/eventing/eventing-contrib.md index a1416d587..c38bc8388 100644 --- a/docs/reference/eventing/eventing-contrib.md +++ b/docs/reference/eventing/eventing-contrib.md @@ -2613,5 +2613,5 @@ knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus

Generated with gen-crd-api-reference-docs -on git commit c409ee07. +on git commit 395598e8.

diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index 00b16e121..44b4e3c2a 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,7 +1,7 @@

Packages:

-

sources.eventing.knative.dev/v1alpha1

+

sources.knative.dev/v1alpha1

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

Resource Types: -

ApiServerSource +

ApiServerSource

ApiServerSource is the Schema for the apiserversources API

@@ -49,7 +48,7 @@ Resource Types: string -sources.eventing.knative.dev/v1alpha1 +sources.knative.dev/v1alpha1 @@ -78,7 +77,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + ApiServerSourceSpec @@ -91,7 +90,7 @@ ApiServerSourceSpec resources
- + []ApiServerResource @@ -145,7 +144,7 @@ string status
- + ApiServerSourceStatus @@ -155,296 +154,7 @@ ApiServerSourceStatus -

ContainerSource -

-

-

ContainerSource is the Schema for the containersources API

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -sources.eventing.knative.dev/v1alpha1 - -
-kind
-string -		ContainerSource
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ContainerSourceSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 -(Optional) -

Template describes the pods that will be created

-
-image
- -string - -		 -

DeprecatedImage is the image to run inside of the container. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

-
-args
- -[]string - -		 -

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

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

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

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

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

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

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

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

CronJobSource -

-

-

CronJobSource is the Schema for the cronjobsources API.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-apiVersion
-string		 - -sources.eventing.knative.dev/v1alpha1 - -
-kind
-string -		CronJobSource
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -CronJobSourceSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - -
-schedule
- -string - -		 -

Schedule is the cronjob schedule.

-
-data
- -string - -		 -

Data is the data posted to the target function.

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

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

-
-serviceAccountName
- -string - -		 -

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

-
-resources
- - -CronJobResourceSpec - - -		 -

Resource limits and Request specifications of the Receive Adapter Deployment

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

SinkBinding +

SinkBinding

SinkBinding describes a Binding that is also a Source. @@ -468,7 +178,7 @@ cloud events.

string -sources.eventing.knative.dev/v1alpha1 +sources.knative.dev/v1alpha1 @@ -497,7 +207,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + SinkBindingSpec @@ -539,7 +249,7 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec status
- + SinkBindingStatus @@ -549,11 +259,11 @@ SinkBindingStatus -

ApiServerResource +

ApiServerResource

(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)

ApiServerResource defines the resource to watch

@@ -630,11 +340,11 @@ bool -

ApiServerSourceSpec +

ApiServerSourceSpec

(Appears on: -ApiServerSource) +ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -651,7 +361,7 @@ bool resources
- + []ApiServerResource @@ -700,11 +410,11 @@ string -

ApiServerSourceStatus +

ApiServerSourceStatus

(Appears on: -ApiServerSource) +ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -747,402 +457,11 @@ string -

ContainerSourceSpec +

SinkBindingSpec

(Appears on: -ContainerSource) -

-

-

ContainerSourceSpec defines the desired state of ContainerSource

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-template
- - -Kubernetes core/v1.PodTemplateSpec - - -		 -(Optional) -

Template describes the pods that will be created

-
-image
- -string - -		 -

DeprecatedImage is the image to run inside of the container. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

-
-args
- -[]string - -		 -

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

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

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

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

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

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

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

-
-

ContainerSourceStatus -

-

-(Appears on: -ContainerSource) -

-

-

ContainerSourceStatus defines the observed state of ContainerSource

-

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

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

-

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

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

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

-
-

CronJobLimitsSpec -

-

-(Appears on: -CronJobResourceSpec) -

-

-

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

CronJobRequestsSpec -

-

-(Appears on: -CronJobResourceSpec) -

-

-

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

CronJobResourceSpec -

-

-(Appears on: -CronJobSourceSpec) -

-

-

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

CronJobSourceSpec -

-

-(Appears on: -CronJobSource) -

-

-

CronJobSourceSpec defines the desired state of the CronJobSource.

-

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

Schedule is the cronjob schedule.

-
-data
- -string - -		 -

Data is the data posted to the target function.

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

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

-
-serviceAccountName
- -string - -		 -

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

-
-resources
- - -CronJobResourceSpec - - -		 -

Resource limits and Request specifications of the Receive Adapter Deployment

-
-

CronJobSourceStatus -

-

-(Appears on: -CronJobSource) -

-

-

CronJobSourceStatus defines the observed state of CronJobSource.

-

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

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

-

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

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

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

-
-

SinkBindingSpec -

-

-(Appears on: -SinkBinding) +SinkBinding)

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

@@ -1183,11 +502,11 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec -

SinkBindingStatus +

SinkBindingStatus

(Appears on: -SinkBinding) +SinkBinding)

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

@@ -1245,8 +564,8 @@ specify any implementation.

ChannelSpec, ParallelSpec, ParallelSpec, -SequenceSpec, -SequenceSpec) +SequenceSpec, +SequenceSpec)

@@ -1545,6 +864,7 @@ Kubernetes core/v1.ObjectReference

(Appears on: +BrokerSpec, ChannelableSpec, SubscriptionSpec)

@@ -1564,7 +884,7 @@ such as channelable and source.

deadLetterSink
-knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination @@ -1602,7 +922,7 @@ BackoffPolicyType -BackoffDelay
+backoffDelay
string @@ -1909,20 +1229,6 @@ At least one of SubscriberURI and ReplyURI must be present

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

Deprecated: use UID.

- - - - uid
k8s.io/apimachinery/pkg/types.UID @@ -2141,6 +1447,21 @@ Broker. If left unspecified, it is set to the default Channel CRD for the namesp are no defaults for the namespace).

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

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

+ + @@ -2448,6 +1769,21 @@ Broker. If left unspecified, it is set to the default Channel CRD for the namesp are no defaults for the namespace).

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

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

+ +

BrokerStatus @@ -2510,19 +1846,6 @@ Kubernetes core/v1.ObjectReference

TriggerChannel is an objectref to the object for the TriggerChannel

- - -IngressChannel
- - -Kubernetes core/v1.ObjectReference - - - - -

IngressChannel is an objectref to the object for the IngressChannel

- -

EventTypeSpec @@ -3610,6 +2933,1269 @@ knative.dev/pkg/apis.Condition
+

sources.eventing.knative.dev/v1alpha1

+

+

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

+

+Resource Types: + +

ApiServerSource +

+

+

ApiServerSource is the Schema for the apiserversources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.eventing.knative.dev/v1alpha1 + +
+kind
+string +		ApiServerSource
+Deprecated
+ + +Deprecated + + +		 +

Deprecated allows ApiServerSource to have a deprecated message.

+
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ApiServerSourceSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + +
+resources
+ + +[]ApiServerResource + + +		 +

Resources is the list of resources to watch

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

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

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

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

+
+mode
+ +string + +		 +

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

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

ContainerSource +

+

+

ContainerSource is the Schema for the containersources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.eventing.knative.dev/v1alpha1 + +
+kind
+string +		ContainerSource
+Deprecated
+ + +Deprecated + + +		 +

Deprecated allows ContainerSource to have a deprecated message.

+
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ContainerSourceSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +		 +(Optional) +

Template describes the pods that will be created

+
+image
+ +string + +		 +

DeprecatedImage is the image to run inside of the container. +This field is to be deprecated. Use Template instead. +When Template is set, this field is ignored.

+
+args
+ +[]string + +		 +

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

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

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

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

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

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

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

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

CronJobSource +

+

+

CronJobSource is the Schema for the cronjobsources API.

+

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

Deprecated allows CronJobSource to have a deprecated message.

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

Schedule is the cronjob schedule.

+
+data
+ +string + +		 +

Data is the data posted to the target function.

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

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

+
+serviceAccountName
+ +string + +		 +

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

+
+resources
+ + +CronJobResourceSpec + + +		 +

Resource limits and Request specifications of the Receive Adapter Deployment

+
+
+status
+ + +CronJobSourceStatus + + +		 +
+

SinkBinding +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.eventing.knative.dev/v1alpha1 + +
+kind
+string +		SinkBinding
+Deprecated
+ + +Deprecated + + +		 +

Deprecated allows ApiServerSource to have a deprecated message.

+
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +SinkBindingSpec + + +		 +
+
+ + + + + + + + + +
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +		 +

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

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

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

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

ApiServerResource +

+

+(Appears on: +ApiServerSourceSpec) +

+

+

ApiServerResource defines the resource to watch

+

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

API version of the resource to watch.

+
+kind
+ +string + +		 +

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

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

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

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

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

+
+controller
+ +bool + +		 +

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

+
+

ApiServerSourceSpec +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceSpec defines the desired state of ApiServerSource

+

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

Resources is the list of resources to watch

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

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

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

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

+
+mode
+ +string + +		 +

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

+
+

ApiServerSourceStatus +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

+

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

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

+

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

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

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

+
+

ContainerSourceSpec +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceSpec defines the desired state of ContainerSource

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +		 +(Optional) +

Template describes the pods that will be created

+
+image
+ +string + +		 +

DeprecatedImage is the image to run inside of the container. +This field is to be deprecated. Use Template instead. +When Template is set, this field is ignored.

+
+args
+ +[]string + +		 +

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

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

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

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

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

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

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

+
+

ContainerSourceStatus +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceStatus defines the observed state of ContainerSource

+

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

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

+

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

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

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

+
+

CronJobLimitsSpec +

+

+(Appears on: +CronJobResourceSpec) +

+

+

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

CronJobRequestsSpec +

+

+(Appears on: +CronJobResourceSpec) +

+

+

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

CronJobResourceSpec +

+

+(Appears on: +CronJobSourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+requests
+ + +CronJobRequestsSpec + + +		 +
+limits
+ + +CronJobLimitsSpec + + +		 +
+

CronJobSourceSpec +

+

+(Appears on: +CronJobSource) +

+

+

CronJobSourceSpec defines the desired state of the CronJobSource.

+

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

Schedule is the cronjob schedule.

+
+data
+ +string + +		 +

Data is the data posted to the target function.

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

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

+
+serviceAccountName
+ +string + +		 +

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

+
+resources
+ + +CronJobResourceSpec + + +		 +

Resource limits and Request specifications of the Receive Adapter Deployment

+
+

CronJobSourceStatus +

+

+(Appears on: +CronJobSource) +

+

+

CronJobSourceStatus defines the observed state of CronJobSource.

+

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

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

+

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

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

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

+
+

Deprecated +

+

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

+

+

+

SinkBindingSpec +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

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

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

+
+

SinkBindingStatus +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

+
+

messaging.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

@@ -3916,23 +4502,21 @@ etc.)

subscriber
-knative.dev/pkg/apis/duck/v1beta1.Destination +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 channel as specified by the Reply.

+sent to a Destination as specified by the Reply.

reply
- -ReplyStrategy - +knative.dev/pkg/apis/duck/v1.Destination @@ -4277,7 +4861,7 @@ for the namespace (or cluster, in case there are no defaults for the namespace). reply
-knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination @@ -4326,7 +4910,7 @@ date.

filter
-knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination @@ -4337,7 +4921,7 @@ knative.dev/pkg/apis/duck/v1beta1.Destination subscriber
-knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination @@ -4348,7 +4932,7 @@ knative.dev/pkg/apis/duck/v1beta1.Destination reply
-knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination @@ -4508,7 +5092,7 @@ for the namespace (or cluster, in case there are no defaults for the namespace). reply
-knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination @@ -4639,57 +5223,6 @@ knative.dev/pkg/apis.Condition -

ReplyStrategy -

-

-(Appears on: -SubscriptionSpec) -

-

-

ReplyStrategy specifies the handling of the Subscriber’s returned replies. -If no Subscriber is specified, the identity function is assumed.

-

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

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

-(Optional) -

The resource pointed by this Destination must meet the Addressable contract -with a reference to the Addressable duck type. If the resource does not meet this contract, -it will be reflected in the Subscription’s status.

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

The resource pointed by this ObjectReference must meet the Addressable contract -with a reference to the Addressable duck type. If the resource does not meet this contract, -it will be reflected in the Subscription’s status.

-

Sequence

@@ -4737,7 +5270,7 @@ SequenceSpec steps
-[]knative.dev/pkg/apis/duck/v1beta1.Destination +[]knative.dev/pkg/apis/duck/v1.Destination @@ -4764,7 +5297,7 @@ for the namespace (or cluster, in case there are no defaults for the namespace). reply
-knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination @@ -4854,7 +5387,7 @@ knative.dev/pkg/apis.Condition steps
-[]knative.dev/pkg/apis/duck/v1beta1.Destination +[]knative.dev/pkg/apis/duck/v1.Destination @@ -4881,7 +5414,7 @@ for the namespace (or cluster, in case there are no defaults for the namespace). reply
-knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination @@ -5078,23 +5611,21 @@ etc.)

subscriber
-knative.dev/pkg/apis/duck/v1beta1.Destination +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 channel as specified by the Reply.

+sent to a Destination as specified by the Reply.

reply
- -ReplyStrategy - +knative.dev/pkg/apis/duck/v1.Destination @@ -5223,5 +5754,5 @@ knative.dev/pkg/apis.URL

Generated with gen-crd-api-reference-docs -on git commit 3bf80459. +on git commit 8a92a8c9.

diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 1a0b37a39..92303437e 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1,9 +1,6 @@

Packages:

-

serving.knative.dev/v1beta1

-

-

-Resource Types: - -

Configuration -

-

-

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

-

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

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

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

Revision -

-

-

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

-

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

-

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

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

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

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

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

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

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

Route -

-

-

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

-

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

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

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

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

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

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

-
-

Service -

-

-

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

-

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

-

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

-

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

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

-

ServiceSpec inlines an unrestricted ConfigurationSpec.

-
-RouteSpec
- - -RouteSpec - - -		 -

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

-

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

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

autoscaling.internal.knative.dev/v1alpha1

@@ -3034,8 +2581,8 @@ ServiceStatus

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

@@ -3165,8 +2712,8 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.<

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

@@ -3231,8 +2778,8 @@ be provided.

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

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

@@ -3611,8 +3158,8 @@ defaults).

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

ServiceStatus represents the Status stanza of the Service resource.

@@ -5652,7 +5199,460 @@ Ultimately all non-v1 fields will be deprecated.

+

serving.knative.dev/v1beta1

+

+

+Resource Types: + +

Configuration +

+

+

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

+

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

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

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

Revision +

+

+

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

+

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

+

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

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

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

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

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

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

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

Route +

+

+

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

+

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

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

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

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

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

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

+
+

Service +

+

+

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

+

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

+

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

+

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

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

+

ServiceSpec inlines an unrestricted ConfigurationSpec.

+
+RouteSpec
+ + +RouteSpec + + +		 +

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

+

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

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

Generated with gen-crd-api-reference-docs -on git commit 96cffffa1. +on git commit bf0a84876.