Commit Graph

449 Commits

Author SHA1 Message Date
David Venable a1add5db6c
Data Prepper 2.0 documentation (#1510)
* Change Data Prepper intro

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

* Add next steps section

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

* Add David's feedback

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

* Fix optional tags

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

* Address small typo

* [Data Prepper 2.0]MAINT: documentation change regarding record type (#1306)

* MAINT: documentation change regarding record type

Signed-off-by: Chen <qchea@amazon.com>

* MAINT: documentation on trace group fields

Signed-off-by: Chen <qchea@amazon.com>

Signed-off-by: Chen <qchea@amazon.com>

* Update docs for Data Prepper 2.0 (#1404)

* Update get-started

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Update pipelines.md

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Add peer forwarder options to references

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Add csv processor options to refereces

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Add docs for conditional routing

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Add docs for json processor

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Remove docs for peer forwarder plugin

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Address review feedback - revise sentences, fix inaccurate info and typos

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Add missing options for http source and peer forwarder

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Update ssl options on peer forwarder

Signed-off-by: Hai Yan <oeyh@amazon.com>

Signed-off-by: Hai Yan <oeyh@amazon.com>

* More updates for Data Prepper 2.0 (#1469)

* Update http source and opensearch sink options

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Update docker run command

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Add more missing options

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Add metadata_root_key for s3 source

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Address review comments - tweak sentences and fix typos

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Address review comments

Signed-off-by: Hai Yan <oeyh@amazon.com>

Signed-off-by: Hai Yan <oeyh@amazon.com>

* Fix broken link

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Chen <qchea@amazon.com>
Signed-off-by: Hai Yan <oeyh@amazon.com>
Co-authored-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Qi Chen <qchea@amazon.com>
Co-authored-by: Hai Yan <8153134+oeyh@users.noreply.github.com>
2022-10-11 11:36:37 -05:00
Jeff Huss 6583bfeeff
Fixes broken links in docs page main branch (#1501)
* Fixed broken link in RPM guide

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* All done

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-10-10 09:11:08 -07:00
kolchfa-aws 85b18f7c58
Adds nodes stats API (#1369)
* Adds nodes stats API

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

* Refactored hot threads and info APIs

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

* Incorporated doc review comments

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

* Incorporated review feedback

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

* Formatting changes

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update nodes-hot-threads.md

* Update nodes-hot-threads.md

* Update nodes-hot-threads.md

* Update nodes-info.md

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update nodes-info.md

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update nodes-stats.md

* Incorporated nodes stats editorial comments

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
2022-10-08 18:02:27 -04:00
Hailong-am 1e274173d0
Fix cat/templates doc (#1356)
* Update cat-templates.md

* Update cat-templates.md

* Update _opensearch/rest-api/cat/cat-templates.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2022-10-06 11:50:04 -05:00
Jeff Huss 71924da48c
Fixed liquid syntax which fixes the yum repo command paths (#1413)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-10-04 11:28:20 -07:00
Aria Marble 3720f1902c
Adding documentation for dangling index api (#1370)
* adding documentation for dangling index api

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

* made editorial changes

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-04 09:25:12 -07:00
Aria Marble 7d41fc58c4
Add documentation for reload_searchIanalyzer api (#1339)
* updated incorrect links

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

* add documentation for reload search analyzer api

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

* made suggested changes

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

* made additional formatting changes

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

* made editorial changes

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-03 12:24:36 -07:00
Aria Marble 05f466d2af
Update of source parameter in documentation (#1368)
* update of source parameter in documentation

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

* made suggested changes

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-03 11:49:30 -07:00
Aria Marble c54e6c8ebb
Add rank eval documentation (#1316)
* updated incorrect links

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

* adding documentation for rank eval api

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

* made suggusted changes

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

* quick syntaxt changes

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

* editorial updates

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-03 10:05:54 -07:00
Jeff Huss c2fa272305
RPM/Yum Installation Enhancements (#1020)
* Dropped the new tarball guide in here to work off of

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added comment tags to make it even more clear what isn't permanent

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Incorporating editorial feedback from tar guide and updated the template here

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Overview section added

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working on download and install steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added liquid syntax for major version in yum repo and removed references to dashboards

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finished Install OpenSearch from a package

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added Yum steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Removed redundant steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Removed PA plugin references

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added important settings and removed a couple missed dashboards references

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Starting work on testing opensearch

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Revisions to testing opensearch because security is enabled by default

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Wording change

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added a missing step

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Wording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding testing steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Removed extra section since security is always enabled out of the box

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added configuration steps and verified functionality

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working through the TLS certs portion and adding content as I vet it

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finalized steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Final draft before review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Revisions from doc review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Committing editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-10-03 09:18:29 -07:00
Aria Marble 9d7592f400
Add wait_for_completion to API documentation (#1328)
* updated incorrect links

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

* update with wait for completion

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

* made suggested change

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

* made additional changes

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-09-27 17:09:07 -07:00
Chris Moore 1b69f700f8
Provide users with warning about special characters in query DSL and API query fields (#1255)
* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1196_Spesh-Chars

Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>
2022-09-27 13:29:19 -07:00
Jeff Huss 1867336096
Added step to restart OS after applying security changes (#1315)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-09-27 08:46:09 -07:00
Mark Cohen faeb90bb05
updated doc to include configuration instructions for CORS headers (#1301)
Signed-off-by: Mark Cohen <markcoh@amazon.com>

Signed-off-by: Mark Cohen <markcoh@amazon.com>
2022-09-27 08:08:08 -05:00
Naarcha-AWS c69f860bfe
Add PPL and SQL section (#1111)
* Merge pull request #1 from Yury-Fridlyand/dev-update-sql-relevance-docs

Update SQL plugin relevance functions documentation.

Co-authored-by: MaxKsyunz <maxk@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>

* Address PR feedback.

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>

* Address PR feedback by @joshuali925.

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>

* Remove PPL page from Observability Plugin. Add link to Observability page. Make some simple formatting changes

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

* Reword paragraph

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

* Adds SQL and PPL API and other SQL plugin changes

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

* Formatting changes

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

* Incorporates editorial comments

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

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Yury Fridlyand <yuryf@bitquilltech.com>
Co-authored-by: MaxKsyunz <maxk@bitquilltech.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
2022-09-26 12:28:00 -04:00
Alice Williams 0a0968ac94
[Doc] add terms for site search to return pages correctly for bool and range queries (#1229)
* for rewrites to range queries

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

* for seeding terms to pull up range and bool query pages in site searches

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

* minor wording fix

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

* reword compound query description

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

* for range query rewrites

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

* for doc review comments

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

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-21 11:37:13 -07:00
Ralph Ursprung 45ef911be1
add backlink from config to cluster settings API (#1261)
this way the detailed documentation of the API can be found more easily
when browsing the general configuration documentation.

Co-authored-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Ralph Ursprung <Ralph.Ursprung@avaloq.com>

Signed-off-by: Ralph Ursprung <Ralph.Ursprung@avaloq.com>
Co-authored-by: Naarcha-AWS <naarcha@amazon.com>
2022-09-21 11:18:39 -07:00
Sachin Kale 57417bb1fb
Change remote store documentation to reflect all the config options (#1245)
* Change remote store documentation to reflect all the config options

Signed-off-by: Sachin Kale <kalsac@amazon.com>

* Address review comments

Signed-off-by: Sachin Kale <kalsac@amazon.com>

* Address review comments

Signed-off-by: Sachin Kale <kalsac@amazon.com>

Signed-off-by: Sachin Kale <kalsac@amazon.com>
Co-authored-by: Sachin Kale <kalsac@amazon.com>
2022-09-20 07:38:11 -07:00
Alice Williams 282a26ebfe
[Bug] Fix broken cross-ref links in the docs (#1253)
* to fix broken cross-ref links

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

* replace removed link

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

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-16 17:07:38 -07:00
Aria Marble 89fb4746bf
Issue1238 - Update segment replication feedback link (#1239)
* updated incorrect links

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

* quick link update for segrep page

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-09-15 09:21:54 -07:00
Alice Williams 63e1a65f29
Clear cache API - additional edits (#1214)
* to check in the cache API for Steve

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

* for editorial review feedback modifications

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

* doc review update

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

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-14 16:39:00 -07:00
xluo-aws 9855ff0a8f
Remove _mappings from create mapping url (#1176)
_mappings and mappings should not be specified at the same time when sending out create mapping request
If index doesn't exist, the url should not include _mappings as part of it's path, otherwise it will throw index not exist error
If index already exists, the mappings object should not be included in the body, other wise it will throw mapping parse error exception

Signed-off-by: xluo-aws <lxuesong@amazon.com>

Signed-off-by: xluo-aws <lxuesong@amazon.com>
2022-09-14 15:51:03 -05:00
Yury-Fridlyand 3338fbaaa0
Update docker compose (#1194)
* Update `docker-compose.yml`.

Signed-off-by: Yury-Fridlyand <yuryf@bitquilltech.com>

* Type fix.

Signed-off-by: Yury-Fridlyand <yuryf@bitquilltech.com>

Signed-off-by: Yury-Fridlyand <yuryf@bitquilltech.com>
2022-09-14 15:43:37 -05:00
Naarcha-AWS a2e5f867bc
Fix home page and experimental feature warnings (#1206)
* Fix typos

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

* Fix Dashboards link, place segment replication warnings under title, change remote from note to warning

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

* Push index changes

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

* Fix merge conflicts

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-09-14 14:03:41 -05:00
Naarcha-AWS ef53eda3aa
Add home page and experimental features section (#1146)
* Add experimental features section for 2.3

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

* Fix typo

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

* Add image thumbnails.

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

* Fix table.

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

* Remove playground section.

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

* Move up experimental features

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

* Make experimental features it's own page

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

* Fix nav order

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

* Ensure segment replication section appears in TOC. Link in experimental features files

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

* Fix typo in breaking changes page

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

* Add Drag and Drop wizard

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

* Add drag and drop wizard changes

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

* Remove experimental-features page

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

* Add link for remote storage

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-09-14 12:27:15 -05:00
Jeff Huss 2426148221
Makes changes from review of PR #1179 (#1200)
* Pulling in changes from the doc review that were requested after approval

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Found a lost comma and returned it to its owner

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-09-14 10:09:38 -07:00
Jeff Huss f805a28bf7
Adds documentation page for remote-backed storage (#1179)
* Created page based on structure of PR 1163

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added prerequisite steps for enabling the feature and its dependency

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding more

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding more content

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finishing up and ready for tech review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Moved page per dev request

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed header and changed heading sizes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Ready for tech review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added link to segment replication

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-09-14 09:11:14 -07:00
Aria Marble e2b82dd75e
Publish segment replication experimental feature documentation (#1163)
* segment replication documentation

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

* changes from tech review

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

* renamed file type, fixed various wording and formatting

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

* made suggested edits

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

* edit corrections

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-09-13 10:59:40 -07:00
Alice Williams 1f54720013
to check in the cache API for Steve (#1168)
Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-13 09:38:23 -07:00
Chris Moore 9317d540f8
docker-compose-file-setting_name (#1151)
Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>
2022-09-09 16:44:07 -07:00
Aria Marble cc5406743e
Issue1157 - correcting links on scripts-api index page (#1158)
* updated incorrect links

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

* quick correction of page links

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-09-09 11:24:54 -07:00
Alice Williams e84f9f5c0f
update yaml file note for new downloads (#1043)
Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-08 08:59:31 -07:00
Jeff Huss 78ebef5e5c
Added related links and changed title of page in ToC (#1092)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-09-08 08:32:11 -07:00
Jeff Huss aec7de7d97
Updated API endpoint for testing (#1105)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-09-06 09:12:24 -07:00
Aria Marble 21386b05d0
script api documentation (#1094)
* Add script documentation.

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* Use my own example script insteady of Elastic's.

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* edditing and format changes. verified API requests and scripts. various corrections

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

* made a couple of suggested changes

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

* made further corrections

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

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: Steve Murphy <stevemurphy@BCSR-11413.local>
2022-09-02 15:09:13 -07:00
Jeff Huss dfa4776ee5
Adds disclaimer about Maven coords URL formation and details about local zip files (#1054)
* Added guidance about zip syntax differences between local and remote files

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added disclaimer about Maven

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added disclaimer about protocols

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Caught a small typo and fixed it

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-09-01 10:06:51 -07:00
Jeff Huss ece0d81b89
Minor change to tar install replaces user names with usernames per editor (#1070)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-09-01 09:35:35 -07:00
Chris Moore c3f2b7bdf1
CCS-permissions (#1053)
Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>
2022-09-01 08:48:42 -07:00
Jeff Huss a890c4e0a3
Reformats plugins page, adds more explanations, and adds Maven coordinates help (#1041)
* Added Maven coordinates syntax and sample command

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changes to the overall layout

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Removed the extra table of contents - users don't need 3 on the same page

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Minor changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finished clean up

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Found a missing word and fixed it

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-08-31 10:44:16 -07:00
Jeff Huss f65dce5a68
Tarball installation guide refactor (#881)
* New PR because the old one was corrupted by a commit without DCO

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed syntax for bullet/numbered lists.

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added validation steps to the end

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Cleaning up phrasing and grammar

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Making some changes based on peer feedback

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixing opening section

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixing phrasing and rewording headers

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Cleaning up more

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Moved unrelated content to the appropriate pages and deleted from this guide

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added templates for links

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added a few related links that make sense as logical next steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Cleaned up link formatting. Ready for review now.

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Applied changes recommended by vagimeli

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Applied changed from PR review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added step numbers to headers and periods to bullet list at the top

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fix typo in script comment

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Made most of the editorial changes but there are a couple open items

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Final editorial changes applied, ready to merge

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-08-30 09:41:58 -07:00
Jeff Huss a39e2c4e07
Added link to Maven coordinates and updated plugins list with Geospatial (#999)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-08-25 09:53:43 -07:00
Alek Poteet d417b5d85a
Add examples for bulk script & upsert updates (#783)
There is no mention of doc_as_upsert in OS documention, but it appears to be supported. Some examples to go along with the passing mention of scripts & especially upsert would go a long way
This also addresses #755

Signed-off-by: Alek Poteet <patrick.poteet@shipveho.com>

Signed-off-by: Alek Poteet <patrick.poteet@shipveho.com>
2022-08-23 20:58:03 -05:00
Jeff Huss 43037838ec
Moved guidance on passing env vars as args to Configuration - it was previously under installation (#962)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-08-23 15:09:50 -07:00
Jeff Huss a4c89a24b8
Added list of plugins that can be installed by name (#957)
* Added list of plugins that can be installed by name

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed a typo

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added plugin-name to the command under additional plugins

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-08-23 11:06:38 -07:00
Melissa Vagi a6f6f98806
Resolve issue #879 (#940)
Signed-off-by: vagimeli <vagimeli@amazon.com>

Signed-off-by: vagimeli <vagimeli@amazon.com>
2022-08-23 11:02:24 -06:00
STEVE MURPHY ebe1faeefd
add files for snapshot creation (#873)
* add files for snapshot creation

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* Create new topics and fix existing. Modify index.md

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* Address Fanit's edits. Apply edits to other files as needed for consistenty. Create new files: get-snapshot.status.md and restore-snapshot.md.

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* Add .md file extension to get-snapshot-repository file

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* Add verify-snapshot-repository.md, renumber nav_order in other snapshot topics to place the new topic correctly.

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* Apply Fanit's edits to restore-snapsnot.md and verify-snapshot-repository.md

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* Address Fanit's edits.

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

* Change 'Response fields' heading level to 3.

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>

Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
Co-authored-by: Steve Murphy <stevemurphy@BCSR-11413.local>
2022-08-23 11:42:19 -05:00
Chris Moore f32c849c93
Add upsert description to Update document API information (#934)
* fix#755-Update-document-upserts

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#755-Update-document-upserts

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#755-Update-document-upserts

Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>
2022-08-22 13:10:29 -07:00
Jeff Huss 7e5a84d3f8
Previous PR didn't backport correctly - fixed some syntax and opening new PR with proper backport (#931)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-08-19 14:50:22 -07:00
Jeff Huss 9a6ffd1d1a
Plugins page revamp (#929)
* Removed html table and added markdown table

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Removed html table and added markdown table part 2

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Sorted list of plugins

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added repo links and plugin names

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* A little more polish.  Ready for review.

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Small tweaks to formatting so the footnote doesn't run into the end of the table

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-08-19 13:39:20 -07:00
Aria Marble 22d0dc66d0
added batch mode to plugin install documentation (#920)
* added batch mode to plugin install documentation

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

* Update _opensearch/install/plugins.md

Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>

* Revert "added batch mode to plugin install documentation"

This reverts commit 5751981851e023e26dde2a5863d0b49e59e491e1.

* added batch mode to plugin install documentation

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

Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
2022-08-18 19:39:23 -07:00