Project: Knative (Orchestration & Management / Scheduling & Orchestration)
File: serving-api.md

<p>Packages:</p> <ul> <li> <a href="#autoscaling.internal.knative.dev%2fv1alpha1">autoscaling.internal.knative.dev/v1alpha1</a> </li> <li> <a href="#serving.knative.dev%2fv1">serving.knative.dev/v1</a> </li> <li> <a href="#serving.knative.dev%2fv1alpha1">serving.knative.dev/v1alpha1</a> </li> <li> <a href="#serving.knative.dev%2fv1beta1">serving.knative.dev/v1beta1</a> </li> </ul> <h2 id="autoscaling.internal.knative.dev/v1alpha1">autoscaling.internal.knative.dev/v1alpha1</h2> <div> <p>Package v1alpha1 contains the Autoscaling v1alpha1 API types.</p> </div> Resource Types: <ul><li> <a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscaler">PodAutoscaler</a> </li></ul> <h3 id="autoscaling.internal.knative.dev/v1alpha1.PodAutoscaler">PodAutoscaler </h3> <div> <p>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: <a href="https://docs.google.com/presentation/d/19vW9HFZ6Puxt31biNZF3uLRejDmu82rxJIk1cWmxF7w/edit">https://docs.google.com/presentation/d/19vW9HFZ6Puxt31biNZF3uLRejDmu82rxJIk1cWmxF7w/edit</a></p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>apiVersion</code><br/> string</td> <td> <code> autoscaling.internal.knative.dev/v1alpha1 </code> </td> </tr> <tr> <td> <code>kind</code><br/> string </td> <td><code>PodAutoscaler</code></td> </tr> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> <em>(Optional)</em> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerSpec"> PodAutoscalerSpec </a> </em> </td> <td> <em>(Optional)</em> <p>Spec holds the desired state of the PodAutoscaler (from the client).</p> <br/> <br/> <table> <tr> <td> <code>containerConcurrency</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Defaults to <code>0</code> which means unlimited concurrency.</p> </td> </tr> <tr> <td> <code>scaleTargetRef</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectreference-v1-core"> Kubernetes core/v1.ObjectReference </a> </em> </td> <td> <p>ScaleTargetRef defines the /scale-able resource that this PodAutoscaler is responsible for quickly right-sizing.</p> </td> </tr> <tr> <td> <code>reachability</code><br/> <em> <a href="#autoscaling.internal.knative.dev/v1alpha1.ReachabilityType"> ReachabilityType </a> </em> </td> <td> <em>(Optional)</em> <p>Reachability specifies whether or not the <code>ScaleTargetRef</code> can be reached (ie. has a route). Defaults to <code>ReachabilityUnknown</code></p> </td> </tr> <tr> <td> <code>protocolType</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/networking/pkg/apis/networking#ProtocolType"> knative.dev/networking/pkg/apis/networking.ProtocolType </a> </em> </td> <td> <p>The application-layer protocol. Matches <code>ProtocolType</code> inferred from the revision spec.</p> </td> </tr> </table> </td> </tr> <tr> <td> <code>status</code><br/> <em> <a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerStatus"> PodAutoscalerStatus </a> </em> </td> <td> <em>(Optional)</em> <p>Status communicates the observed state of the PodAutoscaler (from the controller).</p> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.Metric">Metric </h3> <div> <p>Metric represents a resource to configure the metric collector with.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> <em>(Optional)</em> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#autoscaling.internal.knative.dev/v1alpha1.MetricSpec"> MetricSpec </a> </em> </td> <td> <em>(Optional)</em> <p>Spec holds the desired state of the Metric (from the client).</p> <br/> <br/> <table> <tr> <td> <code>stableWindow</code><br/> <em> <a href="https://golang.org/pkg/time/#Duration"> time.Duration </a> </em> </td> <td> <p>StableWindow is the aggregation window for metrics in a stable state.</p> </td> </tr> <tr> <td> <code>panicWindow</code><br/> <em> <a href="https://golang.org/pkg/time/#Duration"> time.Duration </a> </em> </td> <td> <p>PanicWindow is the aggregation window for metrics where quick reactions are needed.</p> </td> </tr> <tr> <td> <code>scrapeTarget</code><br/> <em> string </em> </td> <td> <p>ScrapeTarget is the K8s service that publishes the metric endpoint.</p> </td> </tr> </table> </td> </tr> <tr> <td> <code>status</code><br/> <em> <a href="#autoscaling.internal.knative.dev/v1alpha1.MetricStatus"> MetricStatus </a> </em> </td> <td> <em>(Optional)</em> <p>Status communicates the observed state of the Metric (from the controller).</p> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.MetricSpec">MetricSpec </h3> <p> (<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.Metric">Metric</a>) </p> <div> <p>MetricSpec contains all values a metric collector needs to operate.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>stableWindow</code><br/> <em> <a href="https://golang.org/pkg/time/#Duration"> time.Duration </a> </em> </td> <td> <p>StableWindow is the aggregation window for metrics in a stable state.</p> </td> </tr> <tr> <td> <code>panicWindow</code><br/> <em> <a href="https://golang.org/pkg/time/#Duration"> time.Duration </a> </em> </td> <td> <p>PanicWindow is the aggregation window for metrics where quick reactions are

