Commit Graph
40 Commits
Author SHA1 Message Date
Aria MarbleandNathan Bower 872af11dd6 Add documentation for wait_for_completion API (#3458)
* Add documentation for wait_for_completion API

Signed-off-by: ariamarble <[email protected]>

* draft update

Signed-off-by: ariamarble <[email protected]>

* small comment

Signed-off-by: ariamarble <[email protected]>

* page and toc updates

Signed-off-by: ariamarble <[email protected]>

* page updates

Signed-off-by: ariamarble <[email protected]>

* final changes

Signed-off-by: ariamarble <[email protected]>

* doc review changes

Signed-off-by: ariamarble <[email protected]>

* link to task api

Signed-off-by: ariamarble <[email protected]>

* further doc review updates

Signed-off-by: ariamarble <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>

* made editorial changes

Signed-off-by: ariamarble <[email protected]>

---------

Signed-off-by: ariamarble <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
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 <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

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

Signed-off-by: cwillum <[email protected]>

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

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

* fix#3183 for merge main

Signed-off-by: cwillum <[email protected]>

* fix#3183 fixing links-breaking links

Signed-off-by: cwillum <[email protected]>

* sec permissions for SA

Signed-off-by: cwillum <[email protected]>

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

Signed-off-by: cwillum <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
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 <[email protected]>

* Modifying the proposal based on maintainers input.

Signed-off-by: AmiStrn <[email protected]>

---------

Signed-off-by: AmiStrn <[email protected]>
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 <[email protected]>

* Capture URI::InvalidURIError.

Signed-off-by: dblock <[email protected]>

* Use HEAD and catch URI errors.

Signed-off-by: dblock <[email protected]>

* Retry on a 405 with a GET.

Signed-off-by: dblock <[email protected]>

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

Signed-off-by: dblock <[email protected]>

* Don't exit with an exception.

Signed-off-by: dblock <[email protected]>

* Run internal link checker on build/ci.

Signed-off-by: dblock <[email protected]>

* Added broken links issue template.

Signed-off-by: dblock <[email protected]>

* Added host exclusions that 404 or fail on bots.

Signed-off-by: dblock <[email protected]>

* Raise anyway because Jekyll does it for us.

Signed-off-by: dblock <[email protected]>

* Fix broken links.

Signed-off-by: dblock <[email protected]>

* Only run link checker on main.

Signed-off-by: dblock <[email protected]>

* Re-add check-links.sh.

Signed-off-by: dblock <[email protected]>

* Run once a day on cron.

Signed-off-by: dblock <[email protected]>

---------

Signed-off-by: dblock <[email protected]>
2023-04-04 15:49:27 -04:00
Arnoldas GrigutisandAria Marble 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 <[email protected]>
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 <[email protected]>

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

* doc review updates

Signed-off-by: ariamarble <[email protected]>

---------

Signed-off-by: ariamarble <[email protected]>
2023-03-10 10:35:23 -08:00
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 <[email protected]>

* Apply suggestions from tech writer review

* Apply suggestions from doc review

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <[email protected]>

* Apply suggestions from editorial review

---------

Signed-off-by: syrinx05p <[email protected]>
Co-authored-by: syrinx05p <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
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 <[email protected]>

* Change config settings

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix links

Signed-off-by: Naarcha-AWS <[email protected]>

* Add Query DSL back to Search

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix remaining links

Signed-off-by: Naarcha-AWS <[email protected]>

* Last reorder

Signed-off-by: Naarcha-AWS <[email protected]>

* Add Heather's feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Add Query DSL section. Delete Index Data page

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix index title

Signed-off-by: Naarcha-AWS <[email protected]>

* Add correct title to managing indexes

Signed-off-by: Naarcha-AWS <[email protected]>

* Change config yml

Signed-off-by: Naarcha-AWS <[email protected]>

* Add permalinks for each page in query DSL section

Signed-off-by: Naarcha-AWS <[email protected]>

* :wq

---------

Signed-off-by: Naarcha-AWS <[email protected]>
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 <[email protected]>

* Switched default and best compression

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
2023-03-07 16:25:25 -05:00
kolchfa-aws 84ecf3f55a Fix refresh parameter for update by query (#3253)
Signed-off-by: Fanit Kolchina <[email protected]>
2023-03-07 10:45:47 -05:00
kolchfa-aws c9e372f053 Link fix (#3223)
Signed-off-by: Fanit Kolchina <[email protected]>
2023-03-06 11:41:22 -05:00
9414701fda Update the create snapshot repository documentation (#3116)
* Update create snapshot repository documentation

Signed-off-by: ariamarble <[email protected]>

* Apply suggestions from doc review review

Co-authored-by: kolchfa-aws <[email protected]>

* made additional review changes

Signed-off-by: ariamarble <[email protected]>

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <[email protected]>

---------

Signed-off-by: ariamarble <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-03-01 14:52:22 -08:00
kolchfa-aws 3da7598c0c Change sample to example (#2972)
Signed-off-by: Fanit Kolchina <[email protected]>
2023-02-20 11:34:20 -05:00
Naarcha-AWS 45834d6f78 Once more... Managing, Monitoring, Tuning. (#2653)
Signed-off-by: Naarcha-AWS <[email protected]>
2023-02-06 11:48:25 -06:00
Naarcha-AWS 6ebd6cfbcf Add redirects for recent TOC changes (#2577)
Signed-off-by: Naarcha-AWS <[email protected]>
2023-02-02 17:48:13 -06:00
kolchfa-awsandNathan Bower 6e120ec4b8 Adds max_shard_size parameter to shrink API (#2519)
* Adds max_shard_size parameter to shrink API

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented tech review comment

Signed-off-by: Fanit Kolchina <[email protected]>

* One more rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

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

Co-authored-by: Nathan Bower <[email protected]>

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

Co-authored-by: Nathan Bower <[email protected]>

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

Co-authored-by: Nathan Bower <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-02-02 15:05:34 -05:00
Aria Marble 0b9f2c866f cluster api toc update (#2573)
Signed-off-by: ariamarble <[email protected]>
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 <[email protected]>
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 <[email protected]>

* Add CLI redirect

Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>
2023-01-24 12:12:21 -06:00
1589201a9e Add cluster awareness and decommission docs (#2438)
* Add cluster awareness and decommission docs

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Bukhtawar Khan <[email protected]>

* Edit technical feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Add new cluster awareness examples

Signed-off-by: Naarcha-AWS <[email protected]>

* Add technical feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Alice Williams <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Alice Williams <[email protected]>

* Add Caroline's feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Add one more tweak

Signed-off-by: Naarcha-AWS <[email protected]>

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

Co-authored-by: Heather Halter <[email protected]>

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

Co-authored-by: Heather Halter <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

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

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

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

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-decommission.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-decommission.md

Co-authored-by: Nate Bower <[email protected]>

* Add editoiral feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix typos

Signed-off-by: Naarcha-AWS <[email protected]>

* Final editorial note

Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Bukhtawar Khan <[email protected]>
Co-authored-by: Alice Williams <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Nate Bower <[email protected]>
2023-01-23 17:13:07 -06:00
kolchfa-awsandNate Bower 1ff9a59bf0 Adds cluster health by awareness attribute documentation (#2398)
* Adds cluster health by awareness attribute documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Added new response and edited note for clarity

Signed-off-by: Fanit Kolchina <[email protected]>

* Minor rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Incorporated doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Minor edits

Signed-off-by: Fanit Kolchina <[email protected]>

* More updates

Signed-off-by: Fanit Kolchina <[email protected]>

* Minor rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Minor rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _api-reference/cluster-health.md

Co-authored-by: Nate Bower <[email protected]>

* Update _api-reference/cluster-health.md

Co-authored-by: Nate Bower <[email protected]>

* Removed experimental flag and reworked to add in main body

Signed-off-by: Fanit Kolchina <[email protected]>

* One more merge conflict resolved

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: Nate Bower <[email protected]>
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 <[email protected]>

* Incorporated doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Formatting tables

Signed-off-by: Fanit Kolchina <[email protected]>

* More formatting changes

Signed-off-by: Fanit Kolchina <[email protected]>

* Incorporated editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
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 <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
2022-12-19 14:41:42 -05:00
Aria Marble 2f814facb3 Correct API endpoints for CAT API reference (#2158)
Signed-off-by: ariamarble <[email protected]>

Signed-off-by: ariamarble <[email protected]>
2022-12-13 09:52:53 -08:00
Aria Marble e05def9246 Correct table formatting for cluster settings page (#2172)
Signed-off-by: ariamarble <[email protected]>

Signed-off-by: ariamarble <[email protected]>
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 <[email protected]>

* made suggested changes

Signed-off-by: ariamarble <[email protected]>

Signed-off-by: ariamarble <[email protected]>
2022-12-07 16:21:03 -08:00
Aria Marble aaad91a4ed CAT API inclusive language update (#2136)
Signed-off-by: ariamarble <[email protected]>

Signed-off-by: ariamarble <[email protected]>
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 <[email protected]>

* Fix redirect error

Signed-off-by: Naarcha-AWS <[email protected]>

* Slight tweak to intro

Signed-off-by: Naarcha-AWS <[email protected]>

* Add Chris' feedback

Signed-off-by: Naarcha-AWS <[email protected]>
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 <[email protected]>

* made suggested changes

Signed-off-by: ariamarble <[email protected]>

* made editorial changes

Signed-off-by: ariamarble <[email protected]>

Signed-off-by: ariamarble <[email protected]>
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 <[email protected]>

* Added a comment on the new parameter

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
2022-11-28 13:43:42 -05:00