Commit Graph

22 Commits

Author SHA1 Message Date
kolchfa-aws eacc70b361
Add closed details block to formatting guide (#6421)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2024-02-16 12:32:44 -05:00
Evan Tepsic 7716ca4de8
Added 1x sentence to clarify use/support for IAM Instance Profiles. (#6349)
* Added 1x sentence to clarify use/support for IAM Instance Profiles.

Signed-off-by: etgraylog <evan.tepsic@graylog.com>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Evan Tepsic <84512952+etgraylog@users.noreply.github.com>

---------

Signed-off-by: etgraylog <evan.tepsic@graylog.com>
Signed-off-by: Evan Tepsic <84512952+etgraylog@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2024-02-14 13:10:36 -06:00
Anas Alkouz f4b623b843
Add an example for restoring a searchable snapshot (#6002)
* Add an example for restoring a searchable snapshot 

Signed-off-by: Anas Alkouz <aalkouz@amazon.com>

* Update the restore snapshot example with indices setting and add a reference to the snapshot restore api

Signed-off-by: Anas Alkouz <aalkouz@amazon.com>

* Tiny changes to description wording

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Anas Alkouz <aalkouz@amazon.com>

---------

Signed-off-by: Anas Alkouz <aalkouz@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-12-28 17:45:31 -06:00
kolchfa-aws 88d06e13bd
Add full-text query documentation (#5428)
* Refactor full-text query documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add examples and parameter descriptions

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add multi-match query

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add query string field format

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Query string examples

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add regular expressions and fuzziness

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add wildcard and regex warning

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added more query string format

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added multi-field sections

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Rewrite minimum should match section

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added allow expensive queries section

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add simple query string query

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Small rewrites

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add intervals query

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Include discover in query string syntax

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Link and index page fix

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
2023-11-01 09:29:13 -04:00
Sander van de Geijn 17977e41d1
Update snapshot-restore.md (#4655)
Setting seems deprecated. With it present clusters fails to start with message it does not recognise this setting.

Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2023-10-17 13:32:40 -04:00
Sander van de Geijn 7da94d2957
Update snapshot-restore.md (#4656)
* Update snapshot-restore.md

Lessons learned from connecting it to a Scality

Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2023-10-17 11:22:41 -04:00
Carlos Neto a1ac25a29d
* [DOC] Added 'Search' nodes description in 'Creating a cluster' page (#4597)
* [DOC] fix the tabulation of searchable snapshots snippet example

Signed-off-by: Carlos Neto <carlos.neto.dev@gmail.com>
2023-07-28 13:15:26 -04:00
kolchfa-aws afbfa85da1
Add index codec documentation (#4589)
* Add index codec documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Rewording and doc review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-21 16:10:18 -04:00
Heather Halter 3e1e8ce55d
Adds info about new codecs (#4571)
* addedinfoaboutcodecs

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* added collapsible toc

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update snapshot-restore.md

Removed information about codecs in favor of a separate PR

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-20 09:04:24 -07:00
adaisley 6bf867a200
Update searchable snapshot documentation to be more correct (#4203)
* Update searchable_snapshot.md

This is more in-line with what is defined in the example Opensearch docker-compose
I tried the current approach and it straight-up did not work in it's current form.

Signed-off-by: adaisley <90253063+adaisley@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: adaisley <90253063+adaisley@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-06-14 14:54:35 -05:00
Heather Halter 4702a49ea4
fixsnapshottopics (#4332)
Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-06-13 15:22:11 -07:00
Heather Halter 655164171d
fixsnapshot (#4330)
Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-06-13 14:45:17 -07:00
kolchfa-aws 8463c8f278
Correct plugin capitalization (#3838)
* Correct plugin capitalization

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Revert cluster-stats because the name is in response

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Revert cluster-stats once more

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-04 11:11:54 -04:00
Kunal Kotwani 6e56933795
Remove a known limitation from searchable snapshot (#3942)
Signed-off-by: Kunal Kotwani <kkotwani@amazon.com>
2023-05-02 17:56:50 -04:00
Naarcha-AWS 1864c188f0
Add additonal Snapshot Restore (#3783) 2023-04-14 14:29:16 -05:00
Aria Marble 25edf6653d
Add documentation for Searchable Snapshots GA release (#3462)
* Add documentation for Searchable Snapshots GA release

Signed-off-by: ariamarble <armarble@amazon.com>

* SS updates

Signed-off-by: ariamarble <armarble@amazon.com>

* content update

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from doc review

Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/searchable_snapshot.md

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <nbower@amazon.com>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/searchable_snapshot.md

---------

Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-04-11 08:26:35 -07:00
Naarcha-AWS e119a93798
Index and OpenSearch TOC changes (#2946)
* Add new Query DSL section

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Change config settings

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix links

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add Query DSL back to Search

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix remaining links

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Last reorder

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add Heather's feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add Query DSL section. Delete Index Data page

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix index title

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add correct title to managing indexes

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Change config yml

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add permalinks for each page in query DSL section

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* :wq

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-03-08 09:53:21 -06:00
Aria Marble 9414701fda
Update the create snapshot repository documentation (#3116)
* Update create snapshot repository documentation

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from doc review review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* made additional review changes

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <nbower@amazon.com>

---------

Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-03-01 14:52:22 -08:00
Andriy Redko 0106a22fc8
Update the documentation to describe using symlinks for sharing web identity token file for 'repository-s3' plugin (#3021)
* Update the documentation to describe using symlinks for sharing web identity token file for 'repository-s3' plugin

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

* Address review comments

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

---------

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
2023-02-21 18:36:37 -05:00
Aria Marble d20c614f11
Index management TOC and naming change (#3020)
* Index management TOC and naming change

Signed-off-by: ariamarble <armarble@amazon.com>

* fixing title in headers

Signed-off-by: ariamarble <armarble@amazon.com>

* made suggested changes

Signed-off-by: ariamarble <armarble@amazon.com>

* snapshot title change

Signed-off-by: ariamarble <armarble@amazon.com>

---------

Signed-off-by: ariamarble <armarble@amazon.com>
2023-02-21 14:33:10 -08:00
kolchfa-aws 5abc22147c
Refactor the Query DSL section (#2904)
* for query dsl index page rewrites for proper index page

Signed-off-by: alicejw <alicejw@amazon.com>

* fix formatting in table

Signed-off-by: alicejw <alicejw@amazon.com>

* update query table intro

Signed-off-by: alicejw <alicejw@amazon.com>

* rmv proprietary from overview

Signed-off-by: alicejw <alicejw@amazon.com>

* awkward sentence fix

Signed-off-by: alicejw <alicejw@amazon.com>

* to add list of all query categories

Signed-off-by: alicejw <alicejw@amazon.com>

* for query category descriptions

Signed-off-by: alicejw <alicejw@amazon.com>

* remove commented note

Signed-off-by: alicejw <alicejw@amazon.com>

* update term-level query page

Signed-off-by: alicejw <alicejw@amazon.com>

* for clarity about term and full-text query use cases

Signed-off-by: alicejw <alicejw@amazon.com>

* for parallel bullet list of queries

Signed-off-by: alicejw <alicejw@amazon.com>

* remove redundant word

Signed-off-by: alicejw <alicejw@amazon.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/term.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/term.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* for tech review feedback

Signed-off-by: alicejw <alicejw@amazon.com>

* for entire list of query types we support, even though we don't have document topic pages for them yet.

Signed-off-by: alicejw <alicejw@amazon.com>

* to include full list of query types we support

Signed-off-by: alicejw <alicejw@amazon.com>

* change Boolean to  type for consistency in the section

Signed-off-by: alicejw <alicejw@amazon.com>

* update query type category list title

Signed-off-by: alicejw <alicejw@amazon.com>

* for compound query type definitions

Signed-off-by: alicejw <alicejw@amazon.com>

* for additional descriptions

Signed-off-by: alicejw <alicejw@amazon.com>

* for query context descriptions

Signed-off-by: alicejw <alicejw@amazon.com>

* for additional edits to query descriptions list

Signed-off-by: alicejw <alicejw@amazon.com>

* create span query category page and update bullet list on index to cross-reference to it.

Signed-off-by: alicejw <alicejw@amazon.com>

* add pages for geo and shape query category, and add cross-references

Signed-off-by: alicejw <alicejw@amazon.com>

* remove regex it is part of term-level queries

Signed-off-by: alicejw <alicejw@amazon.com>

* for bullet list granular edits

Signed-off-by: alicejw <alicejw@amazon.com>

* put bullet list in alphabetical order

Signed-off-by: alicejw <alicejw@amazon.com>

* for doc review updates

Signed-off-by: alicejw <alicejw@amazon.com>

* reword for reviewer feedback

Signed-off-by: alicejw <alicejw@amazon.com>

* small rewording

Signed-off-by: alicejw <alicejw@amazon.com>

* typo space

Signed-off-by: alicejw <alicejw@amazon.com>

* put topics in alphabetical order in left nav

Signed-off-by: alicejw <alicejw@amazon.com>

* additional reviewer's comment

Signed-off-by: alicejw <alicejw@amazon.com>

* for second doc reviewer's feedback updates

Signed-off-by: alicejw <alicejw@amazon.com>

* for doc reviewer comment that was hidden

Signed-off-by: alicejw <alicejw@amazon.com>

* Update _opensearch/query-dsl/geo-and-shape.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/span-query.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/span-query.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _opensearch/query-dsl/term.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* updates from third doc review for tech accuracy requested by editorial

Signed-off-by: alicejw <alicejw@amazon.com>

* create compound query sub-page to move descriptions to make bullet list parallel

Signed-off-by: alicejw <alicejw@amazon.com>

* fix compound query page title

Signed-off-by: alicejw <alicejw@amazon.com>

* add fuzzy query definition

Signed-off-by: alicejw <alicejw@amazon.com>

* for editorial feedback updates

Signed-off-by: alicejw <alicejw@amazon.com>

* Update _opensearch/query-dsl/term.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Refactor Query DSL section

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds doc review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix typo

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Changed periods to colons when introducing code blocks

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: alicejw <alicejw@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: alicejw <alicejw@amazon.com>
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
2023-02-15 17:12:50 -05:00
Naarcha-AWS 45834d6f78
Once more... Managing, Monitoring, Tuning. (#2653)
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-02-06 11:48:25 -06:00