</td> </tr> <tr> <td> <code>scrapeTarget</code><br/> <em> string </em> </td> <td> <p>ScrapeTarget is the K8s service that publishes the metric endpoint.</p> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.MetricStatus">MetricStatus </h3> <p> (<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.Metric">Metric</a>) </p> <div> <p>MetricStatus reflects the status of metric collection for this specific entity.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Status</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Status"> knative.dev/pkg/apis/duck/v1.Status </a> </em> </td> <td> <p> (Members of <code>Status</code> are embedded into this type.) </p> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerSpec">PodAutoscalerSpec </h3> <p> (<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscaler">PodAutoscaler</a>) </p> <div> <p>PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>containerConcurrency</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Defaults to <code>0</code> which means unlimited concurrency.</p> </td> </tr> <tr> <td> <code>scaleTargetRef</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectreference-v1-core"> Kubernetes core/v1.ObjectReference </a> </em> </td> <td> <p>ScaleTargetRef defines the /scale-able resource that this PodAutoscaler is responsible for quickly right-sizing.</p> </td> </tr> <tr> <td> <code>reachability</code><br/> <em> <a href="#autoscaling.internal.knative.dev/v1alpha1.ReachabilityType"> ReachabilityType </a> </em> </td> <td> <em>(Optional)</em> <p>Reachability specifies whether or not the <code>ScaleTargetRef</code> can be reached (ie. has a route). Defaults to <code>ReachabilityUnknown</code></p> </td> </tr> <tr> <td> <code>protocolType</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/networking/pkg/apis/networking#ProtocolType"> knative.dev/networking/pkg/apis/networking.ProtocolType </a> </em> </td> <td> <p>The application-layer protocol. Matches <code>ProtocolType</code> inferred from the revision spec.</p> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerStatus">PodAutoscalerStatus </h3> <p> (<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscaler">PodAutoscaler</a>) </p> <div> <p>PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Status</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Status"> knative.dev/pkg/apis/duck/v1.Status </a> </em> </td> <td> <p> (Members of <code>Status</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>serviceName</code><br/> <em> string </em> </td> <td> <p>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.</p> </td> </tr> <tr> <td> <code>metricsServiceName</code><br/> <em> string </em> </td> <td> <p>MetricsServiceName is the K8s Service name that provides revision metrics. The service is managed by the PA object.</p> </td> </tr> <tr> <td> <code>desiredScale</code><br/> <em> int32 </em> </td> <td> <p>DesiredScale shows the current desired number of replicas for the revision.</p> </td> </tr> <tr> <td> <code>actualScale</code><br/> <em> int32 </em> </td> <td> <p>ActualScale shows the actual number of replicas for the revision.</p> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.PodScalable">PodScalable </h3> <div> <p>PodScalable is a duck type that the resources referenced by the PodAutoscaler&rsquo;s ScaleTargetRef must implement. They must also implement the <code>/scale</code> sub-resource for use with <code>/scale</code> based implementations (e.g. HPA), but this further constrains the shape the referenced resources may take.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#autoscaling.internal.knative.dev/v1alpha1.PodScalableSpec"> PodScalableSpec </a> </em> </td> <td> <br/> <br/> <table> <tr> <td> <code>replicas</code><br/> <em> int32 </em> </td> <td> </td> </tr> <tr> <td> <code>selector</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#labelselector-v1-meta"> Kubernetes meta/v1.LabelSelector </a> </em> </td> <td> </td> </tr> <tr> <td> <code>template</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core"> Kubernetes core/v1.PodTemplateSpec </a> </em> </td> <td> </td> </tr> </table> </td> </tr> <tr> <td> <code>status</code><br/> <em> <a href="#autoscaling.internal.knative.dev/v1alpha1.PodScalableStatus"> PodScalableStatus </a> </em> </td> <td> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.PodScalableSpec">PodScalableSpec </h3> <p> (<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodScalable">PodScalable</a>) </p> <div> <p>PodScalableSpec is the specification for the desired state of a PodScalable (or at least our shared

</div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>replicas</code><br/> <em> int32 </em> </td> <td> </td> </tr> <tr> <td> <code>selector</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#labelselector-v1-meta"> Kubernetes meta/v1.LabelSelector </a> </em> </td> <td> </td> </tr> <tr> <td> <code>template</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core"> Kubernetes core/v1.PodTemplateSpec </a> </em> </td> <td> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.PodScalableStatus">PodScalableStatus </h3> <p> (<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodScalable">PodScalable</a>) </p> <div> <p>PodScalableStatus is the observed state of a PodScalable (or at least our shared portion).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>replicas</code><br/> <em> int32 </em> </td> <td> </td> </tr> </tbody> </table> <h3 id="autoscaling.internal.knative.dev/v1alpha1.ReachabilityType">ReachabilityType (<code>string</code> alias)</h3> <p> (<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerSpec">PodAutoscalerSpec</a>) </p> <div> <p>ReachabilityType is the enumeration type for the different states of reachability to the <code>ScaleTarget</code> of a <code>PodAutoscaler</code></p> </div> <table> <thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead> <tbody><tr><td><p>&#34;Reachable&#34;</p></td> <td><p>ReachabilityReachable means the <code>ScaleTarget</code> is reachable, ie. it has an active route.</p> </td> </tr><tr><td><p>&#34;&#34;</p></td> <td><p>ReachabilityUnknown means the reachability of the <code>ScaleTarget</code> is unknown. Used when the reachability cannot be determined, eg. during activation.</p> </td> </tr><tr><td><p>&#34;Unreachable&#34;</p></td> <td><p>ReachabilityUnreachable means the <code>ScaleTarget</code> is not reachable, ie. it does not have an active route.</p> </td> </tr></tbody> </table> <hr/> <h2 id="serving.knative.dev/v1">serving.knative.dev/v1</h2> <div> <p>Package v1 contains the Serving v1 API types.</p> </div> Resource Types: <ul><li> <a href="#serving.knative.dev/v1.Configuration">Configuration</a> </li><li> <a href="#serving.knative.dev/v1.Revision">Revision</a> </li><li> <a href="#serving.knative.dev/v1.Route">Route</a> </li><li> <a href="#serving.knative.dev/v1.Service">Service</a> </li></ul> <h3 id="serving.knative.dev/v1.Configuration">Configuration </h3> <div> <p>Configuration represents the &ldquo;floating HEAD&rdquo; of a linear history of Revisions. Users create new Revisions by updating the Configuration&rsquo;s spec. The &ldquo;latest created&rdquo; revision&rsquo;s name is available under status, as is the &ldquo;latest ready&rdquo; revision&rsquo;s name. See also: <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration">https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration</a></p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>apiVersion</code><br/> string</td> <td> <code> serving.knative.dev/v1 </code> </td> </tr> <tr> <td> <code>kind</code><br/> string </td> <td><code>Configuration</code></td> </tr> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> <em>(Optional)</em> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#serving.knative.dev/v1.ConfigurationSpec"> ConfigurationSpec </a> </em> </td> <td> <em>(Optional)</em> <br/> <br/> <table> <tr> <td> <code>template</code><br/> <em> <a href="#serving.knative.dev/v1.RevisionTemplateSpec"> RevisionTemplateSpec </a> </em> </td> <td> <em>(Optional)</em> <p>Template holds the latest specification for the Revision to be stamped out.</p> </td> </tr> </table> </td> </tr> <tr> <td> <code>status</code><br/> <em> <a href="#serving.knative.dev/v1.ConfigurationStatus"> ConfigurationStatus </a> </em> </td> <td> <em>(Optional)</em> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.Revision">Revision </h3> <div> <p>Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration.</p> <p>See also: <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision">https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision</a></p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>apiVersion</code><br/> string</td> <td> <code> serving.knative.dev/v1 </code> </td> </tr> <tr> <td> <code>kind</code><br/> string </td> <td><code>Revision</code></td> </tr> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> <em>(Optional)</em> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#serving.knative.dev/v1.RevisionSpec"> RevisionSpec </a> </em> </td> <td> <em>(Optional)</em> <br/> <br/> <table> <tr> <td> <code>PodSpec</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podspec-v1-core"> Kubernetes core/v1.PodSpec </a> </em> </td> <td> <p> (Members of <code>PodSpec</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>containerConcurrency</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Defaults to <code>0</code> which means concurrency to the application is not limited, and the system decides the target concurrency for the autoscaler.</p> </td> </tr> <tr> <td> <code>timeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>TimeoutSeconds is the maximum duration in seconds that the request instance is allowed to respond to a

If unspecified, a system default will be provided.</p> </td> </tr> <tr> <td> <code>responseStartTimeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>ResponseStartTimeoutSeconds is the maximum duration in seconds that the request routing layer will wait for a request delivered to a container to begin sending any network traffic.</p> </td> </tr> <tr> <td> <code>idleTimeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>IdleTimeoutSeconds is the maximum duration in seconds a request will be allowed to stay open while not receiving any bytes from the user&rsquo;s application. If unspecified, a system default will be provided.</p> </td> </tr> </table> </td> </tr> <tr> <td> <code>status</code><br/> <em> <a href="#serving.knative.dev/v1.RevisionStatus"> RevisionStatus </a> </em> </td> <td> <em>(Optional)</em> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.Route">Route </h3> <div> <p>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 &ldquo;latest ready revision&rdquo; changes, and smoothly rolling out latest revisions. See also: <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#route">https://github.com/knative/serving/blob/main/docs/spec/overview.md#route</a></p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>apiVersion</code><br/> string</td> <td> <code> serving.knative.dev/v1 </code> </td> </tr> <tr> <td> <code>kind</code><br/> string </td> <td><code>Route</code></td> </tr> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> <em>(Optional)</em> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#serving.knative.dev/v1.RouteSpec"> RouteSpec </a> </em> </td> <td> <em>(Optional)</em> <p>Spec holds the desired state of the Route (from the client).</p> <br/> <br/> <table> <tr> <td> <code>traffic</code><br/> <em> <a href="#serving.knative.dev/v1.TrafficTarget"> []TrafficTarget </a> </em> </td> <td> <em>(Optional)</em> <p>Traffic specifies how to distribute traffic over a collection of revisions and configurations.</p> </td> </tr> </table> </td> </tr> <tr> <td> <code>status</code><br/> <em> <a href="#serving.knative.dev/v1.RouteStatus"> RouteStatus </a> </em> </td> <td> <em>(Optional)</em> <p>Status communicates the observed state of the Route (from the controller).</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.Service">Service </h3> <div> <p>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.</p> <p>The Service&rsquo;s controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.</p> <p>See also: <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#service">https://github.com/knative/serving/blob/main/docs/spec/overview.md#service</a></p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>apiVersion</code><br/> string</td> <td> <code> serving.knative.dev/v1 </code> </td> </tr> <tr> <td> <code>kind</code><br/> string </td> <td><code>Service</code></td> </tr> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> <em>(Optional)</em> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#serving.knative.dev/v1.ServiceSpec"> ServiceSpec </a> </em> </td> <td> <em>(Optional)</em> <br/> <br/> <table> <tr> <td> <code>ConfigurationSpec</code><br/> <em> <a href="#serving.knative.dev/v1.ConfigurationSpec"> ConfigurationSpec </a> </em> </td> <td> <p> (Members of <code>ConfigurationSpec</code> are embedded into this type.) </p> <p>ServiceSpec inlines an unrestricted ConfigurationSpec.</p> </td> </tr> <tr> <td> <code>RouteSpec</code><br/> <em> <a href="#serving.knative.dev/v1.RouteSpec"> RouteSpec </a> </em> </td> <td> <p> (Members of <code>RouteSpec</code> are embedded into this type.) </p> <p>ServiceSpec inlines RouteSpec and restricts/defaults its fields via webhook. In particular, this spec can only reference this Service&rsquo;s configuration and revisions (which also influences

</td> </tr> </table> </td> </tr> <tr> <td> <code>status</code><br/> <em> <a href="#serving.knative.dev/v1.ServiceStatus"> ServiceStatus </a> </em> </td> <td> <em>(Optional)</em> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.ConfigurationSpec">ConfigurationSpec </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.Configuration">Configuration</a>, <a href="#serving.knative.dev/v1.ServiceSpec">ServiceSpec</a>) </p> <div> <p>ConfigurationSpec holds the desired state of the Configuration (from the client).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>template</code><br/> <em> <a href="#serving.knative.dev/v1.RevisionTemplateSpec"> RevisionTemplateSpec </a> </em> </td> <td> <em>(Optional)</em> <p>Template holds the latest specification for the Revision to be stamped out.</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.ConfigurationStatus">ConfigurationStatus </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.Configuration">Configuration</a>) </p> <div> <p>ConfigurationStatus communicates the observed state of the Configuration (from the controller).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Status</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Status"> knative.dev/pkg/apis/duck/v1.Status </a> </em> </td> <td> <p> (Members of <code>Status</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>ConfigurationStatusFields</code><br/> <em> <a href="#serving.knative.dev/v1.ConfigurationStatusFields"> ConfigurationStatusFields </a> </em> </td> <td> <p> (Members of <code>ConfigurationStatusFields</code> are embedded into this type.) </p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.ConfigurationStatusFields">ConfigurationStatusFields </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.ConfigurationStatus">ConfigurationStatus</a>, <a href="#serving.knative.dev/v1.ServiceStatus">ServiceStatus</a>) </p> <div> <p>ConfigurationStatusFields holds the fields of Configuration&rsquo;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.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>latestReadyRevisionName</code><br/> <em> string </em> </td> <td> <em>(Optional)</em> <p>LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its &ldquo;Ready&rdquo; condition become &ldquo;True&rdquo;.</p> </td> </tr> <tr> <td> <code>latestCreatedRevisionName</code><br/> <em> string </em> </td> <td> <em>(Optional)</em> <p>LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, for that use LatestReadyRevisionName.</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.ContainerStatus">ContainerStatus </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.RevisionStatus">RevisionStatus</a>) </p> <div> <p>ContainerStatus holds the information of container name and image digest value</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>name</code><br/> <em> string </em> </td> <td> </td> </tr> <tr> <td> <code>imageDigest</code><br/> <em> string </em> </td> <td> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.RevisionSpec">RevisionSpec </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.Revision">Revision</a>, <a href="#serving.knative.dev/v1.RevisionTemplateSpec">RevisionTemplateSpec</a>) </p> <div> <p>RevisionSpec holds the desired state of the Revision (from the client).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>PodSpec</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podspec-v1-core"> Kubernetes core/v1.PodSpec </a> </em> </td> <td> <p> (Members of <code>PodSpec</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>containerConcurrency</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Defaults to <code>0</code> which means concurrency to the application is not limited, and the system decides the target concurrency for the autoscaler.</p> </td> </tr> <tr> <td> <code>timeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>TimeoutSeconds is the maximum duration in seconds that the request instance is allowed to respond to a request. If unspecified, a system default will be provided.</p> </td> </tr> <tr> <td> <code>responseStartTimeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>ResponseStartTimeoutSeconds is the maximum duration in seconds that the request routing layer will wait for a request delivered to a container to begin sending any network traffic.</p> </td> </tr> <tr> <td> <code>idleTimeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>IdleTimeoutSeconds is the maximum duration in seconds a request will be allowed to stay open while not receiving any bytes from the user&rsquo;s application. If unspecified, a system default will be provided.</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.RevisionStatus">RevisionStatus </h3> <p> (<em>Appears

