Adding documentation for remote index use in AD #8191
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Amit Galitzky <[email protected]>
amitgalitz
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
kolchfa-aws
added
release-notes
jackiehanyang
approved these changes
Sep 6, 2024
vagimeli
reviewed
Sep 6, 2024
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
reviewed
Sep 6, 2024
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
reviewed
Sep 6, 2024
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
reviewed
Sep 6, 2024
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
approved these changes
Sep 6, 2024
vagimeli
added
5 - Editorial review
Signed-off-by: Amit Galitzky <[email protected]>
kaituo
reviewed
Sep 10, 2024
_observing-your-data/ad/security.md
Outdated
|
|
||
| ### Selecting remote indices with fine-grained access control | ||
|
|
||
| In order to specify a remote index as the data source for a detector you must follow similar instruction as mentioned in the cross-cluster search documentation. By utilizing a role that exists in the both the remote and local cluster.The remote cluster will need to have the mapping between the chosen role and the same user name as in the local cluster. |
There was a problem hiding this comment.
Can you link the instruction from cross-cluster search?
_observing-your-data/ad/security.md
Outdated
|
|
||
| ### Custom result index | ||
|
|
||
| In order to use a custom result index users will need to have additional permissions that aren't part of the default roles that opensearch security plugin offers. Users will have to add additional permissions as mentioned in the custom result index setup [step](https://opensearch.org/docs/latest/observing-your-data/ad/index/#example-filter-using-query-dsl:~:text=Specify%20custom%20results%20index.). |
There was a problem hiding this comment.
Is it ok to link in this way? I saw others link like ({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/....
There was a problem hiding this comment.
I see both ways being used, but I changed to use the constants here to be consistent with any changes in baseurl
amitgalitz
force-pushed
the
ad-remote-cluster
branch
from
d46f64d to
033c562
Compare
Can you try {{site.url}}{{site.baseurl}}/monitoring-plugins/ad/... or change back to original link? |
Signed-off-by: Amit Galitzky <[email protected]>
amitgalitz
force-pushed
the
ad-remote-cluster
branch
from
d17f2ef to
39bebb1
Compare
kaituo
approved these changes
Sep 10, 2024
natebower
requested changes
Sep 11, 2024
There was a problem hiding this comment.
@amitgalitz @vagimeli Please see my comments and changes and tag me when complete for a reread and approval. Thanks!
| @@ -29,9 +29,14 @@ A detector is an individual anomaly detection task. You can define multiple dete | |||
| 1. Add in the detector details. | |||
| - Enter a name and brief description. Make sure the name is unique and descriptive enough to help you to identify the purpose of the detector. | |||
| 1. Specify the data source. | |||
| - For **Data source**, choose the index you want to use as the data source. You can optionally use index patterns to choose multiple indexes. | |||
There was a problem hiding this comment.
Line below: Should "index pattern" be singular?
There was a problem hiding this comment.
This singular usage sounds good to me on latest revision:
"- For Data source, choose one or more indexes to use as the data source. Alternatively, you can use an alias or index pattern to choose multiple indexes."
| @@ -29,9 +29,14 @@ A detector is an individual anomaly detection task. You can define multiple dete | |||
| 1. Add in the detector details. | |||
| - Enter a name and brief description. Make sure the name is unique and descriptive enough to help you to identify the purpose of the detector. | |||
| 1. Specify the data source. | |||
| - For **Data source**, choose the index you want to use as the data source. You can optionally use index patterns to choose multiple indexes. | |||
| - For **Data source**, choose the index or indexes you want to use as the data source. Alternatively, you can use an alias or index patterns to choose multiple indexes. | |||
| - Detectors can use remote indexes. You can access them using the `cluster-name:index-name` pattern, as used in [cross-cluster search]({{site.url}}{{site.baseurl}}/search-plugins/cross-cluster-search/). Alternatively, you can select the clusters and indexes you want to use through OpenSearch Dashboards 2.17 or later. For more information about configuring remote indexes with the Security plugin enabled, you can view [here]({{site.url}}{{site.baseurl}}/observing-your-data/ad/security/#selecting-remote-indexes-with-fine-grained-access-control) | |||
| - (Optional) For **Data filter**, filter the index you chose as the data source. From the **Data filter** menu, choose **Add data filter**, and then design your filter query by selecting **Field**, **Operator**, and **Value**, or choose **Use query DSL** and add your own JSON filter query. Only [Boolean queries]({{site.url}}{{site.baseurl}}/query-dsl/compound/bool/) are supported for query domain-specific language (DSL). | |||
There was a problem hiding this comment.
Line above: Instead of "here", please use the name of the page for the link text.
There was a problem hiding this comment.
@natebower This is my bad. The team added new content yesterday after the approved doc review. I needed to reread it and pull it from the editorial queue. I'll work on this and tag you one it's ready. I'm sorry.
| ### Custom result index | ||
|
|
||
| In order to use a custom result index users will need to have additional permissions that aren't part of the default roles that OpenSearch Security plugin offers. Users will have to add additional permissions as mentioned in the custom result index set up step in [define detector]({{site.url}}{{site.baseurl}}/observing-your-data/ad/index/#step-1-define-a-detector). | ||
|
|
There was a problem hiding this comment.
Line above: Last sentence needs some revision.
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
reviewed
Sep 11, 2024
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
reviewed
Sep 11, 2024
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
…umentation-website into pr/amitgalitz/8191
natebower
approved these changes
Sep 13, 2024
There was a problem hiding this comment.
@amitgalitz @vagimeli Approved with one comment and a couple of changes. Thanks!
_observing-your-data/ad/security.md
Outdated
| @@ -23,6 +23,11 @@ As an admin user, you can use the Security plugin to assign specific permissions | |||
|
|
|||
| The Security plugin has two built-in roles that cover most anomaly detection use cases: `anomaly_full_access` and `anomaly_read_access`. For descriptions of each, see [Predefined roles]({{site.url}}{{site.baseurl}}/security/access-control/users-roles#predefined-roles). | |||
|
|
|||
| If you use OpenSearch Dashboards to create your anomaly detectors, you may experience permission issues even with `anomaly_full_access`. This issue has been resolved in OpenSearch 2.17, but for earlier versions, the following additional permissions need to be added: | |||
There was a problem hiding this comment.
"permissions issues"? Or do we actually mean "access issues"?
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
reviewed
Sep 13, 2024
Signed-off-by: Melissa Vagi <[email protected]>
noahstaveley
pushed a commit
to noahstaveley/documentation-website
that referenced
this pull request
Sep 23, 2024
) * adding documentation for remote index use in AD Signed-off-by: Amit Galitzky <[email protected]> * Update _observing-your-data/ad/index.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/index.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/index.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/index.md Signed-off-by: Melissa Vagi <[email protected]> * adding additional security information Signed-off-by: Amit Galitzky <[email protected]> * fixing formatting issues Signed-off-by: Amit Galitzky <[email protected]> * Update _observing-your-data/ad/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * doc review new content and address editorial review comments Signed-off-by: Melissa Vagi <[email protected]> * doc review new content and address editorial review comments Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Signed-off-by: Melissa Vagi <[email protected]> * doc review new content and address editorial review comments Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/ad/security.md Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Amit Galitzky <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In 2.17 we have added the capability to select a remote index as a data source for creating an anomaly detector
Issues Resolved
Closes #8169
Version
2.17
Frontend features
new addition is just the cluster drop down
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.