Add known issue docs for elastic#101182

DaveCTurner · Oct 21, 2023 · a16342e · a16342e
1 parent 9794c6e
commit a16342e
Show file tree

Hide file tree

Showing 11 changed files with 58 additions and 0 deletions.
diff --git a/docs/reference/release-notes/8.10.0.asciidoc b/docs/reference/release-notes/8.10.0.asciidoc
@@ -35,6 +35,8 @@ delete all the snapshots in the repository taken with version 8.10.0 or later
 using a cluster running version 8.10.4.
 // end::repositorydata-format-change[]
 
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
 [[breaking-8.10.0]]
 [float]
 === Breaking changes

diff --git a/docs/reference/release-notes/8.10.1.asciidoc b/docs/reference/release-notes/8.10.1.asciidoc
@@ -9,6 +9,8 @@ Also see <<breaking-changes-8.10,Breaking changes in 8.10>>.
 
 include::8.10.0.asciidoc[tag=repositorydata-format-change]
 
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
 [[bug-8.10.1]]
 [float]
 === Bug fixes

diff --git a/docs/reference/release-notes/8.10.2.asciidoc b/docs/reference/release-notes/8.10.2.asciidoc
@@ -7,4 +7,6 @@
 
 include::8.10.0.asciidoc[tag=repositorydata-format-change]
 
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
 Also see <<breaking-changes-8.10,Breaking changes in 8.10>>.
diff --git a/docs/reference/release-notes/8.10.3.asciidoc b/docs/reference/release-notes/8.10.3.asciidoc
@@ -7,6 +7,8 @@
 
 include::8.10.0.asciidoc[tag=repositorydata-format-change]
 
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
 Also see <<breaking-changes-8.10,Breaking changes in 8.10>>.
 
 [[bug-8.10.3]]

diff --git a/docs/reference/release-notes/8.10.4.asciidoc b/docs/reference/release-notes/8.10.4.asciidoc
@@ -27,6 +27,8 @@ running version 8.10.4.
 
 Also see <<breaking-changes-8.10,Breaking changes in 8.10>>.
 
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
 [[bug-8.10.4]]
 [float]
 === Bug fixes

diff --git a/docs/reference/release-notes/8.8.0.asciidoc b/docs/reference/release-notes/8.8.0.asciidoc
@@ -3,6 +3,26 @@
 
 Also see <<breaking-changes-8.8,Breaking changes in 8.8>>.
 
+[[known-issues-8.8.0]]
+[float]
+=== Known issues
+
+// tag::repo-analysis-missing-timeout[]
+* Missing timeout in repository analysis API
++
+Version 8.8.0 introduced to the <<repo-analysis-api>> API some additional
+checks for repository behaviour, but did not adapt the API's timeout mechanism
+for the new checks since it was expected that they would complete very quickly
+whether successful or not. However we have since encountered some repository
+implementations which behave incorrectly in a surprising manner that may cause
+these new checks to loop endlessly instead of failing, ignoring the timeout.
++
+To work around this issue, implement a client-side timeout when requesting a
+repository analysis, and treat a client-side timeout as indicative of a
+repository incompatibility which you should work with your storage supplier to
+address. See {es-issue}101182[#101182] for more information.
+// end::repo-analysis-missing-timeout[]
+
 [[bug-8.8.0]]
 [float]
 === Bug fixes

diff --git a/docs/reference/release-notes/8.8.1.asciidoc b/docs/reference/release-notes/8.8.1.asciidoc
@@ -3,6 +3,12 @@
 
 Also see <<breaking-changes-8.8,Breaking changes in 8.8>>.
 
+[[known-issues-8.8.1]]
+[float]
+=== Known issues
+
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
 [[bug-8.8.1]]
 [float]
 === Bug fixes

diff --git a/docs/reference/release-notes/8.8.2.asciidoc b/docs/reference/release-notes/8.8.2.asciidoc
@@ -3,6 +3,13 @@
 
 Also see <<breaking-changes-8.8,Breaking changes in 8.8>>.
 
+[[known-issues-8.8.2]]
+[float]
+=== Known issues
+
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
+
 [[bug-8.8.2]]
 [float]
 === Bug fixes

diff --git a/docs/reference/release-notes/8.9.0.asciidoc b/docs/reference/release-notes/8.9.0.asciidoc
@@ -12,6 +12,8 @@ task is longer than the model's max_sequence_length and truncate is set to none
 then inference fails with the message `question answering result has
 invalid dimension`. (issue: {es-issue}97917[#97917])
 
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
 [[breaking-8.9.0]]
 [float]
 === Breaking changes

diff --git a/docs/reference/release-notes/8.9.1.asciidoc b/docs/reference/release-notes/8.9.1.asciidoc
@@ -3,6 +3,13 @@
 
 Also see <<breaking-changes-8.9,Breaking changes in 8.9>>.
 
+[[known-issues-8.9.1]]
+[float]
+=== Known issues
+
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
+
 [[bug-8.9.1]]
 [float]
 === Bug fixes

diff --git a/docs/reference/release-notes/8.9.2.asciidoc b/docs/reference/release-notes/8.9.2.asciidoc
@@ -22,6 +22,12 @@ For more information, see our related
 https://discuss.elastic.co/t/elasticsearch-8-9-2-and-7-17-13-security-update/342479[security
 announcement].
 
+[[known-issues-8.9.2]]
+[float]
+=== Known issues
+
+include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]
+
 [[bug-8.9.2]]
 [float]
 === Bug fixes
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,4 +7,6 @@

		include::8.10.0.asciidoc[tag=repositorydata-format-change]

		include::8.8.0.asciidoc[tag=repo-analysis-missing-timeout]

		Also see <<breaking-changes-8.10,Breaking changes in 8.10>>.