Knative Serving Component

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

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

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

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

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

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

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 optionally holds the specification for the build to perform to produce the Revision’s container image.

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 holds the latest specification for the Revision to be stamped out.

(Members of Status are embedded into this type.)

(Members of ConfigurationStatusFields are embedded into this type.)

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

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

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

The configuration for this service.

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 is the percent of traffic that should be sent to the “candidate” revision. Valid values are between 0 and 99 inclusive.

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

(Members of RevisionSpec are embedded into this type.)

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

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.

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

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

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

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

(Members of Status are embedded into this type.)

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

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

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.

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 specifies how to distribute traffic over a collection of Knative Serving Revisions and Configurations.

(Members of Status are embedded into this type.)

(Members of RouteStatusFields are embedded into this type.)

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}

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}

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 holds the information needed for a Route to be the target of an event.

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.

The configuration for this service.

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

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

DeprecatedPinned is DEPRECATED in favor of ReleaseType

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 enables gradual promotion of new revisions by allowing traffic to be split between two revisions. This type replaces the deprecated Pinned type.

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

(Members of RouteSpec are embedded into this type.)

(Members of Status are embedded into this type.)

(Members of RouteStatusFields are embedded into this type.)

(Members of ConfigurationStatusFields are embedded into this type.)

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

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

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

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

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

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

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

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

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

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

ScrapeTarget is the K8s service that publishes the metric endpoint.

(Members of Status are embedded into this type.)

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 specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Defaults to 0 which means unlimited concurrency.

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

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

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

(Members of Status are embedded into this type.)

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 is the K8s Service name that provides revision metrics. The service is managed by the PA object.

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

ActualScale shows the actual number of replicas for the revision.

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

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

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

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

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

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

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

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

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

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

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

(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

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

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

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

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

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

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

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 defines the referenced service endpoints to which the traffic will be forwarded to.

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 for HTTP requests.

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

Retry policy for HTTP requests.

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

A collection of paths that map requests to backends.

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

Number of retries for a given request.

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

Specifies the namespace of the referenced service.

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

Specifies the name of the referenced service.

Specifies the port of the referenced service.

(Members of IngressBackend are embedded into this type.)

Specifies the backend receiving the traffic split.

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

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 signifies whether this rule should ClusterLocal. If it’s not specified then it defaults to ExternalIP.

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

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

A list of host rules used to configure the Ingress.

Visibility setting.

(Members of Status are embedded into this type.)

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

PublicLoadBalancer contains the current status of the load-balancer.

PrivateLoadBalancer contains the current status of the load-balancer.

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 is the name of the secret used to terminate SSL traffic.

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

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

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

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

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

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 is set if the Ingress is only load-balanced through a Service mesh.

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

Mode describes the mode of operation of the ServerlessService.

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

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

(Members of Status are embedded into this type.)

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

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

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

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

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

(Members of Status are embedded into this type.)

(Members of ConfigurationStatusFields are embedded into this type.)

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

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

(Members of PodSpec are embedded into this type.)

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 holds the max duration the instance is allowed for responding to a request. If unspecified, a system default will be provided.

(Members of Status are embedded into this type.)

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

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

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.

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

(Members of Status are embedded into this type.)

(Members of RouteStatusFields are embedded into this type.)

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 holds the information needed for a Route to be the target of an event.

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.

(Members of ConfigurationSpec are embedded into this type.)

ServiceSpec inlines an unrestricted ConfigurationSpec.

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

(Members of Status are embedded into this type.)

(Members of ConfigurationStatusFields are embedded into this type.)

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

(Members of RouteStatusFields are embedded into this type.)

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

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

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

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