href="#serving.knative.dev/v1.Revision">Revision</a>) </p> <div> <p>RevisionStatus communicates the observed state of the Revision (from the controller).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Status</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Status"> knative.dev/pkg/apis/duck/v1.Status </a> </em> </td> <td> <p> (Members of <code>Status</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>logUrl</code><br/> <em> string </em> </td> <td> <em>(Optional)</em> <p>LogURL specifies the generated logging url for this particular revision based on the revision url template specified in the controller&rsquo;s config.</p> </td> </tr> <tr> <td> <code>containerStatuses</code><br/> <em> <a href="#serving.knative.dev/v1.ContainerStatus"> []ContainerStatus </a> </em> </td> <td> <em>(Optional)</em> <p>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: <a href="http://bit.ly/image-digests">http://bit.ly/image-digests</a></p> </td> </tr> <tr> <td> <code>initContainerStatuses</code><br/> <em> <a href="#serving.knative.dev/v1.ContainerStatus"> []ContainerStatus </a> </em> </td> <td> <em>(Optional)</em> <p>InitContainerStatuses is a slice of images present in .Spec.InitContainer[*].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: <a href="http://bit.ly/image-digests">http://bit.ly/image-digests</a></p> </td> </tr> <tr> <td> <code>actualReplicas</code><br/> <em> int32 </em> </td> <td> <em>(Optional)</em> <p>ActualReplicas reflects the amount of ready pods running this revision.</p> </td> </tr> <tr> <td> <code>desiredReplicas</code><br/> <em> int32 </em> </td> <td> <em>(Optional)</em> <p>DesiredReplicas reflects the desired amount of pods running this revision.</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.RevisionTemplateSpec">RevisionTemplateSpec </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.ConfigurationSpec">ConfigurationSpec</a>) </p> <div> <p>RevisionTemplateSpec describes the data a revision should have when created from a template. Based on: <a href="https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190">https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190</a></p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> <em>(Optional)</em> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#serving.knative.dev/v1.RevisionSpec"> RevisionSpec </a> </em> </td> <td> <em>(Optional)</em> <br/> <br/> <table> <tr> <td> <code>PodSpec</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podspec-v1-core"> Kubernetes core/v1.PodSpec </a> </em> </td> <td> <p> (Members of <code>PodSpec</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>containerConcurrency</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Defaults to <code>0</code> which means concurrency to the application is not limited, and the system decides the target concurrency for the autoscaler.</p> </td> </tr> <tr> <td> <code>timeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>TimeoutSeconds is the maximum duration in seconds that the request instance is allowed to respond to a request. If unspecified, a system default will be provided.</p> </td> </tr> <tr> <td> <code>responseStartTimeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>ResponseStartTimeoutSeconds is the maximum duration in seconds that the request routing layer will wait for a request delivered to a container to begin sending any network traffic.</p> </td> </tr> <tr> <td> <code>idleTimeoutSeconds</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>IdleTimeoutSeconds is the maximum duration in seconds a request will be allowed to stay open while not receiving any bytes from the user&rsquo;s application. If unspecified, a system default will be provided.</p> </td> </tr> </table> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.RouteSpec">RouteSpec </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.Route">Route</a>, <a href="#serving.knative.dev/v1.ServiceSpec">ServiceSpec</a>) </p> <div> <p>RouteSpec holds the desired state of the Route (from the client).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>traffic</code><br/> <em> <a href="#serving.knative.dev/v1.TrafficTarget"> []TrafficTarget </a> </em> </td> <td> <em>(Optional)</em> <p>Traffic specifies how to distribute traffic over a collection of revisions and configurations.</p> </td> </tr> </tbody> </table> <h3

