Commit Graph

106 Commits

Author SHA1 Message Date
Heather Halter 9cf4cd203e
fixindexapiorder (#4146)
Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-23 08:52:25 -07:00
seittema 3e3a54d312
Update update-by-query.md (#3693)
* Update update-by-query.md

Updated the slices parameter description to be in-line with what's actually available.  You can specify the string 'auto' as well.  The text is pulled from the https://github.com/opensearch-project/documentation-website/blob/main/_api-reference/document-apis/delete-by-query.md documentation to keep in sync.

* Update _api-reference/document-apis/update-by-query.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@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-05-22 17:00:09 -05:00
Heather Halter 190bdd75db
Adds list to REST API reference page (#4128)
* adds list to rest api reference page

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

* tweaked wording

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

* tweaks

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

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-19 11:33:20 -07:00
kolchfa-aws 5f9c0d575a
Add the preference query parameter options (#4099)
* Add the preference query parameter options

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

* Add more valid values

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

* Apply suggestions from code review

Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.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: Chris Moore <107723039+cwillum@users.noreply.github.com>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-18 09:50:27 -04:00
Heather Halter ee7d1efd02
More redirects and spelling fixes (#4093)
* redirects and spelling

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

* Update _observing-your-data/ad/index.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/ad/index.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _search-plugins/knn/index.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
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: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-05-17 09:57:14 -07:00
Heather Halter 6f6848dff8
More redirect updates (#4077)
* more redirects

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

* fixlinks

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

* fixedlinks

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

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-15 14:59:57 -07:00
astephanus 1fb5252cd6
Adds collections landing page configuration and navigation header linking (#3812)
* Adds collections landing page configuration and navigation header linking

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Removes unnecessary collection property from the configuration.

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds links to navigation collection headers to collection index pages based on the collection name

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Hide index pages from view and add info to formatting guide

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

---------

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-11 13:56:08 -04:00
kolchfa-aws 76fb104897
Add Terraform provider documentation (#4035)
* Add Terraform provider documentation

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

* Update _tools/terraform.md

Co-authored-by: Nathan Bower <nbower@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: Nathan Bower <nbower@amazon.com>
2023-05-08 16:23:04 -04:00
Heather Halter ec648b8f83
More redirect changes and small tweaks (#4022)
* more redirect changes and small tweaks

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

* Update _api-reference/cluster-api/cluster-allocation.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/cluster-api/cluster-awareness.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/cluster-api/cluster-health.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/cluster-api/cluster-decommission.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _im-plugin/ism/managedindexes.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.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>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2023-05-05 09:02:49 -07:00
Heather Halter d1c22f9f68
more api redirects (#4013)
Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-04 17:03:27 -07:00
Heather Halter 22cfcf119b
CAT API redirects (#3965)
* catapi redirects

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

* data prepper redirects

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

* committing unsaved

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

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-04 11:22:52 -07:00
Heather Halter 8ed9a9505b
More redirect fixes - index and ingestion APIs (#3975)
* more redirect fixes to index and ingest apis

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

* one more

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

---------

Signed-off-by: Heather Halter <hdhalter@amazon.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-05-04 10:44:02 -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
Heather Halter 9e5b044742
Fixes issue in code and add redirects (#3964)
* fix redirects

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

* fix spelling

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

* Update _api-reference/index-apis/create-index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
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: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2023-05-03 19:47:32 -07:00
kolchfa-aws 9913d1d640
Add CAT segment replication API (#2937)
* Add CAT segment replication API

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

* Refactoring after a conversation with SMEs

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

* Added copy buttons and changed sample to example

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

* Revise for 2.7

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

* Added aliases

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

* Reorder pages

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

* Update cat-segment-replication.md

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>

* Implemented doc review comments

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

* Update cat-segment-replication.md

* Apply suggestions from code review

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

* Implemented editorial review comment

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

* Fix link

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

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-02 11:05:49 -04:00
kolchfa-aws bb8f900772
Add primary shard balancing documentation (#3769)
* Add primary shard balancing documentation

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

* Adds default value

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

* Update _api-reference/cluster-api/cluster-settings.md

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

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-02 11:02:51 -04:00
Aria Marble 872af11dd6
Add documentation for wait_for_completion API (#3458)
* Add documentation for wait_for_completion API

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

* draft update

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

* small comment

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

* page and toc updates

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

* page updates

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

* final changes

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

* doc review changes

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

* link to task api

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

* further doc review updates

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

* Apply suggestions from code review

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

* made editorial changes

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

---------

Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-04-20 08:42:25 -07:00
Chris Moore ede72716a5
Add Security information to Security Analytics documentation (#3184)
* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* fix#3183-sec-for-sec-a

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

* fix#3183-sec-for-sec-a

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* sec permissions for SA

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

* fix#3183 for merge main

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

* fix#3183 fixing links-breaking links

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

* sec permissions for SA

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

* fix#3183-sec-for-sec-a

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

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
2023-04-05 09:53:30 -07:00
amitai stern b6763b1815
Adding documentation for behavior of indices.recovery.max_bytes_per_sec set to `0mb` or less (#3649)
* After a lovely surprise when trying to limit the recovery completely and discovering the opposite was happening I see we need the documentation to include this nice extra info.
Resolves #3648

Signed-off-by: AmiStrn <123amitai@gmail.com>

* Modifying the proposal based on maintainers input.

Signed-off-by: AmiStrn <123amitai@gmail.com>

---------

Signed-off-by: AmiStrn <123amitai@gmail.com>
2023-04-04 15:14:16 -05:00
Daniel (dB.) Doubrovkine 680c821937
Add CI with link checker. (#3584)
* Add CI with link checker.

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

* Capture URI::InvalidURIError.

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

* Use HEAD and catch URI errors.

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

* Retry on a 405 with a GET.

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

* Replaced external link checker with ruby-link-checker.

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

* Don't exit with an exception.

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

* Run internal link checker on build/ci.

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

* Added broken links issue template.

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

* Added host exclusions that 404 or fail on bots.

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

* Raise anyway because Jekyll does it for us.

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

* Fix broken links.

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

* Only run link checker on main.

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

* Re-add check-links.sh.

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

* Run once a day on cron.

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

---------

Signed-off-by: dblock <dblock@amazon.com>
2023-04-04 15:49:27 -04:00
Arnoldas Grigutis eead5ecf29
Update put-mapping.md: add "dynamic" (#3384)
* Update put-mapping.md: add an example for "dynamic": "strict" in index mapping JSON

* Apply suggestions from code review

---------

Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com>
2023-03-16 09:42:13 -07:00
Aria Marble 46a34266df
Update slice parameter with additional information (#3350)
* Update slice parameter with additional information

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

* Update _api-reference/document-apis/reindex.md

* doc review updates

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

---------

Signed-off-by: ariamarble <armarble@amazon.com>
2023-03-10 10:35:23 -08:00
tkykenmt 7539e7fb44
add instruction for using parameters and sorting for stored script (#1834)
* add instruction for using parameters in stored script and sorting example results using stored script

Signed-off-by: syrinx05p <4161768+syrinx05p@users.noreply.github.com>

* Apply suggestions from tech writer review

* Apply suggestions from doc review

* Apply suggestions from editorial review

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

* Apply suggestions from editorial review

---------

Signed-off-by: syrinx05p <4161768+syrinx05p@users.noreply.github.com>
Co-authored-by: syrinx05p <4161768+syrinx05p@users.noreply.github.com>
Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-03-09 12:45:15 -08: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
kolchfa-aws a5ac71a079
Add descriptions for index codec values (#3252)
* Add descriptions for index codec values

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

* Switched default and best compression

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

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-03-07 16:25:25 -05:00
kolchfa-aws 84ecf3f55a
Fix refresh parameter for update by query (#3253)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-03-07 10:45:47 -05:00
kolchfa-aws c9e372f053
Link fix (#3223)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-03-06 11:41:22 -05: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
kolchfa-aws 3da7598c0c
Change sample to example (#2972)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-02-20 11:34:20 -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
Naarcha-AWS 6ebd6cfbcf
Add redirects for recent TOC changes (#2577)
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-02-02 17:48:13 -06:00
kolchfa-aws 6e120ec4b8
Adds max_shard_size parameter to shrink API (#2519)
* Adds max_shard_size parameter to shrink API

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

* Implemented tech review comment

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

* One more rewording

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

* Implemented doc review comments

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

* Update _api-reference/index-apis/shrink-index.md

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

* Update _api-reference/index-apis/shrink-index.md

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

* Update _api-reference/index-apis/shrink-index.md

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

* Implemented editorial comments

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

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-02-02 15:05:34 -05:00
Aria Marble 0b9f2c866f
cluster api toc update (#2573)
Signed-off-by: ariamarble <armarble@amazon.com>
2023-02-02 09:15:27 -08:00
kolchfa-aws 7992ec0196
Adds copy buttons to API and field type sections (#2518)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-01-30 17:09:38 -05:00
Naarcha-AWS 5bbeac2357
Fix links for 2.5 doc changes. (#2465)
* Fix links for 2.5 doc changes.

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

* Add CLI redirect

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-01-24 12:12:21 -06:00
Naarcha-AWS 1589201a9e
Add cluster awareness and decommission docs (#2438)
* Add cluster awareness and decommission docs

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

* Update _api-reference/cluster-awareness.md

Co-authored-by: Bukhtawar Khan <bukhtawar7152@gmail.com>

* Edit technical feedback

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

* Add new cluster awareness examples

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

* Add technical feedback

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Add Caroline's feedback

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

* Add one more tweak

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

* Update _ml-commons-plugin/cluster-settings.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _ml-commons-plugin/cluster-settings.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-decommission.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-decommission.md

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

* Add editoiral feedback

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

* Fix typos

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

* Final editorial note

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Bukhtawar Khan <bukhtawar7152@gmail.com>
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Nate Bower <nbower@amazon.com>
2023-01-23 17:13:07 -06:00
kolchfa-aws 1ff9a59bf0
Adds cluster health by awareness attribute documentation (#2398)
* Adds cluster health by awareness attribute documentation

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

* Added new response and edited note for clarity

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

* Minor rewording

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

* Incorporated doc review comments

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

* Minor edits

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

* More updates

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

* Minor rewording

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

* Rewording

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

* Minor rewording

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

* Update _api-reference/cluster-health.md

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

* Update _api-reference/cluster-health.md

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

* Removed experimental flag and reworked to add in main body

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

* One more merge conflict resolved

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
2023-01-18 15:51:05 -05:00
kolchfa-aws ddb6db4e20
Adds response fields to the cluster health API (#2385)
* Adds response fields to the cluster health API

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

* Incorporated doc review comments

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

* Formatting tables

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

* More formatting changes

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

* Incorporated editorial comments

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-01-11 14:54:56 -05:00
kolchfa-aws 0402d132dd
Adds feedback mechanism and more site visual improvements (#2259)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-12-19 14:41:42 -05:00
Aria Marble 2f814facb3
Correct API endpoints for CAT API reference (#2158)
Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-12-13 09:52:53 -08:00
Aria Marble e05def9246
Correct table formatting for cluster settings page (#2172)
Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-12-13 09:39:19 -08:00
Aria Marble 3266212dad
Fix table formatting on CAT allocation page (#2151)
* Fix table formatting on CAT allocation page

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-12-07 16:21:03 -08:00
Aria Marble aaad91a4ed
CAT API inclusive language update (#2136)
Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-12-06 13:52:33 -08:00
Naarcha-AWS e81a878acf
Add installation and configuration section (#2130)
* Fix all links

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

* Fix redirect error

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

* Slight tweak to intro

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

* Add Chris' feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-12-05 14:13:41 -06:00
Aria Marble 867167a3b4
Adds compatible cluster API field parameters to cluster API page (#2085)
* Adds compatible cluster API field parameters

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

* made suggested 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-12-05 09:29:19 -08:00
kolchfa-aws cb9b5a6eea
Removes max_primary_shard_size parameter (#1914)
* Removes max_primary_shard_size parameter

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

* Added a comment on the new parameter

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-28 13:43:42 -05:00
kolchfa-aws 63019c421d
Puts column headers in sentence case (#1989)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-18 15:25:06 -05:00
kolchfa-aws 91caf0cc09
Adds search backpressure documentation (#1790)
* Adds search backpressure documentation

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

* Updated response

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

* Removed last cancelled task

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

* Fixed typo

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

* Incorporated tech review feedback

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

* Incorporated doc review feedback

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

* Update _opensearch/search-backpressure.md

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

* Apply suggestions from code review

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

* Rewording

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

* Minor rewording for clarity

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-11-10 11:17:53 -05:00
kolchfa-aws b01d901caf
Adds execute script API (#1769)
* Adds execute script API

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

* Reword a sentence

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

* Punctuation

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

* Update _api-reference/script-apis/exec-script.md

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

* Update _api-reference/script-apis/exec-script.md

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

* Update _api-reference/script-apis/exec-script.md

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

* Update _api-reference/script-apis/exec-script.md

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

* Incorporated 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-11-09 11:01:52 -05:00
kolchfa-aws f3a909db20
Adds Point in Time documentation (#1753)
* Adds Point in Time documentation

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

* Added to security model

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

* Added new parameter descriptions

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

* Added space

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

* Spelled out PIT

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

* Incorporated tech review comments

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

* Changed total to time

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

* Fixed link

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

* Editing

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

* Incorporated tech review comments

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

* Incorporated review comments

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

* Incorporated doc review comments

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

* Incorporated editorial feedback

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

* Minor edits

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-04 09:11:38 -04:00
kolchfa-aws faa36e33af
Adds to alias documentation (#1764)
* Adds to alias documentation

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

* Rewording

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

* Points to more alias api operations

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-02 10:38:37 -04:00
kolchfa-aws 756fc5829e
Adds get settings (#1767)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-01 09:11:27 -04:00
kolchfa-aws 2dcd060041
Adds data streams, shrink, snapshot and template API (#1768)
* Adds get all data streams

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

* Added more APIs

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-01 09:11:10 -04:00
Alice Williams fe8d702ca9
add operation to titles to differentiate from the API group acronym (#1750)
* add operation to titles to differentiate from the API group acronym

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

* update frontmatter with new page title

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

* for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713

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

* to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly

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

* to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title

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

Signed-off-by: alicejw <alicejw@amazon.com>
2022-10-31 09:21:32 -07:00
Alice Williams 3d3f28ae14
update frontmatter for parent name title to Compact and aligned text (CAT) API (#1740)
Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-10-27 12:43:03 -05:00
Naarcha-AWS 7bb41fe4ce
Make API reference top level (#1637)
* Make API reference top level

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

* Fix typo on Drag and Drop page (#1633)

* Fix typo on Drag and Drop page

* Update _dashboards/drag-drop-wizard.md

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

* Update drag-drop-wizard.md

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

* Putting all the Docker install material on a single page (#1452)

* Putting all the Docker install material on a single page

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

* Making room for revamp

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

* Intro added

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

* Continuing to flesh out the intro section and overview

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

* Overview finalized

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

* Introducing docker compose

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

* Added link to compose

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

* Continuing docker image commentary

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

* Sometimes I wonder if anyone reads these

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

* Adding notes on installing compose with pip

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

* Adding prereqs

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

* Magnets - how do they work?

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

* Almonds and peaches are part of the same plant subgenus, Amygdalus

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

* There are 293 ways to make change for a dollar

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

* A shark is the only known fish that can blink with both eyes

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

* A crocodile cannot stick its tongue out

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

* wording

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

* Reorganizing a couple paragraphs to make it flow better

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

* Forgot a word

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

* Add tip about pruning stopped containers

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

* Cleaning up

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

* Add blurb about container ls

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

* Adding the Docker Compose stuff

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

* Working on compose

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

* Continuing work on the compose section - it's a lot of info

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

* Added important settings

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

* Updates to settings that need configured

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

* Still working through compose things

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

* Fixed wording

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

* Working through compose commands and guidance

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

* Reordering/rewording

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

* More phrasing

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

* More wording in steps

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

* More wording in steps

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

* Organizing

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

* Adding stuff and things

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

* Continuing to work through the configuration steps

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

* Fixes

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

* Fixes

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

* Still working on the configuration steps

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

* Changes

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

* More work

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

* Removed perf analyzer - refer to GH issue 1555

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

* Fixing things

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

* Adding guidance on passing settings in compose

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

* Working through dockerfile materials now

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

* wording

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

* Finalized the sample dev compose file

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

* Continuing work with configuration

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

* Finished - ready for reviews

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

* Fixed a link I forgot to change before

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

* Changes from first proofread

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

* Changed heading

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

* Addressed reviewer comments and made some changes

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

* Forgot to incorporate one change. Fixed.

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

* Final editorial changes

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

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

* fix#1584-custom_attr_allowlist (#1636)

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

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

* Update TERMS.md with definition for Setting (#1632)

* fix#1631-Terms-setting

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

* fix#1631-Terms-setting

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

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

* Add disclaimer about remote fs usage and an example of setting env var (#1644)

* Add disclaimer about remote fs usage and an example of setting env var

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

* Enhanced wording a little bit

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

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

* [DOC] New documentation: Self-host maps server (#1625)

* Add new page self-host maps server

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

* Added new content

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

* Copy edit

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

* Tech review edits

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

* Doc review edits

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

* Editorial review changes

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

* Final edits

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

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

* Add feedback.

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

* Fix links

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Jeff Huss <jeffhuss@amazon.com>
Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
2022-10-27 11:50:39 -05:00