mirror of https://github.com/knative/docs.git
124 lines
7.8 KiB
Diff
124 lines
7.8 KiB
Diff
diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md
|
|
index 91f96fb9..3534d450 100644
|
|
--- a/docs/reference/api/serving.md
|
|
+++ b/docs/reference/api/serving.md
|
|
@@ -23,8 +23,10 @@ Resource Types:
|
|
<p>
|
|
<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/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit">https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit</a></p>
|
|
+by multiple definitions.
|
|
+
|
|
+For more information on Knative Autoscalers and Pluggability,
|
|
+<a href="https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit">see the Knative Pluggability presentation.</a></p>
|
|
</p>
|
|
<table>
|
|
<thead>
|
|
@@ -707,14 +709,18 @@ Resource Types:
|
|
</li><li>
|
|
<a href="#serving.knative.dev/v1.Service">Service</a>
|
|
</li></ul>
|
|
+<p>For an overview of the different Resource Types in Knative Serving and how they interact with one another, see <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration">this explanation of Resource Types</a></p>
|
|
+
|
|
<h3 id="serving.knative.dev/v1.Configuration">Configuration
|
|
</h3>
|
|
+
|
|
<p>
|
|
<p>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: <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>
|
|
+
|
|
+For more information on how Configuration interacts with other Resource Types, see the "Configuration" sub-heading <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration">in the Resource Types Overview.</a></p>
|
|
</p>
|
|
<table>
|
|
<thead>
|
|
@@ -808,7 +814,8 @@ ConfigurationStatus
|
|
<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>
|
|
+
|
|
+<p>For more information on how Revision interacts with other Resource Types, see the "Revision" sub-heading <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision">in the Resource Types Overview.</a></p>
|
|
</p>
|
|
<table>
|
|
<thead>
|
|
@@ -934,7 +941,8 @@ 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: <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>
|
|
+
|
|
+For more information on how Route interacts with other Resource Types, see the "Route" sub-heading <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#route">in the Resource Types Overview.</a></p>
|
|
</p>
|
|
<table>
|
|
<thead>
|
|
@@ -1037,7 +1045,8 @@ underlying Routes and Configurations (much as a kubernetes Deployment
|
|
orchestrates ReplicaSets), and its usage is optional but recommended.</p>
|
|
<p>The Service’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>
|
|
+
|
|
+<p>For more information on how Service interacts with other Resource Types, see the "Service" sub-heading <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#service">in the Resource Types Overview.</a></p>
|
|
</p>
|
|
<table>
|
|
<thead>
|
|
@@ -1452,7 +1461,7 @@ If multiple containers specified then DeprecatedImageDigest holds the digest
|
|
for serving container.
|
|
DEPRECATED: Use ContainerStatuses instead.
|
|
TODO(savitaashture) Remove deprecatedImageDigest.
|
|
-ref <a href="https://kubernetes.io/docs/reference/using-api/deprecation-policy">https://kubernetes.io/docs/reference/using-api/deprecation-policy</a> for deprecation.</p>
|
|
+(see <a href="https://kubernetes.io/docs/reference/using-api/deprecation-policy">Kubernetes Deprecation Policy</a>) for deprecation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
@@ -1471,7 +1480,7 @@ 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>
|
|
+See the <a href="http://bit.ly/image-digests">Proposal for multiple containers in a revision</a> for some context on this field.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
@@ -1484,7 +1493,7 @@ ref: <a href="http://bit.ly/image-digests">http://bit.ly/image-digests</a></p>
|
|
</p>
|
|
<p>
|
|
<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>
|
|
+Based on <a href="https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190">the PodTemplateSpec in Kubernetes</a></p>
|
|
</p>
|
|
<table>
|
|
<thead>
|
|
@@ -2038,9 +2047,7 @@ Kubernetes meta/v1.ObjectMeta
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Standard object’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.
|
|
+Refer to the <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata">Kubernetes API documentation</a> for the fields of the <code>metadata</code> field.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
@@ -2055,7 +2062,7 @@ DomainMappingSpec
|
|
<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>
|
|
+Refer to the <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status">Kubernetes API documentation</a> for more info on the <code>DomainMappingSpec</code> field.
|
|
<br/>
|
|
<br/>
|
|
<table>
|
|
@@ -2086,7 +2093,7 @@ DomainMappingStatus
|
|
<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>
|
|
+Refer to the <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status">Kubernetes API documentation</a> for more info on the <code>DomainMappingStatus</code> field.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|