Compare commits

...
Author SHA1 Message Date
keithhc2 e5539d555d Added some basic operation to docker quickstart 2021-10-22 11:20:21 -07:00
Keith Chan 029a369bcc Merge pull request #230 from dlvenable/java-high-level
OpenSearch High-Level REST Client
2021-10-20 14:26:02 -07:00
Keith Chan 19ddf35e40 Minor language tweaks 2021-10-20 14:22:42 -07:00
Ashwin Kumar 37d28ed22b Merge pull request #225 from opensearch-project/helm_install_update
Added new Helm install steps
2021-10-20 13:48:26 -07:00
ashwinkumar12345 8d066f218c incorporated feedback 2021-10-20 13:48:03 -07:00
Ashwin Kumar d991dd48c5 Merge pull request #234 from opensearch-project/rev_parameter
Added -rev parameter to securityadmin.sh
2021-10-20 13:34:42 -07:00
Keith Chan efd492c8be Changed title to sentence casing 2021-10-20 11:12:26 -07:00
Keith Chan 39ed675426 Merge pull request #232 from opensearch-project/dashboards-query-language
Added documentation about how to use DQL
2021-10-20 09:58:12 -07:00
keithhc2 f856815737 Typo 2021-10-20 09:57:28 -07:00
keithhc2 be895309a4 Addressed comments 2021-10-19 16:05:01 -07:00
aetter 833e88704c Trivial change to kick off a build 2021-10-19 14:26:09 -07:00
aetter 211da242d6 Update approximate-knn.md 2021-10-19 11:42:46 -07:00
keithhc2 f6cede1ff5 Tweaked some examples 2021-10-19 11:31:13 -07:00
keithhc2 24dcb0ab5c Added a page about how to use DQL 2021-10-19 10:31:35 -07:00
aetter 611dd62151 Slight clarification 2021-10-19 09:52:27 -07:00
aetter e0823b4209 Add install section to make those pages easier to find 2021-10-19 09:49:06 -07:00
Andrew Etter 97476bda60 Merge pull request #229 from Sebas-h/patch-1
Fix authc configuration format.
2021-10-18 14:20:02 -07:00
Andrew Etter d05a252b94 Merge pull request #226 from dlvenable/data-prepper-1.1.0
Updated Data Prepper reference for Data Prepper 1.1.0
2021-10-18 13:09:06 -07:00
David Venable caa8ba67a9 Updated the documentation for the Java High-Level REST client to use OpenSearch.
Signed-off-by: David Venable <[email protected]>
2021-10-18 09:58:22 -05:00
Sebas-h 0d6010716a Fix authc configuration format. 2021-10-18 12:47:34 +02:00
David Venable 72730e9d36 Added links to the gRPC reflection documents in Data Prepper.
Signed-off-by: David Venable <[email protected]>
2021-10-15 16:54:56 -05:00
Andrew Etter b031f07f1f Merge pull request #227 from MrpPolo/patch-1
Update proxy.md
2021-10-14 08:47:32 -07:00
Andrew Etter 6a27363b71 Merge pull request #224 from opensearch-project/dashboards-tip
Add Dashboards header for legacy Kibana OSS scripts
2021-10-14 08:47:13 -07:00
Ashwin Kumar c7dc5e2e8d Merge pull request #223 from opensearch-project/logstash_note
Added note for Logstash
2021-10-14 00:32:36 -07:00
Ashwin Kumar 48ed4ecaac Merge pull request #220 from opensearch-project/ad_table_settings
Minor table formatting
2021-10-14 00:32:02 -07:00
MrpPolo cc6f01b92c Update proxy.md
Update opensearch_dashboards setting to latest version.
2021-10-14 14:35:57 +08:00
David Venable 57471d916c Updated the Data Prepper reference for Data Prepper 1.1.0. Some fields from 1.0.0 which were not present are also now present. Use Amazon OpenSearch Service instead of Amazon ES.
Signed-off-by: David Venable <[email protected]>
2021-10-13 19:42:43 -05:00
ashwinkumar12345 86cce61ca6 minor change 2021-10-13 14:20:42 -07:00
ashwinkumar12345 a8a6d5b0c5 Helm new steps 2021-10-13 14:16:15 -07:00
ashwinkumar12345 866ab1a039 first draft 2021-10-13 12:13:38 -07:00
aetter b97b254678 Present tense 2021-10-11 15:28:19 -07:00
aetter e821f4dd1f Add CCR to plugins summary 2021-10-11 14:10:47 -07:00
aetter e2c6f4c8e9 Add Dashboards header for legacy Kibana OSS scripts 2021-10-11 11:04:59 -07:00
Andrew Etter aa0c445b35 Merge pull request #217 from opensearch-project/styling
Narrower width, hide contributing on small sizes, increase code sample size
2021-10-11 10:39:34 -07:00
ashwinkumar12345 de90dec19a incorporated feedback 2021-10-11 10:32:54 -07:00
Ashwin Kumar 45e326a229 Merge pull request #222 from opensearch-project/sql_image
Updated SQL screenshot
2021-10-11 10:27:25 -07:00
ashwinkumar12345 ffc1237805 added note for Logstash 2021-10-09 11:46:53 -07:00
ashwinkumar12345 f97666c92a updated sql screenshot 2021-10-09 11:30:46 -07:00
keithhc2 eb10960552 Fixed a broken link 2021-10-07 14:32:19 -07:00
ashwinkumar12345 ecb3acda35 table formatting 2021-10-07 14:29:00 -07:00
Miki 0cdee1b9f1 Merge pull request #219 from AMoo-Miki/fix-asset-validation
Enhancements to link-checker
2021-10-07 13:54:16 -07:00
Miki 41c01358b9 Enhancements to link-checker
* Handle validation of non-HTML assets (zip files for samples)
* Cleaned the documentation

Signed-off-by: Miki <[email protected]>
2021-10-07 13:19:36 -07:00
Miki 23e4562f54 Merge pull request #218 from AMoo-Miki/change-basedir
Match `basedir` build config with actual destination of CI
2021-10-07 13:16:32 -07:00
Miki b21bc57c19 Match basedir build config with actual destination of CI
Signed-off-by: Miki <[email protected]>
2021-10-07 13:11:25 -07:00
Miki 907d8fa78c Merge pull request #216 from AMoo-Miki/main
Fix versions selection being blocked on mobile devices
2021-10-07 13:10:53 -07:00
aetter d4df82249a Narrower width, hide contributing on small sizes, increase code sample size 2021-10-07 12:36:10 -07:00
Miki ddcec72c2a Fix versions selection being blocked on mobile devices
Signed-off-by: Miki <[email protected]>
2021-10-07 10:29:33 -07:00
Miki d88cc2e810 Merge pull request #215 from AMoo-Miki/main
Add `.x` suffix to versions selector
2021-10-07 10:22:31 -07:00
aetter 49acaf051b Update docker-security.md 2021-10-07 09:54:51 -07:00
Keith Chan a49b3fa2d7 Merge pull request #213 from opensearch-project/index-apis
Reorganized index APIs and added delete/get index
2021-10-06 15:42:29 -07:00
keithhc2 7833b19588 Reorganized index APIs and added delete/get index 2021-10-06 14:33:08 -07:00
Keith Chan 0638eed0c0 Merge pull request #205 from johnpaulensign/patch-1
Update doc verbiage to match latest version
2021-10-06 12:27:44 -07:00
aetter b0358128b2 Tweak alert, remove inaccurate release note 2021-10-06 11:04:35 -07:00
Ashwin Kumar 77dbb091bb Merge pull request #211 from opensearch-project/ad_screenshot
Added AD feedback
2021-10-06 10:59:23 -07:00
Miki 03e3fce37f Add .x suffix to versions selector
Signed-off-by: Miki <[email protected]>
2021-10-06 09:53:15 -07:00
ashwinkumar12345 64a91b7b12 ad feedback 2021-10-05 18:25:45 -07:00
ashwinkumar12345 64252a261f AD screenshot 2021-10-05 18:14:24 -07:00
Miki 510a101e07 Merge pull request #208 from AMoo-Miki/main
Add 1.1 release header
2021-10-05 16:06:26 -07:00
Miki fb0bb8f503 Add 1.1 release header
Signed-off-by: Miki <[email protected]>
2021-10-05 16:02:45 -07:00
ashwinkumar12345 f3a4794c83 incorporated feedback 2021-10-05 15:33:13 -07:00
Andrew Etter f1b01f6179 Merge pull request #198 from opensearch-project/ad_1.1
Added AD changes for 1.1
2021-10-05 15:21:59 -07:00
Andrew Etter 5caca6009b Merge pull request #195 from opensearch-project/ism-visual-editor
Added a small section for the visual editor
2021-10-05 15:21:24 -07:00
Andrew Etter 8ca1b7d932 Merge pull request #193 from opensearch-project/upgrade-cli
Added upgrade tool docs
2021-10-05 15:21:14 -07:00
Andrew Etter 83a6779bb9 Merge pull request #192 from opensearch-project/cross-cluster-replication
Cross-cluster replication docs
2021-10-05 15:20:59 -07:00
Andrew Etter 25a46b6af8 Merge pull request #191 from opensearch-project/1.1.0-release-updates
Initial 1.1.0 updates
2021-10-05 15:20:27 -07:00
Andrew Etter 99e545b92b Merge pull request #179 from opensearch-project/bucket-level-alerting
Modified monitoring to have two kinds of monitors
2021-10-05 15:20:01 -07:00
Andrew Etter 4b5402ad01 Merge pull request #172 from opensearch-project/ism-security
Added security to ISM
2021-10-05 15:19:49 -07:00
Andrew Etter a24ac474f1 Merge pull request #109 from xuezhou25/configuration-env-change
Add instructions on how to change OPENSEARCH_PATH_CONF environment variable
2021-10-05 15:19:38 -07:00
Andrew Etter eb52f210db Merge branch 'main' into configuration-env-change 2021-10-05 15:18:14 -07:00
ashwinkumar12345 6ff9541c4b incorporated feedback 2021-10-05 14:43:31 -07:00
ashwinkumar12345 8394c1117d minor changes 2021-10-05 12:41:37 -07:00
John-Paul Ensign 164c26ba2c Update doc verbiage to match latest version 2021-10-05 14:14:16 -05:00
aetter 3ca13227d2 Add stub page for Grafana 2021-10-05 11:49:01 -07:00
Miki e0b02fcf6a Merge pull request #202 from AMoo-Miki/main
Add versioned documentation and bump to 1.1
2021-10-05 11:09:45 -07:00
Miki 2b1dc38444 Bump current version to 1.1
Signed-off-by: Miki <[email protected]>
2021-10-05 11:05:18 -07:00
Miki bcf443f976 Merge pull request #201 from AMoo-Miki/versioned-1.0
Add versioned documentation
2021-10-05 10:50:28 -07:00
Miki 31003b1523 Add versioned documentation
Reduce font size and expand width

