From 01fd1b3a3ab19aaa83b6d5074b388ae4661931f1 Mon Sep 17 00:00:00 2001 From: Ben Browning Date: Mon, 16 Dec 2019 23:06:02 -0500 Subject: [PATCH] v0.11.0 serving, eventing, eventing-contrib API reference docs (#2055) * v0.11.0 serving, eventing, eventing-contrib API reference docs * Update the broken generated knative.dev links This commit is entirely generated by running the following command on top of the generated Serving docs: sed -i 's@https://knative.dev/serving@https://github.com/knative/serving@g' $(find -name '*.md' | xargs grep knative.dev/serving | cut -d':' -f 1 | uniq) --- docs/reference/eventing/eventing-contrib.md | 142 +- docs/reference/eventing/eventing.md | 5231 ++++++++++++++++- docs/reference/serving.md | 5662 ++++++++++++++++++- 3 files changed, 10999 insertions(+), 36 deletions(-) diff --git a/docs/reference/eventing/eventing-contrib.md b/docs/reference/eventing/eventing-contrib.md index 007bdf0c2..1847e5e4f 100644 --- a/docs/reference/eventing/eventing-contrib.md +++ b/docs/reference/eventing/eventing-contrib.md @@ -224,9 +224,7 @@ CamelSourceOriginSpec sink
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1beta1.Destination @@ -379,7 +377,7 @@ string sink
-knative.dev/pkg/apis/v1alpha1.Destination +knative.dev/pkg/apis/duck/v1beta1.Destination @@ -538,9 +536,7 @@ secret token

sink
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1beta1.Destination @@ -696,7 +692,7 @@ KafkaSourceNetSpec sink
-knative.dev/pkg/apis/v1alpha1.Destination +knative.dev/pkg/apis/duck/v1beta1.Destination @@ -842,16 +838,63 @@ string -sink
+authTokenFile
- -Kubernetes core/v1.ObjectReference - +string (Optional) -

Sink is a reference to an object that will resolve to a domain +

The name of the file containing the authenication token

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

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

+ + + + +schedule
+ +string + + + +

A crontab-formatted schedule for running the PromQL query

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

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

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

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

@@ -1066,9 +1109,7 @@ CamelSourceOriginSpec sink
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1beta1.Destination @@ -1213,7 +1254,7 @@ string sink
-knative.dev/pkg/apis/v1alpha1.Destination +knative.dev/pkg/apis/duck/v1beta1.Destination @@ -1383,9 +1424,7 @@ secret token

sink
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1beta1.Destination @@ -1441,7 +1480,7 @@ bool Status
-knative.dev/pkg/apis/duck/v1alpha1.Status +knative.dev/pkg/apis/duck/v1.Status @@ -1761,7 +1800,7 @@ KafkaSourceNetSpec sink
-knative.dev/pkg/apis/v1alpha1.Destination +knative.dev/pkg/apis/duck/v1beta1.Destination @@ -1969,16 +2008,63 @@ string -sink
+authTokenFile
- -Kubernetes core/v1.ObjectReference - +string (Optional) -

Sink is a reference to an object that will resolve to a domain +

The name of the file containing the authenication token

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

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

+ + + + +schedule
+ +string + + + +

A crontab-formatted schedule for running the PromQL query

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

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

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

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

@@ -2527,5 +2613,5 @@ knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus

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

diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index 5ff07f011..76a642eb3 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,4 +1,5227 @@ - -

See the Knative Eventing repo for the API.

- -

There is currently an API doc build tool issue that we hope to resolve soon.

+

Packages:

+ +

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

+
+

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

+
+
+

duck.knative.dev/v1alpha1

+

+

Package v1alpha1 is the v1alpha1 version of the API.

+

+Resource Types: + +

BackoffPolicyType +(string alias)

+

+(Appears on: +DeliverySpec) +

+

+

BackoffPolicyType is the type for backoff policies

+

+

ChannelDefaulter +

+

+

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

+

+

ChannelTemplateSpec +

+

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

+
+
+ +
+
+

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

ChannelableSpec +

+

+(Appears on: +Channelable) +

+

+

ChannelableSpec contains Spec of the Channelable object

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+SubscribableTypeSpec
+ + +SubscribableTypeSpec + + +		 +

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

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

DeliverySpec contains options controlling the event delivery

+
+

ChannelableStatus +

+

+(Appears on: +Channelable) +

+

+

ChannelableStatus contains the Status of a Channelable object.

+

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

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

+

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

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

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

+

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

+
+SubscribableTypeStatus
+ + +SubscribableTypeStatus + + +		 +

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

+

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

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

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

+
+

DeliverySpec +

+

+(Appears on: +ChannelableSpec, +SubscriptionSpec) +

+

+

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

+

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

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

+
+retry
+ +int32 + +		 +(Optional) +

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

+
+backoffPolicy
+ + +BackoffPolicyType + + +		 +(Optional) +

BackoffPolicy is the retry backoff policy (linear, exponential)

+
+BackoffDelay
+ +string + +		 +(Optional) +

BackoffDelay is the delay before retrying. +More information on Duration format: https://www.ietf.org/rfc/rfc3339.txt

+

For linear policy, backoff delay is the time interval between retries. +For exponential policy , backoff delay is backoffDelay*2^

+
+

DeliveryStatus +

+

+

DeliveryStatus contains the Status of an object supporting delivery options.

+

+ + + + + + + + + + + + + +
FieldDescription
+deadLetterChannel
+ + +Kubernetes core/v1.ObjectReference + + +		 +(Optional) +

DeadLetterChannel is the reference to the native, platform specific channel +where failed events are sent to.

+
+

Resource +

+

+

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

+

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

Subscribable +

+

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

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+subscribers
+ + +[]SubscriberSpec + + +		 +

This is the list of subscriptions for this subscribable.

+
+

SubscribableStatus +

+

+(Appears on: +SubscribableTypeStatus) +

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+subscribers
+ + +[]SubscriberStatus + + +		 +

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

+
+

SubscribableType +

+

+

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

+

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

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

+
+
+ + + + + +
+subscribable
+ + +Subscribable + + +		 +
+
+status
+ + +SubscribableTypeStatus + + +		 +

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

+
+

SubscribableTypeSpec +

+

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

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+subscribable
+ + +Subscribable + + +		 +
+

SubscribableTypeStatus +

+

+(Appears on: +ChannelStatus, +ChannelableStatus, +InMemoryChannelStatus, +SubscribableType) +

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+subscribableStatus
+ + +SubscribableStatus + + +		 +
+

SubscriberSpec +

+

+(Appears on: +Subscribable) +

+

+

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

+

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

Deprecated: use UID.

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

SubscriberStatus +

+

+(Appears on: +SubscribableStatus) +

+

+

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

+

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

UID is used to understand the origin of the subscriber.

+
+observedGeneration
+ +int64 + +		 +(Optional) +

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

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

Status of the subscriber.

+
+message
+ +string + +		 +(Optional) +

A human readable message indicating details of Ready status.

+
+
+

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

+
+
+status
+ + +BrokerStatus + + +		 +(Optional) +

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

+
+

EventType +

+

+

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

Spec defines the desired state of the EventType.

+
+
+ + + + + + + + + + + + + + + + + + + + + +
+type
+ +string + +		 +

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +string + +		 +

Source is a URI, it represents the CloudEvents source.

+
+schema
+ +string + +		 +(Optional) +

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.

+
+broker
+ +string + +		 +

Broker refers to the Broker that can provide the EventType.

+
+description
+ +string + +		 +(Optional) +

Description is an optional field used to describe the EventType, in any meaningful way.

+
+
+status
+ + +EventTypeStatus + + +		 +(Optional) +

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

+
+

Trigger +

+

+

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

+

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

Spec defines the desired state of the Trigger.

+
+
+ + + + + + + + + + + + + +
+broker
+ +string + +		 +

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

+
+filter
+ + +TriggerFilter + + +		 +(Optional) +

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

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

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

+
+
+status
+ + +TriggerStatus + + +		 +(Optional) +

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

+
+

BrokerSpec +

+

+(Appears on: +Broker) +

+

+

+ + + + + + + + + + + + + +
FieldDescription
+channelTemplateSpec
+ + +ChannelTemplateSpec + + +		 +(Optional) +

ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the +Broker. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there +are no defaults for the namespace).