</h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.Route">Route</a>) </p> <div> <p>RouteStatus communicates the observed state of the Route (from the controller).</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Status</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Status"> knative.dev/pkg/apis/duck/v1.Status </a> </em> </td> <td> <p> (Members of <code>Status</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>RouteStatusFields</code><br/> <em> <a href="#serving.knative.dev/v1.RouteStatusFields"> RouteStatusFields </a> </em> </td> <td> <p> (Members of <code>RouteStatusFields</code> are embedded into this type.) </p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.RouteStatusFields">RouteStatusFields </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.RouteStatus">RouteStatus</a>, <a href="#serving.knative.dev/v1.ServiceStatus">ServiceStatus</a>) </p> <div> <p>RouteStatusFields holds the fields of Route&rsquo;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.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>url</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis#URL"> knative.dev/pkg/apis.URL </a> </em> </td> <td> <em>(Optional)</em> <p>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}</p> </td> </tr> <tr> <td> <code>address</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Addressable"> knative.dev/pkg/apis/duck/v1.Addressable </a> </em> </td> <td> <em>(Optional)</em> <p>Address holds the information needed for a Route to be the target of an event.</p> </td> </tr> <tr> <td> <code>traffic</code><br/> <em> <a href="#serving.knative.dev/v1.TrafficTarget"> []TrafficTarget </a> </em> </td> <td> <em>(Optional)</em> <p>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.</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.RoutingState">RoutingState (<code>string</code> alias)</h3> <div> <p>RoutingState represents states of a revision with regards to serving a route.</p> </div> <table> <thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead> <tbody><tr><td><p>&#34;active&#34;</p></td> <td><p>RoutingStateActive is a state for a revision which is actively referenced by a Route.</p> </td> </tr><tr><td><p>&#34;pending&#34;</p></td> <td><p>RoutingStatePending is a state after a revision is created, but before its routing state has been determined. It is treated like active for the purposes of revision garbage collection.</p> </td> </tr><tr><td><p>&#34;reserve&#34;</p></td> <td><p>RoutingStateReserve is a state for a revision which is no longer referenced by a Route, and is scaled down, but may be rapidly pinned to a route to be made active again.</p> </td> </tr><tr><td><p>&#34;&#34;</p></td> <td><p>RoutingStateUnset is the empty value for routing state, this state is unexpected.</p> </td> </tr></tbody> </table> <h3 id="serving.knative.dev/v1.ServiceSpec">ServiceSpec </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.Service">Service</a>) </p> <div> <p>ServiceSpec represents the configuration for the Service object. A Service&rsquo;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 &ldquo;run latest&rdquo; spec.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>ConfigurationSpec</code><br/> <em> <a href="#serving.knative.dev/v1.ConfigurationSpec"> ConfigurationSpec </a> </em> </td> <td> <p> (Members of <code>ConfigurationSpec</code> are embedded into this type.) </p> <p>ServiceSpec inlines an unrestricted ConfigurationSpec.</p> </td> </tr> <tr> <td> <code>RouteSpec</code><br/> <em> <a href="#serving.knative.dev/v1.RouteSpec"> RouteSpec </a> </em> </td> <td> <p> (Members of <code>RouteSpec</code> are embedded into this type.) </p> <p>ServiceSpec inlines RouteSpec and restricts/defaults its fields via webhook. In particular, this spec can only reference this Service&rsquo;s configuration and revisions (which also influences defaults).</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.ServiceStatus">ServiceStatus </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.Service">Service</a>) </p> <div> <p>ServiceStatus represents the Status stanza of the Service resource.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Status</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Status">

