docs/docs/reference/api/serving.md

Packages:

• serving.knative.dev/v1

serving.knative.dev/v1

Resource Types:

• Configuration
• Revision
• Route
• Service

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

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

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

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

Field	Description
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, ServiceSpec)

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

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

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

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

ContainerStatus

(Appears on: RevisionStatus)

ContainerStatus holds the information of container name and image digest value

Field	Description
name string
imageDigest string

RevisionSpec

(Appears on: Revision, RevisionTemplateSpec)

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

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

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

Field	Description
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) DeprecatedImageDigest holds the resolved digest for the image specified within .Spec.Container.Image. The digest is resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object. It may be empty if the image comes from a registry listed to skip resolution. If multiple containers specified then DeprecatedImageDigest holds the digest for serving container. DEPRECATED: Use ContainerStatuses instead. TODO(savitaashture) Remove deprecatedImageDigest. ref https://kubernetes.io/docs/reference/using-api/deprecation-policy for deprecation.
containerStatuses []ContainerStatus	(Optional) ContainerStatuses is a slice of images present in .Spec.Container[*].Image to their respective digests and their container name. The digests are resolved during the creation of Revision. ContainerStatuses holds the container name and image digests for both serving and non serving containers. ref: http://bit.ly/image-digests

RevisionTemplateSpec

(Appears on: ConfigurationSpec)

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

Field	Description
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, ServiceSpec)

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

Field	Description
traffic []TrafficTarget	(Optional) Traffic specifies how to distribute traffic over a collection of revisions and configurations.

RouteStatus

(Appears on: Route)

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

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

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

RoutingState (string alias)

RoutingState represents states of a revision with regards to serving a route.

ServiceSpec

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

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

ServiceStatus represents the Status stanza of the Service resource.

Field	Description
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 holds a single entry of the routing table for a Route.

Field	Description
tag string	(Optional) Tag is optionally used to expose a dedicated url for referencing this target exclusively.
revisionName string	(Optional) RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName.
configurationName string	(Optional) ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the “status.latestReadyRevisionName” of the referenced configuration changes, we will automatically migrate traffic from the prior “latest ready” revision to the new one. This field is never set in Route’s status, only its spec. This is mutually exclusive with RevisionName.
latestRevision bool	(Optional) LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty.
percent int64	(Optional) Percent indicates that percentage based routing should be used and the value indicates the percent of traffic that is be routed to this Revision or Configuration. 0 (zero) mean no traffic, 100 means all traffic. When percentage based routing is being used the follow rules apply: - the sum of all percent values must equal 100 - when not specified, the implied value for percent is zero for that particular Revision or Configuration
url knative.dev/pkg/apis.URL	(Optional) URL displays the URL for accessing named traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)

---

Generated with gen-crd-api-reference-docs on git commit af83e581d.