Signed-off-by: Miki <[email protected]>
2021-10-05 10:48:07 -07:00
aetter c91b99037b Add release highlights. 2021-10-05 09:49:15 -07:00
Liz Snyder 79737566a9 Add stats APIs 2021-10-05 08:37:21 -07:00
ashwinkumar12345 a23cdb91ae updated requests and responses 2021-10-05 02:36:58 -07:00
Liz Snyder f57469e0f7 Add back Docker sample 2021-10-04 17:08:58 -07:00
ashwinkumar12345 074f160197 minor fix 2021-10-04 14:21:36 -07:00
ashwinkumar12345 f3897b621c minor change 2021-10-04 14:18:04 -07:00
ashwinkumar12345 4b23a1a36e incorporated feedback 2021-10-04 14:11:45 -07:00
Liz Snyder 16e8e1bbc4 Clarify connection alias 2021-10-04 13:47:22 -07:00
ashwinkumar12345 1c10355a79 minor fixes 2021-10-04 12:41:37 -07:00
ashwinkumar12345 72c710d5a3 historical detector to historical analysis 2021-10-04 12:38:02 -07:00
ashwinkumar12345 f0f770bfad removed validate API 2021-10-04 12:32:08 -07:00
ashwinkumar12345 f12f4efc02 minor fix 2021-10-04 12:13:31 -07:00
ashwinkumar12345 e6403d89a4 ad changes for 1.1 2021-10-04 12:08:00 -07:00
keithhc2 790459778c A comma 2021-10-04 10:03:32 -07:00
Andrew Etter d313fd2e8f Merge pull request #196 from omurbekjk/patch-1
Added missed "template" settings
2021-10-04 09:42:10 -07:00
Daniel Doubrovkine (dB.) b55e3f7e95 Merge pull request #197 from maartenjanvangool/patch-1
Update java-rest-high-level.md
2021-10-04 12:20:44 -04:00
Maarten-Jan a3a1795ab5 Update java-rest-high-level.md
The file has a compile error, I think ); is missing
2021-10-04 17:00:43 +02:00
Omurbek 164ead7dbd Update policies.md 2021-10-04 12:39:06 +03:00
Omurbek 19fb0d0948 Update policies.md 2021-10-04 12:30:23 +03:00
ashwinkumar12345 370ff0fc57 spacing 2021-10-03 10:57:58 -07:00
ashwinkumar12345 c2f1018b36 incorporated feedback 2021-10-03 10:50:46 -07:00
ashwinkumar12345 9f74fed582 more updates 2021-10-03 10:35:18 -07:00
Omurbek 57d7ee0aaa Added missed "template" settings 2021-10-02 23:53:48 +03:00
keithhc2 bfadd04a18 Added a small section for the visual editor 2021-10-01 16:41:31 -07:00
Liz Snyder cdff560cf6 Incorporate feedback and random fixes 2021-10-01 11:43:37 -07:00
ashwinkumar12345 dda5e2a535 fixed indendation feedback 2021-10-01 11:26:24 -07:00
ashwinkumar12345 1fdf8b9517 ad 1.1 2021-10-01 11:22:47 -07:00
aetter 1f90f3ca52 Update Helm links 2021-10-01 09:46:47 -07:00
ashwinkumar12345 0686ae05b5 Added upgrade tool docs 2021-10-01 01:21:16 -07:00
aetter 25c4b70046 Adds plugin list and ARM tarball 2021-09-30 19:58:37 -07:00
Liz Snyder 8d3ae42f6a Typo 2021-09-30 16:43:05 -07:00
Liz Snyder 214f82f1e3 Merge branch 'main' of https://github.com/opensearch-project/documentation-website into cross-cluster-replication 2021-09-30 16:22:36 -07:00
Liz Snyder 5862b1b300 First crack at CCR docs 2021-09-30 16:10:28 -07:00
aetter c378da8799 Make name more explicit 2021-09-30 14:01:14 -07:00
aetter 7cb714894f Nitpicks 2021-09-30 13:52:34 -07:00
Andrew Etter 7f9932f008 Merge pull request #158 from opensearch-project/go-opensearch
Getting started content for Go
2021-09-30 13:49:29 -07:00
Andrew Etter fff3b3ec2b Merge pull request #159 from opensearch-project/js-client
Node JS client overview docs
2021-09-30 13:49:19 -07:00
Andrew Etter 1a901d2033 Merge pull request #150 from opensearch-project/python-client
Getting started content for Python and general client compatibility information
2021-09-30 13:49:07 -07:00
aetter ab00a05549 Comment out Java for now 2021-09-30 13:48:32 -07:00
aetter d4342aab59 Initial 1.1.0 updates 2021-09-30 13:43:24 -07:00
keithhc2 a186b46302 Added trigger instructions for bucket-level monitors 2021-09-30 12:00:37 -07:00
aetter 973d967514 Update impersonation.md 2021-09-29 14:57:46 -07:00
Keith Chan dcb3a0c02d Merge pull request #185 from opensearch-project/document-rest-apis
Added reindex API to REST API reference
2021-09-29 10:31:26 -07:00
aetter 65d2ef4860 Re-add SAML example 2021-09-29 09:29:41 -07:00
keithhc2 7ed1c64a35 Added and adjusted some more language to address comments 2021-09-28 16:06:54 -07:00
aetter d4c20f0402 Re-add LDAP Docker example
Update Docker Compose file
2021-09-28 15:33:48 -07:00
aetter 9a5c8cd6ae Wording change 2021-09-28 13:53:49 -07:00
Andrew Etter 48d1603ed1 Merge pull request #187 from opensearch-project/permissions-improvements
Improve permissions introduction
2021-09-28 13:53:15 -07:00
aetter 01a9fb6d6d Adding async back in, just in case 2021-09-28 11:10:36 -07:00
aetter cbdefc2463 Improve permissions introduction
Also corrects some permissions names that still use `opendistro`, adds missing permissions, adds some short () description to unclear permissions.
2021-09-28 10:54:04 -07:00
Keith Chan a38eb15400 Merge pull request #183 from opensearch-project/security-yml-files
Add descriptions to config yaml files and added some security APIs
2021-09-27 17:08:12 -07:00
keithhc2 dc69f8010b Added a setting to enable patch configuration 2021-09-27 17:07:38 -07:00
keithhc2 b4642195e7 Addressed comments 2021-09-27 16:09:53 -07:00
Andrew Etter 268f1d9571 Merge pull request #174 from opensearch-project/rollups-delay-fix
Update delay to milliseconds
2021-09-27 14:36:29 -07:00
Andrew Etter f8cac33ebc Merge pull request #186 from opensearch-project/ism_priority
Added info about the priority value
2021-09-27 14:36:15 -07:00
ashwinkumar12345 eda842a36d added info about the priority value 2021-09-27 13:08:27 -07:00
keithhc2 7c425f102d Added reindex API 2021-09-27 12:52:36 -07:00
keithhc2 c85fd21b4f Addressed comments 2021-09-27 10:07:37 -07:00
keithhc2 430b9fed50 Added "security" 2021-09-24 14:53:33 -07:00
keithhc2 e8a863e943 Minor language tweak 2021-09-24 14:23:17 -07:00
keithhc2 b12dab6705 Add descriptions to config yaml files and added some security APIs 2021-09-24 14:13:26 -07:00
aetter d2ba96967b Give CCS Compose file unique node names
Avoid weird conflicts if you use our main Compose file and then try to use this one.
2021-09-24 13:49:48 -07:00
aetter a9144167d8 Note that ISM doesn't run jobs on red clusters 2021-09-23 10:29:51 -07:00
aetter 07b0650128 Add remote cluster information operation 2021-09-22 12:59:25 -07:00
Liz Snyder 293743e15b Missed one 2021-09-22 12:27:39 -07:00
Liz Snyder 2d228a86ca Update client name 2021-09-22 12:26:41 -07:00
Andrew Etter bff43bed13 Merge pull request #181 from piellick/patch-1
change ES_HOME env variable to OPENSEARCH_HOME
2021-09-22 11:47:53 -07:00
piellick 75efdfeae8 change ES_HOME env variable to OPENSEARCH_HOME
env variable looks wrong on "Launch the agent CLI"
2021-09-22 10:57:09 +02:00
aetter 96f94c649e Merge branch 'main' into python-client 2021-09-21 16:40:46 -07:00
aetter 66ca05e714 Update links 2021-09-21 13:56:25 -07:00
aetter 65f333d038 Update python.md 2021-09-21 13:40:38 -07:00
aetter 30378f0076 Sentence case access control page names 2021-09-21 12:34:59 -07:00
aetter 4ffdce6377 Minor improvements
Troubleshooting expired certificates, settings, broken link, etc.
2021-09-21 11:34:44 -07:00
keithhc2 3c98e4b297 Modified monitoring to have two kinds of monitors 2021-09-20 16:06:09 -07:00
ashwinkumar12345 54a0b8e755 minor change 2021-09-20 13:29:58 -07:00
ashwinkumar12345 6bf8a7d51a minor change 2021-09-20 13:27:13 -07:00
ashwinkumar12345 05ba9198f6 modified description 2021-09-20 13:22:18 -07:00
keithhc2 538703d422 Changed transform to rollup 2021-09-17 14:58:07 -07:00
aetter 21ae64aac9 Move to h2 2021-09-17 14:17:21 -07:00
aetter ba9f432622 Fix table 2021-09-16 14:38:01 -07:00
keithhc2 a69440b262 Addressed comments 2021-09-15 13:47:04 -07:00
Keith Chan 35a7b186fc Fixed broken link 2021-09-14 14:03:29 -07:00
Ashwin Kumar 6a36ee4535 Merge pull request #175 from opensearch-project/helm_update
Updated helm project path
2021-09-14 12:31:58 -07:00
ashwinkumar12345 2a0cf500cc updated helm project path 2021-09-14 11:10:11 -07:00
aetter 125585f04e OK fine we can call it a number 2021-09-14 09:10:35 -07:00
aetter ed8230cb02 Update delay to milliseconds, page_size to integer 2021-09-14 09:08:45 -07:00
aetter 50f3fa51d8 Update python.md 2021-09-10 15:01:43 -07:00
Ashwin Kumar 5a1a4cfdef Merge pull request #162 from opensearch-project/count
Added count REST API
2021-09-10 14:25:17 -07:00
ashwinkumar12345 b030194981 incorporated feedback 2021-09-10 14:25:00 -07:00
keithhc2 0b9f197358 Added security to ISM 2021-09-10 11:57:30 -07:00
aetter c507de5b9f Minor wording changes for Beats OSS 2021-09-09 11:22:13 -07:00
aetter 2c713e43ad Update index.md 2021-09-08 10:08:33 -07:00
aetter 243c7315e4 Update generate-certificates.md 2021-09-08 08:34:57 -07:00
Andrew Etter 0fc6a9e057 Merge pull request #165 from opensearch-project/upgrade-tip
Add note about enabling compatibility setting during upgrade
2021-09-07 18:04:15 -07:00
aetter eaba608cfd Update some Dashboards settings paths 2021-09-07 15:28:29 -07:00
Keith Chan b1d3a5906b Language tweaks to create-index 2021-09-01 19:13:23 -07:00
aetter 34068f01bd Add note about enabling compatibility setting during upgrade 2021-09-01 16:29:19 -07:00
aetter ecea83707d Adds Lucene version variable, minor improvements to REST API and query DSL 2021-09-01 11:37:54 -07:00
Andrew Etter f29b04bdb9 Merge pull request #164 from opensearch-project/1.0.1
Version bumps for 1.0.1
2021-09-01 11:27:32 -07:00
aetter cda046f727 Version bumps for 1.0.1 2021-09-01 11:25:39 -07:00
aetter ffe3f77993 Light edits to data streams 2021-08-31 10:50:48 -07:00
aetter 60b1859f1e Remove "About data streams," "Date math support for index names," and "Simulate multi-component templates" 2021-08-31 10:43:48 -07:00
ashwinkumar12345 baa5622f9d minor changes 2021-08-31 10:29:20 -07:00
ashwinkumar12345 dc48c6ced5 added count API 2021-08-30 12:58:30 -07:00
Keith Chan 62611a7605 Merge pull request #161 from opensearch-project/document-rest-apis
Tweaked document REST APIs
2021-08-30 12:46:52 -07:00
Keith Chan 94503ea959 Language tweaks 2021-08-30 11:54:46 -07:00
keithhc2 449177c07e Fixed typos 2021-08-30 11:47:02 -07:00
keithhc2 f464d01041 Revert "Fixed typos"
This reverts commit d941cb6ad7.
2021-08-30 11:44:35 -07:00
keithhc2 36694537f6 Space? 2021-08-30 11:42:52 -07:00
keithhc2 26d3dfe351 Maybe this is the label 2021-08-30 11:42:00 -07:00
keithhc2 7faade1bdf Maybe this can resolve conflicts 2021-08-30 11:38:59 -07:00
keithhc2 5ddabb88bd Fixed heading and styling 2021-08-30 11:35:11 -07:00
keithhc2 edd9d2e313 Fixed even more typos 2021-08-30 11:34:01 -07:00
keithhc2 d941cb6ad7 Fixed typos 2021-08-30 11:32:24 -07:00
keithhc2 17f91f09a3 Language tweaks everywhere 2021-08-30 11:29:19 -07:00
ashwinkumar12345 7aed3bfbf1 updated code to check error message 2021-08-27 14:00:26 -07:00
ashwinkumar12345 fbc0447bcd added more context 2021-08-27 13:20:59 -07:00
aetter 36853b6484 Update external link to Dashboards developer guide 2021-08-27 12:46:55 -07:00
Andrew Etter eaeeb97630 Merge pull request #123 from closingin/feature/add-osd-dev-server-docs
feat: add a link to the developer guide
2021-08-27 12:46:07 -07:00
Andrew Etter dd2d93793a Merge pull request #156 from opensearch-project/ad_shingle_size
Changed window size to shingle size for AD
2021-08-27 12:37:37 -07:00
Andrew Etter 6c5432db1f Merge pull request #157 from opensearch-project/minimal-dashboards-redirects
Some redirects for OpenSearch Dashboards 1.0.0
2021-08-27 09:30:05 -07:00
Liz Snyder 18d3891879 Specify how to turn off cert verification 2021-08-26 15:23:06 -07:00
Liz Snyder e210d7d217 Fix nav order to not conflict with Go 2021-08-26 13:36:12 -07:00
Liz Snyder 51d359ec40 Remove index refresh 2021-08-26 13:34:19 -07:00
Liz Snyder 4d39000cd3 Add command to install specific version 2021-08-26 12:51:04 -07:00
Liz Snyder cea3ba7ce9 Getting started docs for javascript 2021-08-26 12:44:58 -07:00
aetter c972869893 Link to pip, because why not 2021-08-26 11:50:46 -07:00
ashwinkumar12345 1c4f81eb53 minor fix 2021-08-26 11:41:09 -07:00
ashwinkumar12345 bfc56f2f7f incorporated feedback 2021-08-26 11:39:32 -07:00
ashwinkumar12345 9a2e6ed028 spacing 2021-08-26 11:33:21 -07:00
aetter ac9acb3c62 Adds some statements around compatibility
Should (hopefully) apply to all clients.
2021-08-26 09:15:50 -07:00
aetter bdffb128d8 Some redirects for OpenSearch Dashboards 1.0.0 2021-08-25 15:17:51 -07:00
aetter 0376c4b6d9 Fix link. 2021-08-25 14:55:03 -07:00
Andrew Etter ff8cd66090 Merge pull request #155 from ict-one-nl/patch-1
Use same attribute name as cluster page
2021-08-25 14:52:13 -07:00
ashwinkumar12345 12ce7e5fea rough draft 2021-08-25 11:05:24 -07:00
ict-one-nl f3a9bad35c Use same attribute name as cluster page
Simple fix, but because https://opensearch.org/docs/opensearch/cluster/ uses the node.attr.temp setting and this page uses the box_type setting a less experienced user like me easily makes a mistake (not comprehending the exact workings). Using the temp attribute here as well would have saved me a couple of hours and some grey hairs.
2021-08-25 13:54:54 +02:00
aetter 30facfe628 Typo 2021-08-19 14:38:30 -07:00
aetter 9ce5d95786 Clean up spacing 2021-08-19 13:23:14 -07:00
aetter 0bf8624824 Getting started content for Python 2021-08-19 12:56:53 -07:00
closingin 8e3451358b feat: add a link to the developer guide
Signed-off-by: closingin <[email protected]>
2021-08-19 08:47:17 +02:00
Xue Zhou cc64742782 Merge branch 'configuration-env-change' of https://github.com/xuezhou25/documentation-website into configuration-env-change 2021-07-19 23:59:50 -07:00
Xue Zhou 305266b1dc “configuration-change”
Signed-off-by: Xue Zhou <[email protected]>
2021-07-19 23:57:13 -07:00
Xue Zhou d31b21082d Update configuration.md 2021-07-19 23:16:03 -07:00
111 changed files with 6095 additions and 2323 deletions
+4 -4
View File
@@ -196,17 +196,17 @@ If you're making major changes to the documentation and need to see the rendered
## New releases ## New releases
1. Branch. 1. Branch.
1. Change the `opensearch_version` and `opensearch_major_version` variables in `_config.yml`. 1. Change the `opensearch_version`, `opensearch_major_minor_version`, and `lucene_version` variables in `_config.yml`.
1. Start up a new cluster using the updated Docker Compose file in `docs/install/docker.md`. 1. Start up a new cluster using the updated Docker Compose file in `docs/install/docker.md`.
1. Update the version table in `version-history.md`. 1. Update the version table in `version-history.md`.
Use `curl -XGET https://localhost:9200 -u admin:admin -k` to verify the OpenSearch version. Use `curl -XGET https://localhost:9200 -u admin:admin -k` to verify the OpenSearch and Lucene versions.
1. Update the plugin compatibility table in `docs/install/plugin.md`. 1. Update the plugin compatibility table in `_opensearch/install/plugin.md`.
Use `curl -XGET https://localhost:9200/_cat/plugins -u admin:admin -k` to get the correct version strings. Use `curl -XGET https://localhost:9200/_cat/plugins -u admin:admin -k` to get the correct version strings.
1. Update the plugin compatibility table in `docs/opensearch-dashboards/plugins.md`. 1. Update the plugin compatibility table in `_dashboards/install/plugins.md`.
Use `docker ps` to find the ID for the OpenSearch Dashboards node. Then use `docker exec -it <opensearch-dashboards-node-id> /bin/bash` to get shell access. Finally, run `./bin/opensearch-dashboards-plugin list` to get the plugins and version strings. Use `docker ps` to find the ID for the OpenSearch Dashboards node. Then use `docker exec -it <opensearch-dashboards-node-id> /bin/bash` to get shell access. Finally, run `./bin/opensearch-dashboards-plugin list` to get the plugins and version strings.
+8 -2
View File
@@ -27,12 +27,18 @@ PUT _cluster/settings
} }
``` ```
[Just like any other setting]({{site.url}}{{site.baseurl}}/opensearch/configuration/), the alternative is to add the following line to `opensearch.yml` on each node and then restart the node:
```yml
compatibility.override_main_response_version: true
```
## Downloads ## Downloads
You can download the OpenSearch output plugin for Logstash from [OpenSearch downloads](https://opensearch.org/downloads.html). The Logstash output plugin is compatible with OpenSearch and Elasticsearch OSS (7.10.2 or lower). You can download the OpenSearch output plugin for Logstash from [OpenSearch downloads](https://opensearch.org/downloads.html). The Logstash output plugin is compatible with OpenSearch and Elasticsearch OSS (7.10.2 or lower).
These versions of Beats offer the best compatibility with OpenSearch. For more information, see the [compatibility matrices](#compatibility-matrices). These are the latest versions of Beats OSS with OpenSearch compatibility. For more information, see the [compatibility matrices](#compatibility-matrices).
- [Filebeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/filebeat-oss-7-12-1) - [Filebeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/filebeat-oss-7-12-1)
- [Metricbeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/metricbeat-oss-7-12-1) - [Metricbeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/metricbeat-oss-7-12-1)
@@ -41,7 +47,7 @@ These versions of Beats offer the best compatibility with OpenSearch. For more i
- [Winlogbeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/winlogbeat-oss-7-12-1) - [Winlogbeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/winlogbeat-oss-7-12-1)
- [Auditbeat OSS 7.12.1](https://elastic.co/downloads/past-releases/auditbeat-oss-7-12-1) - [Auditbeat OSS 7.12.1](https://elastic.co/downloads/past-releases/auditbeat-oss-7-12-1)
Some users report compatibility issues with ingest pipelines on these versions of Beats. If you use ingest pipelines with OpenSearch, consider using the 7.10.2 versions of Beats OSS instead. Some users report compatibility issues with ingest pipelines on these versions of Beats. If you use ingest pipelines with OpenSearch, consider using the 7.10.2 versions of Beats instead.
{: .note } {: .note }
+145
View File
@@ -0,0 +1,145 @@
---
layout: default
title: Go client
nav_order: 80
---
# Go client
The OpenSearch Go client lets you connect your Go application with the data in your OpenSearch cluster.
## Setup
If you're creating a new project:
```go
go mod init
```
To add the client to your project, import it like any other module:
```go
go get github.com/opensearch-project/opensearch-go
```
## Sample code
This sample code creates a client, adds an index with non-default settings, inserts a document, searches for the document, deletes the document, and finally deletes the index:
```go
package main
import (
"os"
"context"
"crypto/tls"
"fmt"
opensearch "github.com/opensearch-project/opensearch-go"
opensearchapi "github.com/opensearch-project/opensearch-go/opensearchapi"
"net/http"
"strings"
)
const IndexName = "go-test-index1"
func main() {
// Initialize the client with SSL/TLS enabled.
client, err := opensearch.NewClient(opensearch.Config{
Transport: &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
},
Addresses: []string{"https://localhost:9200"},
Username: "admin", // For testing only. Don't store credentials in code.
Password: "admin",
})
if err != nil {
fmt.Println("cannot initialize", err)
os.Exit(1)
}
// Print OpenSearch version information on console.
fmt.Println(client.Info())
// Define index mapping.
mapping := strings.NewReader(`{
'settings': {
'index': {
'number_of_shards': 4
}
}
}`)
// Create an index with non-default settings.
res := opensearchapi.CreateRequest{
Index: IndexName,
Body: mapping,
}
fmt.Println("creating index", res)
// Add a document to the index.
document := strings.NewReader(`{
"title": "Moneyball",
"director": "Bennett Miller",
"year": "2011"
}`)
docId := "1"
req := opensearchapi.IndexRequest{
Index: IndexName,
DocumentID: docId,
Body: document,
}
insertResponse, err := req.Do(context.Background(), client)
if err != nil {
fmt.Println("failed to insert document ", err)
os.Exit(1)
}
fmt.Println(insertResponse)
// Search for the document.
content := strings.NewReader(`{
"size": 5,
"query": {
"multi_match": {
"query": "miller",
"fields": ["title^2", "director"]
}
}
}`)
search := opensearchapi.SearchRequest{
Body: content,
}
searchResponse, err := search.Do(context.Background(), client)
if err != nil {
fmt.Println("failed to search document ", err)
os.Exit(1)
}
fmt.Println(searchResponse)
// Delete the document.
delete := opensearchapi.DeleteRequest{
Index: IndexName,
DocumentID: docId,
}
deleteResponse, err := delete.Do(context.Background(), client)
if err != nil {
fmt.Println("failed to delete document ", err)
os.Exit(1)
}
fmt.Println("deleting document")
fmt.Println(deleteResponse)
// Delete previously created index.
deleteIndex := opensearchapi.IndicesDeleteRequest{
Index: []string{IndexName},
}
deleteIndexResponse, err := deleteIndex.Do(context.Background(), client)
if err != nil {
fmt.Println("failed to delete index ", err)
os.Exit(1)
}
fmt.Println("deleting index", deleteIndexResponse)
}
```
+10
View File
@@ -0,0 +1,10 @@
---
layout: default
title: Grafana
nav_order: 150
has_children: false
---
# Grafana support
Grafana has a data source plugin that lets you explore and visualize your OpenSearch data. For information on getting started with the plugin, see the [Grafana overview page](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/).
+15 -1
View File
@@ -9,6 +9,20 @@ redirect_from:
# OpenSearch client compatibility # OpenSearch client compatibility
OpenSearch provides clients for several popular programming languages, with more coming. In general, clients are compatible with clusters running the same major version of OpenSearch (`major.minor.patch`).
For example, a 1.0.0 client works with an OpenSearch 1.1.0 cluster, but might not support any non-breaking API changes in OpenSearch 1.1.0. A 1.2.0 client works with the same cluster, but might allow you to pass unsupported options in certain functions. We recommend using the same version for both, but if your tests pass after a cluster upgrade, you don't necessarily need to upgrade your clients immediately.
{% comment %}
* [OpenSearch Java client]({{site.url}}{{site.baseurl}}/clients/java/)
{% endcomment %}
* [OpenSearch Python client]({{site.url}}{{site.baseurl}}/clients/python/)
* [OpenSearch JavaScript (Node.js) client]({{site.url}}{{site.baseurl}}/clients/javascript/)
* [OpenSearch Go client]({{site.url}}{{site.baseurl}}/clients/go/)
## Legacy clients
Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch. Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch.
Client | Recommended version Client | Recommended version
@@ -18,7 +32,7 @@ Client | Recommended version
[Python Elasticsearch client](https://pypi.org/project/elasticsearch/7.13.4/) | 7.13.4 [Python Elasticsearch client](https://pypi.org/project/elasticsearch/7.13.4/) | 7.13.4
[Elasticsearch Node.js client](https://www.npmjs.com/package/@elastic/elasticsearch/v/7.13.0) | 7.13.0 [Elasticsearch Node.js client](https://www.npmjs.com/package/@elastic/elasticsearch/v/7.13.0) | 7.13.0
Clients exist for a wide variety of languages, so if you test a client and verify that it works, please [submit a PR](https://github.com/opensearch-project/documentation-website/pulls) and add it to this table. If you test a legacy client and verify that it works, please [submit a PR](https://github.com/opensearch-project/documentation-website/pulls) and add it to this table.
{% comment %} {% comment %}
+36 -27
View File
@@ -1,28 +1,28 @@
--- ---
layout: default layout: default
title: Java high-level REST client title: OpenSearch Java high-level REST client
nav_order: 97 nav_order: 60
--- ---
# Java high-level REST client # OpenSearch Java high-level REST client
The Elasticsearch OSS Java high-level REST client allows you to interact with your OpenSearch clusters and indices through Java methods and data structures rather than HTTP methods and JSON. The OpenSearch Java high-level REST client allows you to interact with your OpenSearch clusters and indices through Java methods and data structures rather than HTTP methods and JSON.
You submit requests to your cluster using request objects, which allows you to create indices, add data to documents, or complete other operations with your cluster. In return, you get back response objects that have all of the available information, such as the associated index or ID, from your cluster. You submit requests to your cluster using request objects, which allows you to create indices, add data to documents, or complete other operations with your cluster. In return, you get back response objects that have all of the available information, such as the associated index or ID, from your cluster.
## Setup ## Setup
To start using the Elasticsearch OSS Java high-level REST client, ensure that you have the following dependency in your project's `pom.xml` file: To start using the OpenSearch Java high-level REST client, ensure that you have the following dependency in your project's `pom.xml` file:
``` ```
<dependency> <dependency>
<groupId>org.elasticsearch.client</groupId> <groupId>org.opensearch.client</groupId>
<artifactId>elasticsearch-rest-high-level-client</artifactId> <artifactId>opensearch-rest-high-level-client</artifactId>
<version>7.10.2</version> <version>1.1.0</version>
</dependency> </dependency>
``` ```
You can now start your OpenSearch cluster. The 7.10.2 high-level REST client works with the 1.x versions of OpenSearch. You can now start your OpenSearch cluster. The OpenSearch 1.x high-level REST client works with the 1.x versions of OpenSearch.
## Sample code ## Sample code
@@ -33,22 +33,21 @@ import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.CredentialsProvider; import org.apache.http.client.CredentialsProvider;
import org.apache.http.impl.client.BasicCredentialsProvider; import org.apache.http.impl.client.BasicCredentialsProvider;
import org.apache.http.impl.nio.client.HttpAsyncClientBuilder; import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest; import org.opensearch.action.admin.indices.delete.DeleteIndexRequest;
import org.elasticsearch.action.delete.DeleteRequest; import org.opensearch.action.delete.DeleteRequest;
import org.elasticsearch.action.delete.DeleteResponse; import org.opensearch.action.delete.DeleteResponse;
import org.elasticsearch.action.get.GetRequest; import org.opensearch.action.get.GetRequest;
import org.elasticsearch.action.get.GetResponse; import org.opensearch.action.get.GetResponse;
import org.elasticsearch.action.index.IndexRequest; import org.opensearch.action.index.IndexRequest;
import org.elasticsearch.action.index.IndexResponse; import org.opensearch.action.index.IndexResponse;
import org.elasticsearch.action.support.master.AcknowledgedResponse; import org.opensearch.action.support.master.AcknowledgedResponse;
import org.elasticsearch.client.RequestOptions; import org.opensearch.client.RequestOptions;
import org.elasticsearch.client.RestClient; import org.opensearch.client.RestClient;
import org.elasticsearch.client.RestClientBuilder; import org.opensearch.client.RestClientBuilder;
import org.elasticsearch.client.RestHighLevelClient; import org.opensearch.client.RestHighLevelClient;
import org.elasticsearch.client.indices.CreateIndexRequest; import org.opensearch.client.indices.CreateIndexRequest;
import org.elasticsearch.client.indices.CreateIndexResponse; import org.opensearch.client.indices.CreateIndexResponse;
import org.elasticsearch.common.settings.Settings; import org.opensearch.common.settings.Settings;
import org.elasticsearch.common.xcontent.XContentType;
import java.io.IOException; import java.io.IOException;
import java.util.HashMap; import java.util.HashMap;
@@ -59,7 +58,7 @@ public class RESTClientSample {
//Point to keystore with appropriate certificates for security. //Point to keystore with appropriate certificates for security.
System.setProperty("javax.net.ssl.trustStore", "/full/path/to/keystore"); System.setProperty("javax.net.ssl.trustStore", "/full/path/to/keystore");
System.setProperty("javax.net.ssl.trustStorePassword", password-to-keystore); System.setProperty("javax.net.ssl.trustStorePassword", "password-to-keystore");
//Establish credentials to use basic authentication. //Establish credentials to use basic authentication.
//Only for demo purposes. Do not specify your credentials in code. //Only for demo purposes. Do not specify your credentials in code.
@@ -93,7 +92,7 @@ public class RESTClientSample {
HashMap<String, Object> mapping = new HashMap<String, Object>(); HashMap<String, Object> mapping = new HashMap<String, Object>();
mapping.put("properties", ageMapping); mapping.put("properties", ageMapping);
createIndexRequest.mapping(mapping); createIndexRequest.mapping(mapping);
CreateIndexResponse createIndexResponse = client.indices().create(createIndexRequest, RequestOptions.DEFAULT CreateIndexResponse createIndexResponse = client.indices().create(createIndexRequest, RequestOptions.DEFAULT);
//Adding data to the index. //Adding data to the index.
IndexRequest request = new IndexRequest("custom-index"); //Add a document to the custom-index we created. IndexRequest request = new IndexRequest("custom-index"); //Add a document to the custom-index we created.
@@ -122,3 +121,13 @@ public class RESTClientSample {
} }
} }
``` ```
## Elasticsearch OSS Java high-level REST client
We recommend using the OpenSearch client to connect to OpenSearch clusters, but if you must use the Elasticsearch OSS Java high-level REST client, version 7.10.2 of the Elasticsearch OSS client also works with the 1.x versions of OpenSearch.
### Migrating to the OpenSearch Java high-level REST client
Migrating from the Elasticsearch OSS client to the OpenSearch high-level REST client is as simple as changing your Maven dependency to one that references [OpenSearch's dependency](#setup).
Afterward, change all references of `org.elasticsearch` to `org.opensearch`, and you're ready to start submitting requests to your OpenSearch cluster.
+141
View File
@@ -0,0 +1,141 @@
---
layout: default
title: JavaScript client
nav_order: 90
---
# JavaScript client
The OpenSearch JavaScript client provides a safer and easier way to interact with your OpenSearch cluster. Rather than using OpenSearch from the browser and potentially exposing your data to the public, you can build an OpenSearch client that takes care of sending requests to your cluster.
The client contains a library of APIs that let you perform different operations on your cluster and return a standard response body. The example here demonstrates some basic operations like creating an index, adding documents, and searching your data.
## Setup
To add the client to your project, install it from [npm](https://www.npmjs.com):
```bash
npm install @opensearch-project/opensearch
```
To install a specific major version of the client, run the following command:
```bash
npm install @opensearch-project/opensearch@<version>
```
If you prefer to add the client manually or just want to examine the source code, see [opensearch-js](https://github.com/opensearch-project/opensearch-js) on GitHub.
Then require the client:
```javascript
const { Client } = require("@opensearch-project/opensearch");
```
## Sample code
```javascript
"use strict";
var host = "localhost";
var protocol = "https";
var port = 9200;
var auth = "admin:admin"; // For testing only. Don't store credentials in code.
var ca_certs_path = "/full/path/to/root-ca.pem";
// Optional client certificates if you don't want to use HTTP basic authentication.
// var client_cert_path = '/full/path/to/client.pem'
// var client_key_path = '/full/path/to/client-key.pem'
// Create a client with SSL/TLS enabled.
var { Client } = require("@opensearch-project/opensearch");
var fs = require("fs");
var client = new Client({
node: protocol + "://" + auth + "@" + host + ":" + port,
ssl: {
ca: fs.readFileSync(ca_certs_path),
// You can turn off certificate verification (rejectUnauthorized: false) if you're using self-signed certificates with a hostname mismatch.
// cert: fs.readFileSync(client_cert_path),
// key: fs.readFileSync(client_key_path)
},
});
async function search() {
// Create an index with non-default settings.
var index_name = "books";
var settings = {
settings: {
index: {
number_of_shards: 4,
number_of_replicas: 3,
},
},
};
var response = await client.indices.create({
index: index_name,
body: settings,
});
console.log("Creating index:");
console.log(response.body);
// Add a document to the index.
var document = {
title: "The Outsider",
author: "Stephen King",
year: "2018",
genre: "Crime fiction",
};
var id = "1";
var response = await client.index({
id: id,
index: index_name,
body: document,
refresh: true,
});
console.log("Adding document:");
console.log(response.body);
// Search for the document.
var query = {
query: {
match: {
title: {
query: "The Outsider",
},
},
},
};
var response = await client.search({
index: index_name,
body: query,
});
console.log("Search results:");
console.log(response.body.hits);
// Delete the document.
var response = await client.delete({
index: index_name,
id: id,
});
console.log("Deleting document:");
console.log(response.body);
// Delete the index.
var response = await client.indices.delete({
index: index_name,
});
console.log("Deleting index:");
console.log(response.body);
}
search().catch(console.log);
```
+3
View File
@@ -57,6 +57,9 @@ The OpenSearch Logstash plugin has two installation options at this time: Linux
Make sure you have [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/javase-downloads.html) version 8 or 11 installed. Make sure you have [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/javase-downloads.html) version 8 or 11 installed.
If you're migrating from an existing Logstash installation, you can install the [OpenSearch output plugin](https://rubygems.org/gems/logstash-output-opensearch/) manually and [update pipeline.conf](https://opensearch.org/docs/latest/clients/logstash/ship-to-opensearch/). We include this plugin by default in our tarball and Docker downloads.
{: .note }
### Tarball ### Tarball
1. Download the Logstash tarball from [OpenSearch downloads](https://opensearch.org/downloads.html). 1. Download the Logstash tarball from [OpenSearch downloads](https://opensearch.org/downloads.html).
+128
View File
@@ -0,0 +1,128 @@
---
layout: default
title: Python client
nav_order: 70
---
# Python client
The OpenSearch Python client provides a more natural syntax for interacting with your cluster. Rather than sending HTTP requests to a given URL, you can create an OpenSearch client for your cluster and call the client's built-in functions.
{% comment %}
`opensearch-py` is the lower-level of the two Python clients. If you want a general client for assorted operations, it's a great choice. If you want a higher-level client strictly for indexing and search operations, consider [opensearch-dsl-py]({{site.url}}{{site.baseurl}}/clients/python-dsl/).
{% endcomment %}
## Setup
To add the client to your project, install it using [pip](https://pip.pypa.io/):
```bash
pip install opensearch-py
```
Then import it like any other module:
```python
from opensearchpy import OpenSearch
```
If you prefer to add the client manually or just want to examine the source code, see [opensearch-py on GitHub](https://github.com/opensearch-project/opensearch-py).
## Sample code
```python
from opensearchpy import OpenSearch
host = 'localhost'
port = 9200
auth = ('admin', 'admin') # For testing only. Don't store credentials in code.
ca_certs_path = '/full/path/to/root-ca.pem' # Provide a CA bundle if you use intermediate CAs with your root CA.
# Optional client certificates if you don't want to use HTTP basic authentication.
# client_cert_path = '/full/path/to/client.pem'
# client_key_path = '/full/path/to/client-key.pem'
# Create the client with SSL/TLS enabled, but hostname verification disabled.
client = OpenSearch(
hosts = [{'host': host, 'port': port}],
http_compress = True, # enables gzip compression for request bodies
http_auth = auth,
# client_cert = client_cert_path,
# client_key = client_key_path,
use_ssl = True,
verify_certs = True,
ssl_assert_hostname = False,
ssl_show_warn = False,
ca_certs = ca_certs_path
)
# Create an index with non-default settings.
index_name = 'python-test-index'
index_body = {
'settings': {
'index': {
'number_of_shards': 4
}
}
}
response = client.indices.create(index_name, body=index_body)
print('\nCreating index:')
print(response)
# Add a document to the index.
document = {
'title': 'Moneyball',
'director': 'Bennett Miller',
'year': '2011'
}
id = '1'
response = client.index(
index = index_name,
body = document,
id = id,
refresh = True
)
print('\nAdding document:')
print(response)
# Search for the document.
q = 'miller'
query = {
'size': 5,
'query': {
'multi_match': {
'query': q,
'fields': ['title^2', 'director']
}
}
}
response = client.search(
body = query,
index = index_name
)
print('\nSearch results:')
print(response)
# Delete the document.
response = client.delete(
index = index_name,
id = id
)
print('\nDeleting document:')
print(response)
# Delete the index.
response = client.indices.delete(
index = index_name
)
print('\nDeleting index:')
print(response)
```
+10 -3
View File
@@ -1,12 +1,13 @@
title: OpenSearch documentation title: OpenSearch documentation
description: >- # this means to ignore newlines until "baseurl:" description: >- # this means to ignore newlines until "baseurl:"
Documentation for OpenSearch, the Apache 2.0 search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more. Documentation for OpenSearch, the Apache 2.0 search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
baseurl: "/docs" # the subpath of your site, e.g. /blog baseurl: "/docs/latest" # the subpath of your site, e.g. /blog
url: "https://opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com url: "https://opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com
permalink: /:path/ permalink: /:path/
opensearch_version: 1.0.0 opensearch_version: 1.1.0
opensearch_major_minor_version: 1.0 opensearch_major_minor_version: 1.1
lucene_version: 8_9_0
# Build settings # Build settings
markdown: kramdown markdown: kramdown
@@ -44,6 +45,9 @@ collections:
im-plugin: im-plugin:
permalink: /:collection/:path/ permalink: /:collection/:path/
output: true output: true
replication-plugin:
permalink: /:collection/:path/
output: true
monitoring-plugins: monitoring-plugins:
permalink: /:collection/:path/ permalink: /:collection/:path/
output: true output: true
@@ -80,6 +84,9 @@ just_the_docs:
im-plugin: im-plugin:
name: Index management plugin name: Index management plugin
nav_fold: true nav_fold: true
replication-plugin:
name: Replication plugin
nav_fold: true
monitoring-plugins: monitoring-plugins:
name: Monitoring plugins name: Monitoring plugins
nav_fold: true nav_fold: true
+142
View File
@@ -0,0 +1,142 @@
---
layout: default
title: Dashboards query language
nav_order: 99
---
# Dashboards Query Language
Similar to the [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index) that lets you use the HTTP request body to search for data, you can use the Dashbaords Query Language (DQL) in OpenSearch Dashboards to search for data and visualizations.
For example, if you want to see all visualizations of visits to a host based in the US, enter `geo.dest:US` into the search field, and Dashboards refreshes to display all related data.
Just like the query DSL, DQL has a handful of query types, so use whichever best fits your use case.
This section uses the OpenSearch Dashboards sample web log data. To add sample data in Dashboards, log in to OpenSearch Dashboards, choose **Home**, **Add sample data**, and then **Add data**.
---
#### Table of contents
1. TOC
{:toc}
---
## Terms query
The most basic query is to just specify the term you're searching for.
```
host:www.example.com
```
To access an object's nested field, list the complete path to the field separated by periods. For example, to retrieve the `lat` field in the `coordinates` object:
```
coordinates.lat:43.7102
```
DQL also supports leading and trailing wildcards, so you can search for any terms that match your pattern.
```
host.keyword:*.example.com/*
```
To check if a field exists or has any data, use a wildcard to see if Dashboards returns any results.
```
host.keyword:*
```
## Boolean query
To mix and match, or even combine, multiple queries for more refined results, you can use the boolean operators `and`, `or`, and `not`. DQL is not case sensitive, so `AND` and `and` are the same.
```
host.keyword:www.example.com and response.keyword:200
```
The following example demonstrates how to use multiple operators in one query.
```
geo.dest:US or response.keyword:200 and host.keyword:www.example.com
```
Remember that boolean operators follow the logical precedence order of `not`, `and`, and `or`, so if you have an expression like the previous example, `response.keyword:200 and host.keyword:www.example.com` gets evaluated first, and then Dashboards uses that result to compare with `geo.dest:US`.
To avoid confusion, we recommend using parentheses to dictate the order you want to evaluate in. If you want to evaluate `geo.dest:US or response.keyword:200` first, your expression becomes:
```
(geo.dest:US or response.keyword:200) and host.keyword:www.example.com
```
## Date and range queries
DQL also supports inequalities if you're using numeric inequalities.
```
bytes >= 15 and memory < 15
```
Similarly, you can use the same method to find a date before or after your query. `>` indicates a search for a date after your specified date, and `<` returns dates before.
```
@timestamp > "2020-12-14T09:35:33"
```
## Nested field query
If you have a document with nested fields, you have to specify which parts of the document you want to retrieve.
Suppose that you have the following document:
```json
{
"superheroes":[
{
"hero-name": "Superman",
"real-identity": "Clark Kent",
"age": 28
},
{
"hero-name": "Batman",
"real-identity": "Bruce Wayne",
"age": 26
},
{
"hero-name": "Flash",
"real-identity": "Barry Allen",
"age": 28
},
{
"hero-name": "Robin",
"real-identity": "Dick Grayson",
"age": 15
}
]
}
```
The following example demonstrates how to use DQL to retrieve a specific field.
```
superheroes: {hero-name: Superman}
```
If you want to retrieve multiple objects from your document, just specify all of the fields you want to retrieve.
```
superheroes: {hero-name: Superman} and superheroes: {hero-name: Batman}
```
The previous boolean and range queries still work, so you can submit a more refined query.
```
superheroes: {hero-name: Superman and age < 50}
```
If your document has an object nested within another object, you can still retrieve data by specifying all of the levels.
```
justice-league.superheroes: {hero-name:Superman}
```
+3
View File
@@ -5,9 +5,12 @@ nav_order: 1
has_children: false has_children: false
has_toc: false has_toc: false
redirect_from: redirect_from:
- /docs/opensearch-dashboards/
- /dashboards/ - /dashboards/
--- ---
{%- comment -%}The `/docs/opensearch-dashboards/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
# OpenSearch Dashboards # OpenSearch Dashboards
OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for many of the OpenSearch plugins, including security, alerting, Index State Management, SQL, and more. OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for many of the OpenSearch plugins, including security, alerting, Index State Management, SQL, and more.
+1 -1
View File
@@ -20,7 +20,7 @@ Resource | Description
The specification in the default Helm chart supports many standard use cases and setups. You can modify the default chart to configure your desired specifications and set Transport Layer Security (TLS) and role-based access control (RBAC). The specification in the default Helm chart supports many standard use cases and setups. You can modify the default chart to configure your desired specifications and set Transport Layer Security (TLS) and role-based access control (RBAC).
For information about the default configuration, steps to configure security, and configurable parameters, see the For information about the default configuration, steps to configure security, and configurable parameters, see the
[README](https://github.com/opensearch-project/opensearch-devops/blob/main/Helm/README.md). [README](https://github.com/opensearch-project/helm-charts/tree/main/charts).
The instructions here assume you have a Kubernetes cluster with Helm preinstalled. See the [Kubernetes documentation](https://kubernetes.io/docs/setup/) for steps to configure a Kubernetes cluster and the [Helm documentation](https://helm.sh/docs/intro/install/) to install Helm. The instructions here assume you have a Kubernetes cluster with Helm preinstalled. See the [Kubernetes documentation](https://kubernetes.io/docs/setup/) for steps to configure a Kubernetes cluster and the [Helm documentation](https://helm.sh/docs/intro/install/) to install Helm.
{: .note } {: .note }
+30 -30
View File
@@ -28,6 +28,36 @@ If you don't want to use the all-in-one installation options, you can install th
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr>
<td>1.1.0</td>
<td>
<pre>alertingDashboards 1.1.0.0
anomalyDetectionDashboards 1.1.0.0
ganttChartDashboards 1.1.0.0
indexManagementDashboards 1.1.0.0
notebooksDashboards 1.1.0.0
queryWorkbenchDashboards 1.1.0.0
reportsDashboards 1.1.0.0
securityDashboards 1.1.0.0
traceAnalyticsDashboards 1.1.0.0
</pre>
</td>
</tr>
<tr>
<td>1.0.1</td>
<td>
<pre>alertingDashboards 1.0.0.0
anomalyDetectionDashboards 1.0.0.0
ganttChartDashboards 1.0.0.0
indexManagementDashboards 1.0.1.0
notebooksDashboards 1.0.0.0
queryWorkbenchDashboards 1.0.0.0
reportsDashboards 1.0.1.0
securityDashboards 1.0.1.0
traceAnalyticsDashboards 1.0.0.0
</pre>
</td>
</tr>
<tr> <tr>
<td>1.0.0</td> <td>1.0.0</td>
<td> <td>
@@ -40,36 +70,6 @@ queryWorkbenchDashboards 1.0.0.0
reportsDashboards 1.0.0.0 reportsDashboards 1.0.0.0
securityDashboards 1.0.0.0 securityDashboards 1.0.0.0
traceAnalyticsDashboards 1.0.0.0 traceAnalyticsDashboards 1.0.0.0
</pre>
</td>
</tr>
<tr>
<td>1.0.0-rc1</td>
<td>
<pre>alertingDashboards 1.0.0.0-rc1
anomalyDetectionDashboards 1.0.0.0-rc1
ganttChartDashboards 1.0.0.0-rc1
indexManagementDashboards 1.0.0.0-rc1
notebooksDashboards 1.0.0.0-rc1
queryWorkbenchDashboards 1.0.0.0-rc1
reportsDashboards 1.0.0.0-rc1
securityDashboards 1.0.0.0-rc1
traceAnalyticsDashboards 1.0.0.0-rc1
</pre>
</td>
</tr>
<tr>
<td>1.0.0-beta1</td>
<td>
<pre>alertingDashboards 1.0.0.0-beta1
anomalyDetectionDashboards 1.0.0.0-beta1
ganttChartDashboards 1.0.0.0-beta1
indexManagementDashboards 1.0.0.0-beta1
notebooksDashboards 1.0.0.0-beta1
queryWorkbenchDashboards 1.0.0.0-beta1
reportsDashboards 1.0.0.0-beta1
securityDashboards 1.0.0.0-beta1
traceAnalyticsDashboards 1.0.0.0-beta1
</pre> </pre>
</td> </td>
</tr> </tr>
+3 -4
View File
@@ -14,9 +14,10 @@ nav_order: 30
```bash ```bash
# x64 # x64
tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz
cd opensearch-dashboards{% comment %}# ARM64 cd opensearch-dashboards
# ARM64
tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz
cd opensearch-dashboards{% endcomment %} cd opensearch-dashboards
``` ```
1. If desired, modify `config/opensearch_dashboards.yml`. 1. If desired, modify `config/opensearch_dashboards.yml`.
@@ -26,5 +27,3 @@ nav_order: 30
```bash ```bash
./bin/opensearch-dashboards ./bin/opensearch-dashboards
``` ```
1. See the [OpenSearch Dashboards documentation]({{site.url}}{{site.baseurl}}/dashboards/index/).
+4
View File
@@ -2,8 +2,12 @@
layout: default layout: default
title: WMS map server title: WMS map server
nav_order: 5 nav_order: 5
redirect_from:
- /docs/opensearch-dashboards/maptiles/
--- ---
{%- comment -%}The `/docs/opensearch-dashboards/maptiles/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
# Configure WMS map server # Configure WMS map server
OpenSearch Dashboards includes default map tiles, but if you need more specialized maps, you can configure OpenSearch Dashboards to use a WMS map server: OpenSearch Dashboards includes default map tiles, but if you need more specialized maps, you can configure OpenSearch Dashboards to use a WMS map server:
-1
View File
@@ -1 +0,0 @@
message: "🔥 [OpenSearch 1.0 released on July 12th! Get it now!](/downloads.html)"
+1
View File
@@ -0,0 +1 @@
message: "🌡️ [OpenSearch 1.1.0 arrived October 5 with cross-cluster replication, bucket-level alerting, and much, much more. Grab it here!](/downloads.html)"
+6
View File
@@ -0,0 +1,6 @@
{
"current": "1.1",
"past": [
"1.0"
]
}
+7
View File
@@ -0,0 +1,7 @@
---
layout: default
title: Dashboards developer guide
nav_order: 2
permalink: /dashboards-developer-guide/
redirect_to: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md
---
+30 -30
View File
@@ -90,36 +90,36 @@ You can specify the following options.
Options | Description | Type | Required Options | Description | Type | Required
:--- | :--- |:--- |:--- | :--- | :--- |:--- |:--- |
`source_index` | The name of the detector. | `string` | Yes `source_index` | The name of the detector. | String | Yes
`target_index` | Specify the target index that the rolled up data is ingested into. You could either create a new target index or use an existing index. The target index cannot be a combination of raw and rolled up data. | `string` | Yes `target_index` | Specify the target index that the rolled up data is ingested into. You could either create a new target index or use an existing index. The target index cannot be a combination of raw and rolled up data. | String | Yes
`schedule` | Schedule of the index rollup job which can be an interval or a cron expression. | `object` | Yes `schedule` | Schedule of the index rollup job which can be an interval or a cron expression. | Object | Yes
`schedule.interval` | Specify the frequency of execution of the rollup job. | `object` | No `schedule.interval` | Specify the frequency of execution of the rollup job. | Object | No
`schedule.interval.start_time` | Start time of the interval. | `timestamp` | Yes `schedule.interval.start_time` | Start time of the interval. | Timestamp | Yes
`schedule.interval.period` | Define the interval period. | `string` | Yes `schedule.interval.period` | Define the interval period. | String | Yes
`schedule.interval.unit` | Specify the time unit of the interval. | `string` | Yes `schedule.interval.unit` | Specify the time unit of the interval. | String | Yes
`schedule.interval.cron` | Optionally, specify a cron expression to define therollup frequency. | `list` | No `schedule.interval.cron` | Optionally, specify a cron expression to define therollup frequency. | List | No
`schedule.interval.cron.expression` | Specify a Unix cron expression. | `string` | Yes `schedule.interval.cron.expression` | Specify a Unix cron expression. | String | Yes
`schedule.interval.cron.timezone` | Specify timezones as defined by the IANA Time Zone Database. Defaults to UTC. | `string` | No `schedule.interval.cron.timezone` | Specify timezones as defined by the IANA Time Zone Database. Defaults to UTC. | String | No
`description` | Optionally, describe the rollup job. | `string` | No `description` | Optionally, describe the rollup job. | String | No
`enabled` | When true, the index rollup job is scheduled. Default is true. | `boolean` | Yes `enabled` | When true, the index rollup job is scheduled. Default is true. | Boolean | Yes
`continuous` | Specify whether or not the index rollup job continuously rolls up data forever or just executes over the current data set once and stops. Default is false. | `boolean` | Yes `continuous` | Specify whether or not the index rollup job continuously rolls up data forever or just executes over the current data set once and stops. Default is false. | Boolean | Yes
`error_notification` | Set up a Mustache message template sent for error notifications. For example, if an index rollup job fails, the system sends a message to a Slack channel. | `object` | No `error_notification` | Set up a Mustache message template sent for error notifications. For example, if an index rollup job fails, the system sends a message to a Slack channel. | Object | No
`page_size` | Specify the number of buckets to paginate through at a time while rolling up. | `number` | Yes `page_size` | Specify the number of buckets to paginate through at a time while rolling up. | Number | Yes
`delay` | Specify time value to delay execution of the index rollup job. | `time_unit` | No `delay` | The number of milliseconds to delay execution of the index rollup job. | Long | No
`dimensions` | Specify aggregations to create dimensions for the roll up time window. | `object` | Yes `dimensions` | Specify aggregations to create dimensions for the roll up time window. | Object | Yes
`dimensions.date_histogram` | Specify either fixed_interval or calendar_interval, but not both. Either one limits what you can query in the target index. | `object` | No `dimensions.date_histogram` | Specify either fixed_interval or calendar_interval, but not both. Either one limits what you can query in the target index. | Object | No
`dimensions.date_histogram.fixed_interval` | Specify the fixed interval for aggregations in milliseconds, seconds, minutes, hours, or days. | `string` | No `dimensions.date_histogram.fixed_interval` | Specify the fixed interval for aggregations in milliseconds, seconds, minutes, hours, or days. | String | No
`dimensions.date_histogram.calendar_interval` | Specify the calendar interval for aggregations in minutes, hours, days, weeks, months, quarters, or years. | `string` | No `dimensions.date_histogram.calendar_interval` | Specify the calendar interval for aggregations in minutes, hours, days, weeks, months, quarters, or years. | String | No
`dimensions.date_histogram.field` | Specify the date field used in date histogram aggregation. | `string` | No `dimensions.date_histogram.field` | Specify the date field used in date histogram aggregation. | String | No
`dimensions.date_histogram.timezone` | Specify the timezones as defined by the IANA Time Zone Database. The default is UTC. | `string` | No `dimensions.date_histogram.timezone` | Specify the timezones as defined by the IANA Time Zone Database. The default is UTC. | String | No
`dimensions.terms` | Specify the term aggregations that you want to roll up. | `object` | No `dimensions.terms` | Specify the term aggregations that you want to roll up. | Object | No
`dimensions.terms.fields` | Specify terms aggregation for compatible fields. | `object` | No `dimensions.terms.fields` | Specify terms aggregation for compatible fields. | Object | No
`dimensions.histogram` | Specify the histogram aggregations that you want to roll up. | `object` | No `dimensions.histogram` | Specify the histogram aggregations that you want to roll up. | Object | No
`dimensions.histogram.field` | Add a field for histogram aggregations. | `string` | Yes `dimensions.histogram.field` | Add a field for histogram aggregations. | String | Yes
`dimensions.histogram.interval` | Specify the histogram aggregation interval for the field. | `long` | Yes `dimensions.histogram.interval` | Specify the histogram aggregation interval for the field. | Long | Yes
`dimensions.metrics` | Specify a list of objects that represent the fields and metrics that you want to calculate. | `nested object` | No `dimensions.metrics` | Specify a list of objects that represent the fields and metrics that you want to calculate. | Nested object | No
`dimensions.metrics.field` | Specify the field that you want to perform metric aggregations on. | `string` | No `dimensions.metrics.field` | Specify the field that you want to perform metric aggregations on. | String | No
`dimensions.metrics.field.metrics` | Specify the metric aggregations you want to calculate for the field. | `multiple strings` | No `dimensions.metrics.field.metrics` | Specify the metric aggregations you want to calculate for the field. | Multiple strings | No
#### Sample response #### Sample response
+1 -1
View File
@@ -29,7 +29,7 @@ If you don't have any data in your cluster, you can use the sample flight data w
### Step 1: Choose indices ### Step 1: Choose indices
1. In the **Job name and description** section, specify a name and an optional description for your job. 1. In the **Job name and description** section, specify a name and an optional description for your job.
2. In the **Indices** section, select the source and target index. You can either select an existing target index or create a new one by entering a name for your new index. If you want to transform just a subset of your source index, choose **Add Data Filter**, and use the OpenSearch query DSL to specify a subset of your source index. For more information about the OpenSearch query DSL, see [query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/). 2. In the **Indices** section, select the source and target index. You can either select an existing target index or create a new one by entering a name for your new index. If you want to transform just a subset of your source index, choose **Edit data filter**, and use the OpenSearch query DSL to specify a subset of your source index. For more information about the OpenSearch query DSL, see [query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/).
3. Choose **Next**. 3. Choose **Next**.
### Step 2: Select fields to transform ### Step 2: Select fields to transform
+1 -1
View File
@@ -2,7 +2,7 @@
layout: default layout: default
title: ISM API title: ISM API
parent: Index State Management parent: Index State Management
nav_order: 5 nav_order: 20
--- ---
# ISM API # ISM API
+15 -5
View File
@@ -31,14 +31,21 @@ To get started, choose **Index Management** in OpenSearch Dashboards.
A policy is a set of rules that describes how an index should be managed. For information about creating a policy, see [Policies]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/). A policy is a set of rules that describes how an index should be managed. For information about creating a policy, see [Policies]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/).
You can use the JSON editor or visual editor to create policies. Compared to the JSON editor, the visual editor offers a more structured way of defining policies by separating the process into creating error notifications, defining ISM templates, and adding states. We recommend using the visual editor if you want to see pre-defined fields, such as which actions you can assign to a state or under what conditions a state can transition into a destination state.
#### JSON editor
1. Choose the **Index Policies** tab. 1. Choose the **Index Policies** tab.
2. Choose **Create policy**. 2. Choose **Create policy**.
3. In the **Name policy** section, enter a policy ID. 3. Choose **JSON editor**.
4. In the **Define policy** section, enter your policy. 4. In the **Name policy** section, enter a policy ID.
5. Choose **Create**. 5. In the **Define policy** section, enter your policy.
6. Choose **Create**.
After you create a policy, your next step is to attach this policy to an index or indices. After you create a policy, your next step is to attach it to an index or indices.
You can set up an `ism_template` in the policy so when you create an index that matches the ISM template pattern, the index will have this policy attached to it: You can set up an `ism_template` in the policy so when an index that matches the ISM template pattern is created, the plugin automatically attaches the policy to the index.
The following example demonstrates how to create a policy that automatically gets attached to all indices whose names start with `index_name-`.
```json ```json
PUT _plugins/_ism/policies/policy_id PUT _plugins/_ism/policies/policy_id
@@ -55,6 +62,8 @@ PUT _plugins/_ism/policies/policy_id
} }
``` ```
If you have more than one template that matches an index pattern, ISM uses the priority value to determine which template to apply.
For an example ISM template policy, see [Sample policy with ISM template]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#sample-policy-with-ism-template). For an example ISM template policy, see [Sample policy with ISM template]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#sample-policy-with-ism-template).
Older versions of the plugin include the `policy_id` in an index template, so when an index is created that matches the index template pattern, the index will have the policy attached to it: Older versions of the plugin include the `policy_id` in an index template, so when an index is created that matches the index template pattern, the index will have the policy attached to it:
@@ -89,6 +98,7 @@ Make sure that the alias that you enter already exists. For more information abo
After you attach a policy to an index, ISM creates a job that runs every 5 minutes by default to perform policy actions, check conditions, and transition the index into different states. To change the default time interval for this job, see [Settings]({{site.url}}{{site.baseurl}}/im-plugin/ism/settings/). After you attach a policy to an index, ISM creates a job that runs every 5 minutes by default to perform policy actions, check conditions, and transition the index into different states. To change the default time interval for this job, see [Settings]({{site.url}}{{site.baseurl}}/im-plugin/ism/settings/).
ISM does not run jobs if the cluster state is red.
### Step 3: Manage indices ### Step 3: Manage indices
+12 -4
View File
@@ -347,7 +347,7 @@ Parameter | Description | Type | Required | Default
### allocation ### allocation
Allocate the index to a node with a specific attribute. Allocate the index to a node with a specific attribute set [like this]({{site.url}}{{site.baseurl}}/opensearch/cluster/#advanced-step-7-set-up-a-hot-warm-architecture).
For example, setting `require` to `warm` moves your data only to "warm" nodes. For example, setting `require` to `warm` moves your data only to "warm" nodes.
The `allocation` operation has the following parameters: The `allocation` operation has the following parameters:
@@ -363,7 +363,7 @@ Parameter | Description | Type | Required
"actions": [ "actions": [
{ {
"allocation": { "allocation": {
"require": { "box_type": "warm" } "require": { "temp": "warm" }
} }
} }
] ]
@@ -558,9 +558,11 @@ The following sample template policy is for a rollover use case.
PUT _index_template/ism_rollover PUT _index_template/ism_rollover
{ {
"index_patterns": ["log*"], "index_patterns": ["log*"],
"settings": { "template": {
"settings": {
"plugins.index_state_management.rollover_alias": "log" "plugins.index_state_management.rollover_alias": "log"
} }
}
} }
``` ```
@@ -586,6 +588,12 @@ The following sample template policy is for a rollover use case.
} }
``` ```
5. Verify if the policy is attached to the `log-000001` index:
```json
GET _plugins/_ism/explain/log-000001?pretty
```
## Example policy ## Example policy
The following example policy implements a `hot`, `warm`, and `delete` workflow. You can use this policy as a template to prioritize resources to your indices based on their levels of activity. The following example policy implements a `hot`, `warm`, and `delete` workflow. You can use this policy as a template to prioritize resources to your indices based on their levels of activity.
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
layout: default layout: default
title: Refresh search analyzer title: Refresh search analyzer
nav_order: 40 nav_order: 50
has_children: false has_children: false
redirect_from: /im-plugin/refresh-analyzer/ redirect_from: /im-plugin/refresh-analyzer/
has_toc: false has_toc: false
+41
View File
@@ -0,0 +1,41 @@
---
layout: default
title: Index management security
nav_order: 40
has_children: false
---
# Index management security
Using the security plugin with index management lets you limit non-admin users to certain actions. For example, you might want to set up your security such that a group of users can only read ISM policies, while others can create, delete, or change policies.
All index management data are protected as system indices, and only a super admin or an admin with a Transport Layer Security (TLS) certificate can access system indices. For more information, see [System indices]({{site.url}}{{site.baseurl}}/security-plugin/configuration/system-indices).
## Basic permissions
The security plugin comes with one role that offers full access to index management: `index_management_full_access`. For a description of the role's permissions, see [Predefined roles]({{site.url}}{{site.baseurl}}/security-plugin/access-control/users-roles#predefined-roles).
With security enabled, users not only need the correct index management permissions, but they also need permissions to execute actions to involved indices. For example, if a user wants to use the REST API to attach a policy that executes a rollup job to an index named `system-logs`, they would need the permissions to attach a policy and execute a rollup job, as well as access to `system-logs`.
Finally, with the exceptions of Create Policy, Get Policy, and Delete Policy, users also need the `indices:admin/opensearch/ism/managedindex` permission to execute [ISM APIs]({{site.url}}{{site.baseurl}}/im-plugin/ism/api).
## (Advanced) Limit access by backend role
You can use backend roles to configure fine-grained access to index management policies and actions. For example, users of different departments in an organization might view different policies depending on what roles and permissions they are assigned.
First, ensure your users have the appropriate [backend roles]({{site.url}}{{site.baseurl}}/security-plugin/access-control/index/). Backend roles usually come from an [LDAP server]({{site.url}}{{site.baseurl}}/security-plugin/configuration/ldap/) or [SAML provider]({{site.url}}{{site.baseurl}}/security-plugin/configuration/saml/). However, if you use the internal user database, you can use the REST API to [add them manually]({{site.url}}{{site.baseurl}}/security-plugin/access-control/api#create-user).
Use the REST API to enable the following setting:
```json
PUT _cluster/settings
{
"transient": {
"plugins.index_management.filter_by_backend_roles": "true"
}
}
```
With security enabled, only users who share at least one backend role can see and execute the policies and actions relevant to their roles.
For example, consider a scenario with three users: `John` and `Jill`, who have the backend role `helpdesk_staff`, and `Jane`, who has the backend role `phone_operator`. `John` wants to create a policy that performs a rollup job on an index named `airline_data`, so `John` would need a backend role that has permissions to access that index, create relevant policies, and execute relevant actions, and `Jill` would be able to access the same index, policy, and job. However, `Jane` cannot access or edit those resources or actions.
+6
View File
@@ -6,3 +6,9 @@
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script> <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/[email protected]/es5/tex-mml-chtml.js"></script> <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/[email protected]/es5/tex-mml-chtml.js"></script>
{% endif %} {% endif %}
{% if jekyll.environment == "development" %}
<script src="{{ '/assets/js/version-selector.js' | relative_url }}"></script>
{% else %}
<script src="{{ '/docs/latest/assets/js/version-selector.js' }}"></script>
{% endif %}
+4
View File
@@ -57,6 +57,10 @@ layout: table_wrappers
</a> </a>
</div> </div>
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav"> <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
{% assign past_versions = site.data.versions.past | join: ";" %}
<div class="version-wrapper">
<version-selector selected="{{ site.data.versions.current }}"></version-selector>
</div>
{% assign pages_top_size = site.html_pages {% assign pages_top_size = site.html_pages
| where_exp:"item", "item.title != nil" | where_exp:"item", "item.title != nil"
| where_exp:"item", "item.parent == nil" | where_exp:"item", "item.parent == nil"
+2450 -1460
View File
File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More