</a> </em> </td> <td> <p> (Members of <code>Status</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>ConfigurationStatusFields</code><br/> <em> <a href="#serving.knative.dev/v1.ConfigurationStatusFields"> ConfigurationStatusFields </a> </em> </td> <td> <p> (Members of <code>ConfigurationStatusFields</code> are embedded into this type.) </p> <p>In addition to inlining ConfigurationSpec, we also inline the fields specific to ConfigurationStatus.</p> </td> </tr> <tr> <td> <code>RouteStatusFields</code><br/> <em> <a href="#serving.knative.dev/v1.RouteStatusFields"> RouteStatusFields </a> </em> </td> <td> <p> (Members of <code>RouteStatusFields</code> are embedded into this type.) </p> <p>In addition to inlining RouteSpec, we also inline the fields specific to RouteStatus.</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1.TrafficTarget">TrafficTarget </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1.RouteSpec">RouteSpec</a>, <a href="#serving.knative.dev/v1.RouteStatusFields">RouteStatusFields</a>) </p> <div> <p>TrafficTarget holds a single entry of the routing table for a Route.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>tag</code><br/> <em> string </em> </td> <td> <em>(Optional)</em> <p>Tag is optionally used to expose a dedicated url for referencing this target exclusively.</p> </td> </tr> <tr> <td> <code>revisionName</code><br/> <em> string </em> </td> <td> <em>(Optional)</em> <p>RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName.</p> </td> </tr> <tr> <td> <code>configurationName</code><br/> <em> string </em> </td> <td> <em>(Optional)</em> <p>ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the &ldquo;status.latestReadyRevisionName&rdquo; of the referenced configuration changes, we will automatically migrate traffic from the prior &ldquo;latest ready&rdquo; revision to the new one. This field is never set in Route&rsquo;s status, only its spec. This is mutually exclusive with RevisionName.</p> </td> </tr> <tr> <td> <code>latestRevision</code><br/> <em> bool </em> </td> <td> <em>(Optional)</em> <p>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.</p> </td> </tr> <tr> <td> <code>percent</code><br/> <em> int64 </em> </td> <td> <em>(Optional)</em> <p>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. <code>0</code> (zero) mean no traffic, <code>100</code> 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 <code>percent</code> is zero for that particular Revision or Configuration</p> </td> </tr> <tr> <td> <code>url</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis#URL"> knative.dev/pkg/apis.URL </a> </em> </td> <td> <em>(Optional)</em> <p>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.)</p> </td> </tr> </tbody> </table> <hr/> <h2 id="serving.knative.dev/v1alpha1">serving.knative.dev/v1alpha1</h2> <div> <p>Package v1alpha1 contains the v1alpha1 versions of the serving apis. Api versions allow the api contract for a resource to be changed while keeping backward compatibility by support multiple concurrent versions of the same resource</p> </div> Resource Types: <ul></ul> <h3 id="serving.knative.dev/v1alpha1.CannotConvertError">CannotConvertError </h3> <div> <p>CannotConvertError is returned when a field cannot be converted.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Message</code><br/> <em> string </em> </td> <td> </td> </tr> <tr> <td> <code>Field</code><br/> <em> string </em> </td> <td> </td> </tr> </tbody> </table> <hr/> <h2 id="serving.knative.dev/v1beta1">serving.knative.dev/v1beta1</h2> <div> <p>Package v1beta1 contains the v1beta1 versions of the serving apis. Api versions allow the api contract for a resource to be changed while keeping backward compatibility by support multiple concurrent versions of the same resource</p> </div> Resource Types: <ul><li> <a href="#serving.knative.dev/v1beta1.DomainMapping">DomainMapping</a> </li></ul> <h3

