Commit Graph

76 Commits

Author SHA1 Message Date
Aria Marble bccd253315
[DOC][v2.4.0] Adds documentation for Error Prevention Validation for ISM API (#1884)
* Adds documentation for Error Prevention Validation for ISM API

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

* wording changes

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

* made suggested changed

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-11-15 13:03:41 -08:00
Lauri Moilanen 5036cfa12c
Add min_rollover_age transition condition to documentation (#1751)
* Add min_rollover_age transition to documentation

Signed-off-by: Lauri Moilanen <lauri.moilanen@cloubi.com>

* Update _im-plugin/ism/policies.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Lauri Moilanen <lauri.moilanen@cloubi.com>

Signed-off-by: Lauri Moilanen <lauri.moilanen@cloubi.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2022-11-01 07:47:31 -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
syrinx05p 0cb8d7eeff
add note for supported units of min_index_age in ISM policies document (#1600)
Signed-off-by: syrinx05p <4161768+syrinx05p@users.noreply.github.com>

Signed-off-by: syrinx05p <4161768+syrinx05p@users.noreply.github.com>
2022-10-26 14:21:50 -05:00
Aria Marble fa2535ab9d
Add ism rollup to documentation (#1371)
* add ism rollup to documentation

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

* made suggested changes

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

* added field descriptions

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

* added further requested changes

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

* tech review updates

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

* minor spelling changes and link update

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-05 08:45:49 -07:00
Carlo Smouter 3f79fd8ccb
fix aliases example for shrink policy action (#1014)
Signed-off-by: Carlo Smouter <carlos@cynet.com>

Signed-off-by: Carlo Smouter <carlos@cynet.com>
Co-authored-by: Carlo Smouter <carlos@cynet.com>
2022-09-15 14:02:39 -05:00
kolchfa-aws f225c77c34
Snapshot management (#757)
* Added snapshot management

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

* Snapshot management v2

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

* Added snapshot management

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

* Added user roles

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

* Added SME comments

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

* Changed dashboards access from index management to snapshot management

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

* Editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-07-07 14:19:01 -04:00
Liz Snyder cb152712d3
Remove unusable request (#703)
Signed-off-by: Liz Snyder <elizabsn@amazon.com>
2022-06-22 14:18:35 -07:00
Keith Chan d7f42451e4
Merge branch 'main' into notifications 2022-05-24 09:32:21 -07:00
Naarcha-AWS 5881cbced3
Merge pull request #542 from sastorsl/action-rollover-min_primary_shard_size
Add doc on action rollover min_primary_shard_size
2022-05-24 09:43:06 -05:00
Stein Arne Storslett d81422cfc3 Add doc on action rollover min_primary_shard_size language.
Signed-off-by: Stein Arne Storslett <sastorsl@users.noreply.github.com>
2022-05-24 09:49:45 +02:00
Stein Arne Storslett 53337576b7 Add doc on action rollover min_primary_shard_size language.
Signed-off-by: Stein Arne Storslett <sastorsl@users.noreply.github.com>
2022-05-23 09:40:38 +02:00
Stein Arne Storslett 2992b6cb7a Add doc on action rollover min_primary_shard_size language.
Signed-off-by: Stein Arne Storslett <sastorsl@users.noreply.github.com>
2022-05-23 09:33:38 +02:00
Stein Arne Storslett 763f6ce0e8 Add doc on action rollover min_primary_shard_size language.
Signed-off-by: Stein Arne Storslett <sastorsl@users.noreply.github.com>
2022-05-23 09:30:50 +02:00
Stein Arne Storslett c799cf43c7 Add doc on action rollover min_primary_shard_size updated.
Signed-off-by: Stein Arne Storslett <sastorsl@users.noreply.github.com>
2022-05-23 09:21:55 +02:00
keithhc2 f30555ca65 Extra tick
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-05-18 11:55:25 -07:00
keithhc2 a3f2b7ff2d Changed behavior in ISM and Alerting, and added more details
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-05-18 11:37:47 -07:00
Naarcha-AWS a6f9b130d0
Merge pull request #496 from opensearch-project/index-state-manager2.0
Add shrink action to Index Management
2022-05-03 14:41:40 -05:00
Naarcha-AWS f5118eb3b8 Add state management template
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-03 14:30:57 -05:00
Naarcha-AWS 9774fd8ac3 Replace example
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-03 11:38:42 -05:00
Naarcha-AWS 31afaa363d Make example more in line with others on page
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-03 10:39:36 -05:00
Naarcha-AWS 429a982dd6 Add editorial feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-03 10:17:08 -05:00
Stein Arne Storslett 3d04278a67 Add doc on action rollover min_primary_shard_size
Reference https://github.com/opensearch-project/index-management/pull/220

Signed-off-by: Stein Arne Storslett <sastorsl@users.noreply.github.com>
2022-05-03 10:23:23 +02:00
Naarcha-AWS e23c65e608 Add technical feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-04-25 12:55:15 -05:00
Naarcha-AWS 0a24fa2992 Remove from all API requests and responses
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-04-14 12:55:17 -05:00
Naarcha-AWS 95e2c83af5 Remove inconsistencies. Fix language.
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-04-07 18:26:14 -05:00
Naarcha-AWS e0c2f9448b Add shard action
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-04-07 18:12:37 -05:00
keithhc2 c39b1e0e5a Shrunk sample response
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-03-14 12:59:41 -07:00
keithhc2 5bf8250fa0 Added show_policy to explain
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-03-14 12:48:30 -07:00
keithhc2 fdb1fe3a0b Deleted a word
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-02-16 15:28:00 -08:00
keithhc2 b3291fa95b Language tweaks
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-02-15 13:03:52 -08:00
keithhc2 a229d9d305 Clarified timeout
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-02-15 12:01:51 -08:00
Radu Gheorghe 14907ec1b0
Updated usage of ISM's rollover_skip
Cluster Update Settings API complains that `index.plugins.index_state_management.rollover_skip` is an invalid setting. Index Update Settings API seems to work, though. And it's backed up by the definition here: 6141c3c6fe/src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/settings/ManagedIndexSettings.kt (L78)

This PR updates the doc according to the above.

Signed-off-by: Radu Gheorghe <radu.gheorghe@sematext.com>
2022-02-11 15:09:39 +02:00
keithhc2 b77825327f Language tweaks
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-02-04 14:35:53 -08:00
keithhc2 dd3aac5a4e Added warning about symbols
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-02-03 16:12:55 -08:00
ashwinkumar12345 5adbead480 added examples for transition and action
Signed-off-by: ashwinkumar12345 <kumarjao@users.noreply.github.com>
2022-01-26 01:24:00 -08:00
keithhc2 d5b2d47a5f Tweaked language
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-01-10 14:25:04 -08:00
Keith Chan 3ae1a4d68c
Merge pull request #249 from opensearch-project/ism-snapshot-changes
Updated so snapshots now include Mustache templates as names
2021-11-23 09:48:22 -08:00
keithhc2 e6f868c335 Addressed feedback
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2021-11-15 16:54:04 -08:00
keithhc2 66df9f9cd5 Added new IM 1.2 settings
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2021-11-15 16:09:14 -08:00
keithhc2 4ae3cc02b6 One more Mustache 2021-11-05 14:21:13 -07:00
keithhc2 aa844bd649 Tweak to Mustache templates 2021-11-05 14:10:44 -07:00
keithhc2 051ed49aaf Updated so snapshots now includes Mustache templates as names 2021-11-05 12:43:00 -07:00
Keith Chan 7f7f786d80
Update index.md 2021-11-01 14:47:55 -07:00
Keith Chan 2f35a61805
Added a hyperlink to update cluster settings API 2021-11-01 14:39:26 -07:00
Keith Chan a31f0efa72
Minor language tweak again 2021-11-01 14:37:01 -07:00
Keith Chan 7ded80ce11
Minor language tweaks 2021-11-01 14:34:04 -07:00
bowenlan-amzn d9b98fad1b ism doc changes
1. suggest setup error notification
2. mention rollover_skip index setting

Signed-off-by: bowenlan-amzn <bowenlan23@gmail.com>
2021-11-01 10:01:29 -07:00
Keith Chan 40db4bd47d
Merge pull request #221 from opensearch-project/ism-visual-editor
Added steps about using ISM visual editor
2021-10-22 14:14:01 -07:00
keithhc2 cd5e0ac390 Added instructions about ISM visual editor 2021-10-07 15:15:58 -07:00