+
+

BrokerStatus +

+

+(Appears on: +Broker) +

+

+

BrokerStatus represents the current state of a Broker.

+

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

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

+

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

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

Broker is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster.

+

It generally has the form {broker}-router.{namespace}.svc.{cluster domain name}

+
+triggerChannel
+ + +Kubernetes core/v1.ObjectReference + + +		 +

TriggerChannel is an objectref to the object for the TriggerChannel

+
+IngressChannel
+ + +Kubernetes core/v1.ObjectReference + + +		 +

IngressChannel is an objectref to the object for the IngressChannel

+
+

EventTypeSpec +

+

+(Appears on: +EventType) +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ +string + +		 +

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +string + +		 +

Source is a URI, it represents the CloudEvents source.

+
+schema
+ +string + +		 +(Optional) +

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.

+
+broker
+ +string + +		 +

Broker refers to the Broker that can provide the EventType.

+
+description
+ +string + +		 +(Optional) +

Description is an optional field used to describe the EventType, in any meaningful way.

+
+

EventTypeStatus +

+

+(Appears on: +EventType) +

+

+

EventTypeStatus represents the current state of a EventType.

+

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

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

+

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

+
+

TriggerFilter +

+

+(Appears on: +TriggerSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+sourceAndType
+ + +TriggerFilterSourceAndType + + +		 +(Optional) +

DeprecatedSourceAndType filters events based on exact matches on the +CloudEvents type and source attributes. This field has been replaced by the +Attributes field.

+
+attributes
+ + +TriggerFilterAttributes + + +		 +(Optional) +

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

+

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

+
+

TriggerFilterAttributes +(map[string]string alias)

+

+(Appears on: +TriggerFilter) +

+

+

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

+

+

TriggerFilterSourceAndType +

+

+(Appears on: +TriggerFilter) +

+

+

TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and +source attributes. Only exact matches will pass the filter. Either or both type and source can +use the value “ to indicate all strings match.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ +string + +		 +
+source
+ +string + +		 +
+

TriggerSpec +

+

+(Appears on: +Trigger) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+broker
+ +string + +		 +

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

+
+filter
+ + +TriggerFilter + + +		 +(Optional) +

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

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

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

+
+

TriggerStatus +

+

+(Appears on: +Trigger) +

+

+

TriggerStatus represents the current state of a Trigger.

+

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

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

+

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

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

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

+
+
+

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

+
+
+status
+ + +ParallelStatus + + +		 +(Optional) +

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

+
+

ParallelBranch +

+

+(Appears on: +ParallelSpec) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+filter
+ +knative.dev/pkg/apis/duck/v1.Destination + +		 +

Filter is the expression guarding the branch

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

Subscriber receiving the event when the filter passes

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

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

+
+

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

+(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
+ +[]knative.dev/pkg/apis/duck/v1.Destination + +		 +

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

+
+channelTemplate
+ + +ChannelTemplateSpec + + +		 +(Optional) +

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

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

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

+
+
+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
+ +[]knative.dev/pkg/apis/duck/v1.Destination + +		 +

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

+
+channelTemplate
+ + +ChannelTemplateSpec + + +		 +(Optional) +

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

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

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

+
+

SequenceStatus +

+

+(Appears on: +Sequence) +

+

+

SequenceStatus represents the current state of a Sequence.

+

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

+
+subscriptionStatuses
+ + +[]SequenceSubscriptionStatus + + +		 +

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

+
+channelStatuses
+ + +[]SequenceChannelStatus + + +		 +

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

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

+(Members of AddressStatus 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}

+
+

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

+

+

Package v1alpha1 is the v1alpha1 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/v1alpha1 + +
+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.

+
+subscribable
+ + +Subscribable + + +		 +

Channel conforms to Duck type Subscribable.

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

+
+
+ + + + + +
+subscribable
+ + +Subscribable + + +		 +

Channel conforms to Duck type Subscribable.

+
+
+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/v1alpha1 + +
+kind
+string +		Subscription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +SubscriptionSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + +
+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

+
+channel
+ + +Kubernetes core/v1.ObjectReference + + +		 +

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
+ +knative.dev/pkg/apis/duck/v1beta1.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.

+
+reply
+ + +ReplyStrategy + + +		 +(Optional) +

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

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

Delivery configuration

+
+
+status
+ + +SubscriptionStatus + + +		 +
+

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.

+
+subscribable
+ + +Subscribable + + +		 +

Channel conforms to Duck type Subscribable.

+
+

ChannelStatus +

+

+(Appears on: +Channel) +

+

+

ChannelStatus represents the current state of a Channel.

+

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

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

+

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

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

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

+

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 +

+

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

+
+

InMemoryChannelStatus +

+

+(Appears on: +InMemoryChannel) +

+

+

ChannelStatus represents the current state of a Channel.

+

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

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

+

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

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

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

+

InMemoryChannel is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster.

+

It generally has the form {channel}.{namespace}.svc.{cluster domain name}

+
+SubscribableTypeStatus
+ + +SubscribableTypeStatus + + +		 +

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

+

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

+
+

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
+ +knative.dev/pkg/apis/duck/v1beta1.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
+ +knative.dev/pkg/apis/duck/v1beta1.Destination + +		 +

Filter is the expression guarding the branch

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

Subscriber receiving the event when the filter passes

+
+reply
+ +knative.dev/pkg/apis/duck/v1beta1.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

+
+

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
+ +knative.dev/pkg/apis/duck/v1beta1.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/v1alpha1.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.

+
+

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 +

+

+

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
+ +[]knative.dev/pkg/apis/duck/v1beta1.Destination + +		 +

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

+
+channelTemplate
+ + +ChannelTemplateSpec + + +		 +(Optional) +

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

+
+reply
+ +knative.dev/pkg/apis/duck/v1beta1.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
+ +[]knative.dev/pkg/apis/duck/v1beta1.Destination + +		 +

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

+
+channelTemplate
+ + +ChannelTemplateSpec + + +		 +(Optional) +

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

+
+reply
+ +knative.dev/pkg/apis/duck/v1beta1.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
+ +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.

+
+subscriptionStatuses
+ + +[]SequenceSubscriptionStatus + + +		 +

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

+
+channelStatuses
+ + +[]SequenceChannelStatus + + +		 +

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

+
+AddressStatus
+ +knative.dev/pkg/apis/duck/v1alpha1.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}

+
+

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.

+
+

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

+
+channel
+ + +Kubernetes core/v1.ObjectReference + + +		 +

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
+ +knative.dev/pkg/apis/duck/v1beta1.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.

+
+reply
+ + +ReplyStrategy + + +		 +(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
+ +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.

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

+
+
+

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

diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 7af9145d6..894d6a9f5 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1,4 +1,5658 @@ - -

See the Knative Serving repo for the API.

- -

There is currently an API doc build tool issue that we hope to resolve soon.

+

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

+

+

+Resource Types: + +

PodAutoscaler +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +autoscaling.internal.knative.dev/v1alpha1 + +
+kind
+string +		PodAutoscaler
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +PodAutoscalerSpec + + +		 +(Optional) +

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

+
+
+ + + + + + + + + + + + + + + + + + + + + +
+generation
+ +int64 + +		 +(Optional) +

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

+

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

+

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

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

ContainerConcurrency specifies the maximum allowed +in-flight (concurrent) requests per container of the Revision. +Defaults to 0 which means unlimited concurrency.

+
+scaleTargetRef
+ + +Kubernetes core/v1.ObjectReference + + +		 +

ScaleTargetRef defines the /scale-able resource that this PodAutoscaler +is responsible for quickly right-sizing.

+
+reachability
+ + +ReachabilityType + + +		 +(Optional) +

Reachable specifies whether or not the ScaleTargetRef can be reached (ie. has a route). +Defaults to ReachabilityUnknown

+
+protocolType
+ +knative.dev/serving/pkg/apis/networking.ProtocolType + +		 +

The application-layer protocol. Matches ProtocolType inferred from the revision spec.

+
+
+status
+ + +PodAutoscalerStatus + + +		 +(Optional) +

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

+
+

Metric +

+

+

Metric represents a resource to configure the metric collector with.

+

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

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

+
+
+ + + + + + + + + + + + + +
+stableWindow
+ +time.Duration + +		 +

StableWindow is the aggregation window for metrics in a stable state.

+
+panicWindow
+ +time.Duration + +		 +

PanicWindow is the aggregation window for metrics where quick reactions are needed.

+
+scrapeTarget
+ +string + +		 +

ScrapeTarget is the K8s service that publishes the metric endpoint.

+
+
+status
+ + +MetricStatus + + +		 +(Optional) +

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

+
+

MetricSpec +

+

+(Appears on: +Metric) +

+

+

MetricSpec contains all values a metric collector needs to operate.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+stableWindow
+ +time.Duration + +		 +

StableWindow is the aggregation window for metrics in a stable state.

+
+panicWindow
+ +time.Duration + +		 +

PanicWindow is the aggregation window for metrics where quick reactions are needed.

+
+scrapeTarget
+ +string + +		 +

ScrapeTarget is the K8s service that publishes the metric endpoint.

+
+

MetricStatus +

+

+(Appears on: +Metric) +

+

+

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

+

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

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

+
+

PodAutoscalerSpec +

+

+(Appears on: +PodAutoscaler) +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+generation
+ +int64 + +		 +(Optional) +

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

+

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

+

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

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

ContainerConcurrency specifies the maximum allowed +in-flight (concurrent) requests per container of the Revision. +Defaults to 0 which means unlimited concurrency.

+
+scaleTargetRef
+ + +Kubernetes core/v1.ObjectReference + + +		 +

ScaleTargetRef defines the /scale-able resource that this PodAutoscaler +is responsible for quickly right-sizing.

+
+reachability
+ + +ReachabilityType + + +		 +(Optional) +

Reachable specifies whether or not the ScaleTargetRef can be reached (ie. has a route). +Defaults to ReachabilityUnknown

+
+protocolType
+ +knative.dev/serving/pkg/apis/networking.ProtocolType + +		 +

The application-layer protocol. Matches ProtocolType inferred from the revision spec.

+
+

PodAutoscalerStatus +

+

+(Appears on: +PodAutoscaler) +

+

+

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

+

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

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

+
+serviceName
+ +string + +		 +

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

+
+metricsServiceName
+ +string + +		 +

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

+
+desiredScale
+ +int32 + +		 +

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

+
+actualScale
+ +int32 + +		 +

ActualScale shows the actual number of replicas for the revision.

+
+

PodScalable +

+

+

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

+

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

PodScalableSpec +

+

+(Appears on: +PodScalable) +

+

+

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

+

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

PodScalableStatus +

+

+(Appears on: +PodScalable) +

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+replicas
+ +int32 + +		 +
+

ReachabilityType +(string alias)

+

+(Appears on: +PodAutoscalerSpec) +

+

+

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

+

+
+

networking.internal.knative.dev/v1alpha1

+

+

+Resource Types: + +

Certificate +

+

+

Certificate is responsible for provisioning a SSL certificate for the +given hosts. It is a Knative abstraction for various SSL certificate +provisioning solutions (such as cert-manager or self-signed SSL certificate).

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +networking.internal.knative.dev/v1alpha1 + +
+kind
+string +		Certificate
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +

Standard object’s metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

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

Spec is the desired state of the Certificate. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+
+ + + + + + + + + +
+dnsNames
+ +[]string + +		 +

DNSNames is a list of DNS names the Certificate could support. +The wildcard format of DNSNames (e.g. *.default.example.com) is supported.

+
+secretName
+ +string + +		 +

SecretName is the name of the secret resource to store the SSL certificate in.

+
+
+status
+ + +CertificateStatus + + +		 +(Optional) +

Status is the current state of the Certificate. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

+
+

Ingress +

+

+

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined +by a backend. An Ingress can be configured to give services externally-reachable URLs, load +balance traffic, offer name based virtual hosting, etc.

+

This is heavily based on K8s Ingress https://godoc.org/k8s.io/api/networking/v1beta1#Ingress +which some highlighted modifications.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +networking.internal.knative.dev/v1alpha1 + +
+kind
+string +		Ingress
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +

Standard object’s metadata. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

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

Spec is the desired state of the Ingress. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

+
+
+ + + + + + + + + + + + + + + + + +
+generation
+ +int64 + +		 +(Optional) +

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

+

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

+

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

+
+tls
+ + +[]IngressTLS + + +		 +(Optional) +

TLS configuration. Currently Ingress only supports a single TLS +port: 443. If multiple members of this list specify different hosts, they +will be multiplexed on the same port according to the hostname specified +through the SNI TLS extension, if the ingress controller fulfilling the +ingress supports SNI.

+
+rules
+ + +[]IngressRule + + +		 +(Optional) +

A list of host rules used to configure the Ingress.

+
+visibility
+ + +IngressVisibility + + +		 +

Visibility setting.

+
+
+status
+ + +IngressStatus + + +		 +(Optional) +

Status is the current state of the Ingress. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

+
+

ServerlessService +

+

+

ServerlessService is a proxy for the K8s service objects containing the +endpoints for the revision, whether those are endpoints of the activator or +revision pods. +See: https://knative.page.link/naxz for details.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +networking.internal.knative.dev/v1alpha1 + +
+kind
+string +		ServerlessService
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +

Standard object’s metadata. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

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

Spec is the desired state of the ServerlessService. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

+
+
+ + + + + + + + + + + + + +
+mode
+ + +ServerlessServiceOperationMode + + +		 +

Mode describes the mode of operation of the ServerlessService.

+
+objectRef
+ + +Kubernetes core/v1.ObjectReference + + +		 +

ObjectRef defines the resource that this ServerlessService +is responsible for making “serverless”.

+
+ProtocolType
+ +knative.dev/serving/pkg/apis/networking.ProtocolType + +		 +

The application-layer protocol. Matches RevisionProtocolType set on the owning pa/revision. +serving imports networking, so just use string.

+
+
+status
+ + +ServerlessServiceStatus + + +		 +(Optional) +

Status is the current state of the ServerlessService. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

+
+

CertificateSpec +

+

+(Appears on: +Certificate) +

+

+

CertificateSpec defines the desired state of a Certificate.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+dnsNames
+ +[]string + +		 +

DNSNames is a list of DNS names the Certificate could support. +The wildcard format of DNSNames (e.g. *.default.example.com) is supported.

+
+secretName
+ +string + +		 +

SecretName is the name of the secret resource to store the SSL certificate in.

+
+

CertificateStatus +

+

+(Appears on: +Certificate) +

+

+

CertificateStatus defines the observed state of a Certificate.

+

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

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

+

When Certificate status is ready, it means: +- The target secret exists +- The target secret contains a certificate that has not expired +- The target secret contains a private key valid for the certificate

+
+notAfter
+ + +Kubernetes meta/v1.Time + + +		 +(Optional) +

The expiration time of the TLS certificate stored in the secret named +by this resource in spec.secretName.

+
+http01Challenges
+ + +[]HTTP01Challenge + + +		 +

HTTP01Challenges is a list of HTTP01 challenges that need to be fulfilled +in order to get the TLS certificate..

+
+

HTTP01Challenge +

+

+(Appears on: +CertificateStatus) +

+

+

HTTP01Challenge defines the status of a HTTP01 challenge that a certificate needs +to fulfill.

+

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

URL is the URL that the HTTP01 challenge is expected to serve on.

+
+serviceName
+ +string + +		 +

ServiceName is the name of the service to serve HTTP01 challenge requests.

+
+serviceNamespace
+ +string + +		 +

ServiceNamespace is the namespace of the service to serve HTTP01 challenge requests.

+
+servicePort
+ +k8s.io/apimachinery/pkg/util/intstr.IntOrString + +		 +

ServicePort is the port of the service to serve HTTP01 challenge requests.

+
+

HTTPIngressPath +

+

+(Appears on: +HTTPIngressRuleValue) +

+

+

HTTPIngressPath associates a path regex with a backend. Incoming URLs matching +the path are forwarded to the backend.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+path
+ +string + +		 +(Optional) +

Path is an extended POSIX regex as defined by IEEE Std 1003.1, +(i.e this follows the egrep/unix syntax, not the perl syntax) +matched against the path of an incoming request. Currently it can +contain characters disallowed from the conventional “path” +part of a URL as defined by RFC 3986. Paths must begin with +a ‘/’. If unspecified, the path defaults to a catch all sending +traffic to the backend.

+
+splits
+ + +[]IngressBackendSplit + + +		 +

Splits defines the referenced service endpoints to which the traffic +will be forwarded to.

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

AppendHeaders allow specifying additional HTTP headers to add +before forwarding a request to the destination service.

+

NOTE: This differs from K8s Ingress which doesn’t allow header appending.

+
+timeout
+ + +Kubernetes meta/v1.Duration + + +		 +(Optional) +

Timeout for HTTP requests.

+

NOTE: This differs from K8s Ingress which doesn’t allow setting timeouts.

+
+retries
+ + +HTTPRetry + + +		 +(Optional) +

Retry policy for HTTP requests.

+

NOTE: This differs from K8s Ingress which doesn’t allow retry settings.

+
+

HTTPIngressRuleValue +

+

+(Appears on: +IngressRule) +

+

+

HTTPIngressRuleValue is a list of http selectors pointing to backends. +In the example: http:///? -> backend where +where parts of the url correspond to RFC 3986, this resource will be used +to match against everything after the last ‘/’ and before the first ‘?’ +or ‘#’.

+

+ + + + + + + + + + + + + +
FieldDescription
+paths
+ + +[]HTTPIngressPath + + +		 +

A collection of paths that map requests to backends.

+

If they are multiple matching paths, the first match takes precendent.

+
+

HTTPRetry +

+

+(Appears on: +HTTPIngressPath) +

+

+

HTTPRetry describes the retry policy to use when a HTTP request fails.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+attempts
+ +int + +		 +

Number of retries for a given request.

+
+perTryTimeout
+ + +Kubernetes meta/v1.Duration + + +		 +

Timeout per retry attempt for a given request. format: 1h/1m/1s/1ms. MUST BE >=1ms.

+
+

IngressBackend +

+

+(Appears on: +IngressBackendSplit) +

+

+

IngressBackend describes all endpoints for a given service and port.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+serviceNamespace
+ +string + +		 +

Specifies the namespace of the referenced service.

+

NOTE: This differs from K8s Ingress to allow routing to different namespaces.

+
+serviceName
+ +string + +		 +

Specifies the name of the referenced service.

+
+servicePort
+ +k8s.io/apimachinery/pkg/util/intstr.IntOrString + +		 +

Specifies the port of the referenced service.

+
+

IngressBackendSplit +

+

+(Appears on: +HTTPIngressPath) +

+

+

IngressBackendSplit describes all endpoints for a given service and port.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+IngressBackend
+ + +IngressBackend + + +		 +

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

+

Specifies the backend receiving the traffic split.

+
+percent
+ +int + +		 +

Specifies the split percentage, a number between 0 and 100. If +only one split is specified, we default to 100.

+

NOTE: This differs from K8s Ingress to allow percentage split.

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

AppendHeaders allow specifying additional HTTP headers to add +before forwarding a request to the destination service.

+

NOTE: This differs from K8s Ingress which doesn’t allow header appending.

+
+

IngressRule +

+

+(Appears on: +IngressSpec) +

+

+

IngressRule represents the rules mapping the paths under a specified host to +the related backend services. Incoming requests are first evaluated for a host +match, then routed to the backend associated with the matching IngressRuleValue.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+hosts
+ +[]string + +		 +(Optional) +

Host is the fully qualified domain name of a network host, as defined +by RFC 3986. Note the following deviations from the “host” part of the +URI as defined in the RFC: +1. IPs are not allowed. Currently a rule value can only apply to the +IP in the Spec of the parent . +2. The : delimiter is not respected because ports are not allowed. +Currently the port of an Ingress is implicitly :80 for http and +:443 for https. +Both these may change in the future. +If the host is unspecified, the Ingress routes all traffic based on the +specified IngressRuleValue. +If multiple matching Hosts were provided, the first rule will take precedent.

+
+visibility
+ + +IngressVisibility + + +		 +(Optional) +

Visibility signifies whether this rule should ClusterLocal. If it’s not +specified then it defaults to ExternalIP.

+
+http
+ + +HTTPIngressRuleValue + + +		 +

HTTP represents a rule to apply against incoming requests. If the +rule is satisfied, the request is routed to the specified backend.

+
+

IngressSpec +

+

+(Appears on: +Ingress) +

+

+

IngressSpec describes the Ingress the user wishes to exist.

+

In general this follows the same shape as K8s Ingress. +Some notable differences: +- Backends now can have namespace: +- Traffic can be split across multiple backends. +- Timeout & Retry can be configured. +- Headers can be appended.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+generation
+ +int64 + +		 +(Optional) +

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

+

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

+

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

+
+tls
+ + +[]IngressTLS + + +		 +(Optional) +

TLS configuration. Currently Ingress only supports a single TLS +port: 443. If multiple members of this list specify different hosts, they +will be multiplexed on the same port according to the hostname specified +through the SNI TLS extension, if the ingress controller fulfilling the +ingress supports SNI.

+
+rules
+ + +[]IngressRule + + +		 +(Optional) +

A list of host rules used to configure the Ingress.

+
+visibility
+ + +IngressVisibility + + +		 +

Visibility setting.

+
+

IngressStatus +

+

+(Appears on: +Ingress) +

+

+

IngressStatus describe the current state of the Ingress.

+

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

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

+
+loadBalancer
+ + +LoadBalancerStatus + + +		 +(Optional) +

LoadBalancer contains the current status of the load-balancer. +This is to be superseded by the combination of PublicLoadBalancer and PrivateLoadBalancer

+
+publicLoadBalancer
+ + +LoadBalancerStatus + + +		 +(Optional) +

PublicLoadBalancer contains the current status of the load-balancer.

+
+privateLoadBalancer
+ + +LoadBalancerStatus + + +		 +(Optional) +

PrivateLoadBalancer contains the current status of the load-balancer.

+
+

IngressTLS +

+

+(Appears on: +IngressSpec) +

+

+

IngressTLS describes the transport layer security associated with an Ingress.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+hosts
+ +[]string + +		 +(Optional) +

Hosts is a list of hosts included in the TLS certificate. The values in +this list must match the name/s used in the tlsSecret. Defaults to the +wildcard host setting for the loadbalancer controller fulfilling this +Ingress, if left unspecified.

+
+secretName
+ +string + +		 +

SecretName is the name of the secret used to terminate SSL traffic.

+
+secretNamespace
+ +string + +		 +

SecretNamespace is the namespace of the secret used to terminate SSL traffic.

+
+serverCertificate
+ +string + +		 +(Optional) +

ServerCertificate identifies the certificate filename in the secret. +Defaults to tls.crt.

+
+privateKey
+ +string + +		 +(Optional) +

PrivateKey identifies the private key filename in the secret. +Defaults to tls.key.

+
+

IngressVisibility +(string alias)

+

+(Appears on: +IngressRule, +IngressSpec) +

+

+

IngressVisibility describes whether the Ingress should be exposed to +public gateways or not.

+

+

LoadBalancerIngressStatus +

+

+(Appears on: +LoadBalancerStatus) +

+

+

LoadBalancerIngressStatus represents the status of a load-balancer ingress point: +traffic intended for the service should be sent to an ingress point.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+ip
+ +string + +		 +(Optional) +

IP is set for load-balancer ingress points that are IP based +(typically GCE or OpenStack load-balancers)

+
+domain
+ +string + +		 +(Optional) +

Domain is set for load-balancer ingress points that are DNS based +(typically AWS load-balancers)

+
+domainInternal
+ +string + +		 +(Optional) +

DomainInternal is set if there is a cluster-local DNS name to access the Ingress.

+

NOTE: This differs from K8s Ingress, since we also desire to have a cluster-local +DNS name to allow routing in case of not having a mesh.

+
+meshOnly
+ +bool + +		 +(Optional) +

MeshOnly is set if the Ingress is only load-balanced through a Service mesh.

+
+

LoadBalancerStatus +

+

+(Appears on: +IngressStatus) +

+

+

LoadBalancerStatus represents the status of a load-balancer.

+

+ + + + + + + + + + + + + +
FieldDescription
+ingress
+ + +[]LoadBalancerIngressStatus + + +		 +(Optional) +

Ingress is a list containing ingress points for the load-balancer. +Traffic intended for the service should be sent to these ingress points.

+
+

ServerlessServiceOperationMode +(string alias)

+

+(Appears on: +ServerlessServiceSpec) +

+

+

ServerlessServiceOperationMode is an enumeration of the modes of operation +for the ServerlessService.

+

+

ServerlessServiceSpec +

+

+(Appears on: +ServerlessService) +

+

+

ServerlessServiceSpec describes the ServerlessService.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+mode
+ + +ServerlessServiceOperationMode + + +		 +

Mode describes the mode of operation of the ServerlessService.

+
+objectRef
+ + +Kubernetes core/v1.ObjectReference + + +		 +

ObjectRef defines the resource that this ServerlessService +is responsible for making “serverless”.

+
+ProtocolType
+ +knative.dev/serving/pkg/apis/networking.ProtocolType + +		 +

The application-layer protocol. Matches RevisionProtocolType set on the owning pa/revision. +serving imports networking, so just use string.

+
+

ServerlessServiceStatus +

+

+(Appears on: +ServerlessService) +

+

+

ServerlessServiceStatus describes the current state of the ServerlessService.

+

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

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

+
+serviceName
+ +string + +		 +(Optional) +

ServiceName holds the name of a core K8s Service resource that +load balances over the pods backing this Revision (activator or revision).

+
+privateServiceName
+ +string + +		 +(Optional) +

PrivateServiceName holds the name of a core K8s Service resource that +load balances over the user service pods backing this Revision.

+
+
+

serving.knative.dev/v1

+

+

+Resource Types: + +

Configuration +

+

+

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

+

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

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

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

Revision +

+

+

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

+

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

+

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

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

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

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

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

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

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

Route +

+

+

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

+

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

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

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

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

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

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

+
+

Service +

+

+

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

+

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

+

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

+

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

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

+

ServiceSpec inlines an unrestricted ConfigurationSpec.

+
+RouteSpec
+ + +RouteSpec + + +		 +

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

+

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

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

ConfigurationSpec +

+

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

+

+

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

+

+ + + + + + + + + + + + + +
FieldDescription
+template
+ + +RevisionTemplateSpec + + +		 +(Optional) +

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

+
+

ConfigurationStatus +

+

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

+

+

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

+

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

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

+
+ConfigurationStatusFields
+ + +ConfigurationStatusFields + + +		 +

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

+
+

ConfigurationStatusFields +

+

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

+

+

ConfigurationStatusFields holds the fields of Configuration’s status that +are not generally shared. This is defined separately and inlined so that +other types can readily consume these fields via duck typing.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+latestReadyRevisionName
+ +string + +		 +(Optional) +

LatestReadyRevisionName holds the name of the latest Revision stamped out +from this Configuration that has had its “Ready” condition become “True”.

+
+latestCreatedRevisionName
+ +string + +		 +(Optional) +

LatestCreatedRevisionName is the last revision that was created from this +Configuration. It might not be ready yet, for that use LatestReadyRevisionName.

+
+

RevisionSpec +

+

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

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+PodSpec
+ + +Kubernetes core/v1.PodSpec + + +		 +

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

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

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

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

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

+
+

RevisionStatus +

+

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

+

+

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

+

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

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

+
+serviceName
+ +string + +		 +(Optional) +

ServiceName holds the name of a core Kubernetes Service resource that +load balances over the pods backing this Revision.

+
+logUrl
+ +string + +		 +(Optional) +

LogURL specifies the generated logging url for this particular revision +based on the revision url template specified in the controller’s config.

+
+imageDigest
+ +string + +		 +(Optional) +

ImageDigest holds the resolved digest for the image specified +within .Spec.Container.Image. The digest is resolved during the creation +of Revision. This field holds the digest value regardless of whether +a tag or digest was originally specified in the Container object. It +may be empty if the image comes from a registry listed to skip resolution.

+
+

RevisionTemplateSpec +

+

+(Appears on: +ConfigurationSpec) +

+

+

RevisionTemplateSpec describes the data a revision should have when created from a template. +Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +RevisionSpec + + +		 +(Optional) +
+
+ + + + + + + + + + + + + +
+PodSpec
+ + +Kubernetes core/v1.PodSpec + + +		 +

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

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

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

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

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

+
+
+

RouteSpec +

+

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

+

+

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

+

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

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

+
+

RouteStatus +

+

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

+

+

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

+

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

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

+
+RouteStatusFields
+ + +RouteStatusFields + + +		 +

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

+
+

RouteStatusFields +

+

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

+

+

RouteStatusFields holds the fields of Route’s status that +are not generally shared. This is defined separately and inlined so that +other types can readily consume these fields via duck typing.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+url
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +

URL holds the url that will distribute traffic over the provided traffic targets. +It generally has the form http[s]://{route-name}.{route-namespace}.{cluster-level-suffix}

+
+address
+ +knative.dev/pkg/apis/duck/v1.Addressable + +		 +(Optional) +

Address holds the information needed for a Route to be the target of an event.

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

Traffic holds the configured traffic distribution. +These entries will always contain RevisionName references. +When ConfigurationName appears in the spec, this will hold the +LatestReadyRevisionName that we last observed.

+
+

ServiceSpec +

+

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

+

+

ServiceSpec represents the configuration for the Service object. +A Service’s specification is the union of the specifications for a Route +and Configuration. The Service restricts what can be expressed in these +fields, e.g. the Route must reference the provided Configuration; +however, these limitations also enable friendlier defaulting, +e.g. Route never needs a Configuration name, and may be defaulted to +the appropriate “run latest” spec.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+ConfigurationSpec
+ + +ConfigurationSpec + + +		 +

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

+

ServiceSpec inlines an unrestricted ConfigurationSpec.

+
+RouteSpec
+ + +RouteSpec + + +		 +

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

+

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

+
+

ServiceStatus +

+

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

+

+

ServiceStatus represents the Status stanza of the Service resource.

+

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

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

+
+ConfigurationStatusFields
+ + +ConfigurationStatusFields + + +		 +

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

+

In addition to inlining ConfigurationSpec, we also inline the fields +specific to ConfigurationStatus.

+
+RouteStatusFields
+ + +RouteStatusFields + + +		 +

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

+

In addition to inlining RouteSpec, we also inline the fields +specific to RouteStatus.

+
+

TrafficTarget +

+

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

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+tag
+ +string + +		 +(Optional) +

Tag is optionally used to expose a dedicated url for referencing +this target exclusively.

+
+revisionName
+ +string + +		 +(Optional) +

RevisionName of a specific revision to which to send this portion of +traffic. This is mutually exclusive with ConfigurationName.

+
+configurationName
+ +string + +		 +(Optional) +

ConfigurationName of a configuration to whose latest revision we will send +this portion of traffic. When the “status.latestReadyRevisionName” of the +referenced configuration changes, we will automatically migrate traffic +from the prior “latest ready” revision to the new one. This field is never +set in Route’s status, only its spec. This is mutually exclusive with +RevisionName.

+
+latestRevision
+ +bool + +		 +(Optional) +

LatestRevision may be optionally provided to indicate that the latest +ready Revision of the Configuration should be used for this traffic +target. When provided LatestRevision must be true if RevisionName is +empty; it must be false when RevisionName is non-empty.

+
+percent
+ +int64 + +		 +(Optional) +

Percent indicates that percentage based routing should be used and +the value indicates the percent of traffic that is be routed to this +Revision or Configuration. 0 (zero) mean no traffic, 100 means all +traffic. +When percentage based routing is being used the follow rules apply: +- the sum of all percent values must equal 100 +- when not specified, the implied value for percent is zero for +that particular Revision or Configuration

+
+url
+ +knative.dev/pkg/apis.URL + +		 +(Optional) +

URL displays the URL for accessing named traffic targets. URL is displayed in +status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and +a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)

+
+
+

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.

+
+concurrencyModel
+ + +DeprecatedRevisionRequestConcurrencyModelType + + +		 +(Optional) +

DeprecatedConcurrencyModel specifies the desired concurrency model +(Single or Multi) for the +Revision. Defaults to Multi. +Deprecated in favor of ContainerConcurrency.

+
+buildName
+ +string + +		 +(Optional) +

DeprecatedBuildName optionally holds the name of the Build responsible for +producing the container image for its Revision. +DEPRECATED: Use DeprecatedBuildRef instead.

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

DeprecatedBuildRef holds the reference to the build (if there is one) responsible +for producing the container image for this Revision. Otherwise, nil

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

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

+
+
+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
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

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

+
+ConfigurationStatusFields
+ + +ConfigurationStatusFields + + +		 +

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

+
+

ConfigurationStatusFields +

+

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

+

+

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

+
+

DeprecatedRevisionRequestConcurrencyModelType +(string alias)

+

+(Appears on: +RevisionSpec) +

+

+

DeprecatedRevisionRequestConcurrencyModelType is an enumeration of the +concurrency models supported by a Revision. +DEPRECATED in favor of an integer based ContainerConcurrency setting. +TODO(vagababov): retire completely in 0.9.

+

+

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.

+
+concurrencyModel
+ + +DeprecatedRevisionRequestConcurrencyModelType + + +		 +(Optional) +

DeprecatedConcurrencyModel specifies the desired concurrency model +(Single or Multi) for the +Revision. Defaults to Multi. +Deprecated in favor of ContainerConcurrency.

+
+buildName
+ +string + +		 +(Optional) +

DeprecatedBuildName optionally holds the name of the Build responsible for +producing the container image for its Revision. +DEPRECATED: Use DeprecatedBuildRef instead.

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

DeprecatedBuildRef holds the reference to the build (if there is one) responsible +for producing the container image for this Revision. Otherwise, nil

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

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

+
+

RevisionStatus +

+

+(Appears on: +Revision) +

+

+

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

+

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

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

+
+serviceName
+ +string + +		 +(Optional) +

ServiceName holds the name of a core Kubernetes Service resource that +load balances over the pods backing this Revision.

+
+logUrl
+ +string + +		 +(Optional) +

LogURL specifies the generated logging url for this particular revision +based on the revision url template specified in the controller’s config.

+
+imageDigest
+ +string + +		 +(Optional) +

ImageDigest holds the resolved digest for the image specified +within .Spec.Container.Image. The digest is resolved during the creation +of Revision. This field holds the digest value regardless of whether +a tag or digest was originally specified in the Container object. It +may be empty if the image comes from a registry listed to skip resolution.

+
+

RevisionTemplateSpec +

+

+(Appears on: +ConfigurationSpec) +

+

+

RevisionTemplateSpec describes the data a revision should have when created from a template. +Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +RevisionSpec + + +		 +(Optional) +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+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.

+
+concurrencyModel
+ + +DeprecatedRevisionRequestConcurrencyModelType + + +		 +(Optional) +

DeprecatedConcurrencyModel specifies the desired concurrency model +(Single or Multi) for the +Revision. Defaults to Multi. +Deprecated in favor of ContainerConcurrency.

+
+buildName
+ +string + +		 +(Optional) +

DeprecatedBuildName optionally holds the name of the Build responsible for +producing the container image for its Revision. +DEPRECATED: Use DeprecatedBuildRef instead.

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

DeprecatedBuildRef holds the reference to the build (if there is one) responsible +for producing the container image for this Revision. Otherwise, nil

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

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

+
+
+

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
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

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

+
+RouteStatusFields
+ + +RouteStatusFields + + +		 +

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

+
+

RouteStatusFields +

+

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

+

+

RouteStatusFields holds 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
+ +knative.dev/pkg/apis/duck/v1alpha1.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
+ +knative.dev/pkg/apis/duck/v1.Status + +		 +

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

+
+RouteStatusFields
+ + +RouteStatusFields + + +		 +

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

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

+
+
+

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