feature: update the search engine documentation to describe the batch size and rename change set file.

Signed-off-by: Hasan Oezdemir <21654050+nodify-at@users.noreply.github.com>
2022-07-09 14:53:17 +02:00
parent ab338422e1
commit b0b8213056
2 changed files with 21 additions and 1 deletions
@@ -2,7 +2,7 @@
 '@backstage/plugin-search-backend-module-elasticsearch': patch
 ---

-Feature: add a new option to set the batch size for elastic search engine, if not given the default batch size is 1.000
+Feature: add a new option to set the batch size for elastic search engine, if not given the default batch size is 1000

 Example usage:

@@ -232,3 +232,23 @@ search:
    auth:
      apiKey: base64EncodedKey
 ```
+
+### Elastic search batch size
+
+Default batch size of the elastic search engine is set to 1000. If you are using a lower spec computing resources (like AWS small instance),
+you may get an error caused by limited thread_pool configuration. ( `429 Too Many Requests /_bulk` )
+
+In this case you need to decrease the batch size to index the resources to prevent this kind of error. You can easily decrease
+or increase the batch size in your `app-config.yaml` using the `batchSize` option provided for elasticsearch configuration.
+
+#### Configuration example
+
+**Set batch size to 100**
+
+```yaml
+search:
+  elasticsearch:
+    batchSize: 100
+```
+
+> You can also increase the batch size if you are using a large ES instance.