</h3> <div> <p>DomainMapping is a mapping from a custom hostname to an Addressable.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>apiVersion</code><br/> string</td> <td> <code> serving.knative.dev/v1beta1 </code> </td> </tr> <tr> <td> <code>kind</code><br/> string </td> <td><code>DomainMapping</code></td> </tr> <tr> <td> <code>metadata</code><br/> <em> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta"> Kubernetes meta/v1.ObjectMeta </a> </em> </td> <td> <em>(Optional)</em> <p>Standard object&rsquo;s metadata. More info: <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata">https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata</a></p> Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field. </td> </tr> <tr> <td> <code>spec</code><br/> <em> <a href="#serving.knative.dev/v1beta1.DomainMappingSpec"> DomainMappingSpec </a> </em> </td> <td> <em>(Optional)</em> <p>Spec is the desired state of the DomainMapping. More info: <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status">https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</a></p> <br/> <br/> <table> <tr> <td> <code>ref</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#KReference"> knative.dev/pkg/apis/duck/v1.KReference </a> </em> </td> <td> <p>Ref specifies the target of the Domain Mapping.</p> <p>The object identified by the Ref must be an Addressable with a URL of the form <code>{name}.{namespace}.{domain}</code> where <code>{domain}</code> is the cluster domain, and <code>{name}</code> and <code>{namespace}</code> are the name and namespace of a Kubernetes Service.</p> <p>This contract is satisfied by Knative types such as Knative Services and Knative Routes, and by Kubernetes Services.</p> </td> </tr> <tr> <td> <code>tls</code><br/> <em> <a href="#serving.knative.dev/v1beta1.SecretTLS"> SecretTLS </a> </em> </td> <td> <em>(Optional)</em> <p>TLS allows the DomainMapping to terminate TLS traffic with an existing secret.</p> </td> </tr> </table> </td> </tr> <tr> <td> <code>status</code><br/> <em> <a href="#serving.knative.dev/v1beta1.DomainMappingStatus"> DomainMappingStatus </a> </em> </td> <td> <em>(Optional)</em> <p>Status is the current state of the DomainMapping. More info: <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status">https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</a></p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1beta1.CannotConvertError">CannotConvertError </h3> <div> <p>CannotConvertError is returned when a field cannot be converted.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Message</code><br/> <em> string </em> </td> <td> </td> </tr> <tr> <td> <code>Field</code><br/> <em> string </em> </td> <td> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1beta1.DomainMappingSpec">DomainMappingSpec </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1beta1.DomainMapping">DomainMapping</a>) </p> <div> <p>DomainMappingSpec describes the DomainMapping the user wishes to exist.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>ref</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#KReference"> knative.dev/pkg/apis/duck/v1.KReference </a> </em> </td> <td> <p>Ref specifies the target of the Domain Mapping.</p> <p>The object identified by the Ref must be an Addressable with a URL of the form <code>{name}.{namespace}.{domain}</code> where <code>{domain}</code> is the cluster domain, and <code>{name}</code> and <code>{namespace}</code> are the name and namespace of a Kubernetes Service.</p> <p>This contract is satisfied by Knative types such as Knative Services and Knative Routes, and by Kubernetes Services.</p> </td> </tr> <tr> <td> <code>tls</code><br/> <em> <a href="#serving.knative.dev/v1beta1.SecretTLS"> SecretTLS </a> </em> </td> <td> <em>(Optional)</em> <p>TLS allows the DomainMapping to terminate TLS traffic with an existing secret.</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1beta1.DomainMappingStatus">DomainMappingStatus </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1beta1.DomainMapping">DomainMapping</a>) </p> <div> <p>DomainMappingStatus describes the current state of the DomainMapping.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>Status</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Status"> knative.dev/pkg/apis/duck/v1.Status </a> </em> </td> <td> <p> (Members of <code>Status</code> are embedded into this type.) </p> </td> </tr> <tr> <td> <code>url</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis#URL"> knative.dev/pkg/apis.URL </a> </em> </td> <td> <em>(Optional)</em> <p>URL is the URL of this DomainMapping.</p> </td> </tr> <tr> <td> <code>address</code><br/> <em> <a href="https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Addressable"> knative.dev/pkg/apis/duck/v1.Addressable </a> </em> </td> <td> <em>(Optional)</em> <p>Address holds the information needed for a DomainMapping to be the target of an event.</p> </td> </tr> </tbody> </table> <h3 id="serving.knative.dev/v1beta1.SecretTLS">SecretTLS </h3> <p> (<em>Appears on:</em><a href="#serving.knative.dev/v1beta1.DomainMappingSpec">DomainMappingSpec</a>) </p> <div> <p>SecretTLS wrapper for TLS SecretName.</p> </div> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> <code>secretName</code><br/> <em> string </em> </td> <td> <p>SecretName is the name of the existing secret used to terminate TLS traffic.</p> </td> </tr> </tbody> </table> <hr/> <p><em> Generated with <code>gen-crd-api-reference-docs</code> . </em></p>