updates

Author: bparees

api/docs/apis-image.openshift.io/v1.ImageStream.adoc

@@ -89,27 +89,27 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
 
 Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids">uid</span>:
 </div></details><details open><summary><span title="(v1.ImageStreamSpec) Spec describes the desired state of this stream">spec</span>:
-</summary><div style="margin-left:13px;">  <span title="(string) dockerImageRepository is optional, if specified this stream is backed by a Docker repository on this server">dockerImageRepository</span>:
+</summary><div style="margin-left:13px;">  <span title="(string) dockerImageRepository is optional, if specified this stream is backed by a Docker repository on this server Deprecated: This field is deprecated as of v3.7 and will be removed in a future release Specify the source for the tags to be imported in each tag via the spec.tags.from reference instead.">dockerImageRepository</span>:
 </div><details><summary>  <span title="(v1.ImageLookupPolicy) lookupPolicy controls how other resources reference images within this namespace.">lookupPolicy</span>:
 </summary><div style="margin-left:13px;">    <span title="(boolean) local will change the docker short image references (like &#34;mysql&#34; or &#34;php:latest&#34;) on objects in this namespace to the image ID whenever they match this image stream, instead of reaching out to a remote registry. The name will be fully qualified to an image ID if found. The tag&#39;s referencePolicy is taken into account on the replaced value. Only works within the current namespace.">local</span>:
 </div></details><details><summary>  <span title="(array) tags map arbitrary string values to specific image locators">tags</span>:
-</summary><details><summary>  - <span title="(object) Annotations associated with images using this tag">annotations</span>:
+</summary><details><summary>  - <span title="(object) Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags.">annotations</span>:
 </summary><div style="margin-left:13px;">  -   <span title="(string)">[string]</span>:
-</div></details><details><summary>    <span title="(v1.ObjectReference) From is a reference to an image stream tag or image stream this tag should track">from</span>:
+</div></details><details><summary>    <span title="(v1.ObjectReference) Optional; if specified, a reference to another image that this tag should point to. Valid values are ImageStreamTag, ImageStreamImage, and DockerImage.">from</span>:
 </summary><div style="margin-left:13px;">      <span title="(string) API version of the referent.">apiVersion</span>:
 </div><div style="margin-left:13px;">      <span title="(string) If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: &#34;spec.containers{name}&#34; (where &#34;name&#34; refers to the name of the container that triggered the event) or if no container name is specified &#34;spec.containers[2]&#34; (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.">fieldPath</span>:
 </div><div style="margin-left:13px;">      <span title="(string) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">kind</span>:
 </div><div style="margin-left:13px;">      <span title="(string) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names">name</span>:
 </div><div style="margin-left:13px;">      <span title="(string) Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/">namespace</span>:
 </div><div style="margin-left:13px;">      <span title="(string) Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency">resourceVersion</span>:
 </div><div style="margin-left:13px;">      <span title="(string) UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids">uid</span>:
-</div></details><div style="margin-left:13px;">    <span title="(integer) Generation is the image stream generation that updated this tag - setting it to 0 is an indication that the generation must be updated. Legacy clients will send this as nil, which means the client doesn&#39;t know or care.">generation</span>:
-</div><details><summary>    <span title="(v1.TagImportPolicy) Import is information that controls how images may be imported by the server.">importPolicy</span>:
+</div></details><div style="margin-left:13px;">    <span title="(integer) Generation is a counter that tracks mutations to the spec tag (user intent). When a tag reference is changed the generation is set to match the current stream generation (which is incremented every time spec is changed). Other processes in the system like the image importer observe that the generation of spec tag is newer than the generation recorded in the status and use that as a trigger to import the newest remote tag. To trigger a new import, clients may set this value to zero which will reset the generation to the latest stream generation. Legacy clients will send this value as nil which will be merged with the current tag generation.">generation</span>:
+</div><details><summary>    <span title="(v1.TagImportPolicy) ImportPolicy is information that controls how images may be imported by the server.">importPolicy</span>:
 </summary><div style="margin-left:13px;">      <span title="(boolean) Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.">insecure</span>:
 </div><div style="margin-left:13px;">      <span title="(boolean) Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported">scheduled</span>:
 </div></details><div style="margin-left:13px;">    <span title="(string) Name of the tag">name</span>:
 </div><div style="margin-left:13px;">    <span title="(boolean) Reference states if the tag will be imported. Default value is false, which means the tag will be imported.">reference</span>:
-</div><details><summary>    <span title="(v1.TagReferencePolicy) ReferencePolicy defines how other components should consume the image">referencePolicy</span>:
+</div><details><summary>    <span title="(v1.TagReferencePolicy) ReferencePolicy defines how other components should consume the image.">referencePolicy</span>:
 </summary><div style="margin-left:13px;">      <span title="(string) Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated Docker registry and leverage the registry&#39;s ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream&#39;s namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable.">type</span>:
 </div></details></details></details><details><summary><span title="(v1.ImageStreamStatus) Status describes the current state of this stream">status</span>:
 </summary><div style="margin-left:13px;">  <span title="(string) DockerImageRepository represents the effective location this stream may be accessed at. May be empty until the server determines where the repository is located">dockerImageRepository</span>:

api/docs/apis-image.openshift.io/v1.ImageStreamImport.adoc

@@ -398,27 +398,27 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
 
 Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids">uid</span>:
 </div></details><details><summary>    <span title="(v1.ImageStreamSpec) Spec describes the desired state of this stream">spec</span>:
-</summary><div style="margin-left:13px;">      <span title="(string) dockerImageRepository is optional, if specified this stream is backed by a Docker repository on this server">dockerImageRepository</span>:
+</summary><div style="margin-left:13px;">      <span title="(string) dockerImageRepository is optional, if specified this stream is backed by a Docker repository on this server Deprecated: This field is deprecated as of v3.7 and will be removed in a future release Specify the source for the tags to be imported in each tag via the spec.tags.from reference instead.">dockerImageRepository</span>:
 </div><details><summary>      <span title="(v1.ImageLookupPolicy) lookupPolicy controls how other resources reference images within this namespace.">lookupPolicy</span>:
 </summary><div style="margin-left:13px;">        <span title="(boolean) local will change the docker short image references (like &#34;mysql&#34; or &#34;php:latest&#34;) on objects in this namespace to the image ID whenever they match this image stream, instead of reaching out to a remote registry. The name will be fully qualified to an image ID if found. The tag&#39;s referencePolicy is taken into account on the replaced value. Only works within the current namespace.">local</span>:
 </div></details><details><summary>      <span title="(array) tags map arbitrary string values to specific image locators">tags</span>:
-</summary><details><summary>      - <span title="(object) Annotations associated with images using this tag">annotations</span>:
+</summary><details><summary>      - <span title="(object) Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags.">annotations</span>:
 </summary><div style="margin-left:13px;">      -   <span title="(string)">[string]</span>:
-</div></details><details><summary>        <span title="(v1.ObjectReference) From is a reference to an image stream tag or image stream this tag should track">from</span>:
+</div></details><details><summary>        <span title="(v1.ObjectReference) Optional; if specified, a reference to another image that this tag should point to. Valid values are ImageStreamTag, ImageStreamImage, and DockerImage.">from</span>:
 </summary><div style="margin-left:13px;">          <span title="(string) API version of the referent.">apiVersion</span>:
 </div><div style="margin-left:13px;">          <span title="(string) If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: &#34;spec.containers{name}&#34; (where &#34;name&#34; refers to the name of the container that triggered the event) or if no container name is specified &#34;spec.containers[2]&#34; (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.">fieldPath</span>:
 </div><div style="margin-left:13px;">          <span title="(string) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">kind</span>:
 </div><div style="margin-left:13px;">          <span title="(string) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names">name</span>:
 </div><div style="margin-left:13px;">          <span title="(string) Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/">namespace</span>:
 </div><div style="margin-left:13px;">          <span title="(string) Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency">resourceVersion</span>:
 </div><div style="margin-left:13px;">          <span title="(string) UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids">uid</span>:
-</div></details><div style="margin-left:13px;">        <span title="(integer) Generation is the image stream generation that updated this tag - setting it to 0 is an indication that the generation must be updated. Legacy clients will send this as nil, which means the client doesn&#39;t know or care.">generation</span>:
-</div><details><summary>        <span title="(v1.TagImportPolicy) Import is information that controls how images may be imported by the server.">importPolicy</span>:
+</div></details><div style="margin-left:13px;">        <span title="(integer) Generation is a counter that tracks mutations to the spec tag (user intent). When a tag reference is changed the generation is set to match the current stream generation (which is incremented every time spec is changed). Other processes in the system like the image importer observe that the generation of spec tag is newer than the generation recorded in the status and use that as a trigger to import the newest remote tag. To trigger a new import, clients may set this value to zero which will reset the generation to the latest stream generation. Legacy clients will send this value as nil which will be merged with the current tag generation.">generation</span>:
+</div><details><summary>        <span title="(v1.TagImportPolicy) ImportPolicy is information that controls how images may be imported by the server.">importPolicy</span>:
 </summary><div style="margin-left:13px;">          <span title="(boolean) Insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.">insecure</span>:
 </div><div style="margin-left:13px;">          <span title="(boolean) Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported">scheduled</span>:
 </div></details><div style="margin-left:13px;">        <span title="(string) Name of the tag">name</span>:
 </div><div style="margin-left:13px;">        <span title="(boolean) Reference states if the tag will be imported. Default value is false, which means the tag will be imported.">reference</span>:
-</div><details><summary>        <span title="(v1.TagReferencePolicy) ReferencePolicy defines how other components should consume the image">referencePolicy</span>:
+</div><details><summary>        <span title="(v1.TagReferencePolicy) ReferencePolicy defines how other components should consume the image.">referencePolicy</span>:
 </summary><div style="margin-left:13px;">          <span title="(string) Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated Docker registry and leverage the registry&#39;s ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream&#39;s namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable.">type</span>:
 </div></details></details></details><details><summary>    <span title="(v1.ImageStreamStatus) Status describes the current state of this stream">status</span>:
 </summary><div style="margin-left:13px;">      <span title="(string) DockerImageRepository represents the effective location this stream may be accessed at. May be empty until the server determines where the repository is located">dockerImageRepository</span>: