-
Notifications
You must be signed in to change notification settings - Fork 623
Adding documentation for remote index use in AD #8191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
4ca8528
aa16e9a
351c8f0
08bc9d6
addce3b
6eac47f
39bebb1
c923eec
1672240
1586c9e
b909911
8a04f39
85ea3c8
d0f494e
bdf6b03
563a610
7f76d59
b278b1d
ab43ebf
52382a5
37bbc82
93dc948
f89eb55
c2cf1c0
60de517
a179f64
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
vagimeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - 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) | ||
vagimeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - (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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Line above: Instead of "here", please use the name of the page for the link text. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @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. |
||
|
|
||
|
|
||
| To create a cross-cluster detector through OpenSearch Dashboards, the following [permissions]({{site.url}}{{site.baseurl}}/security/access-control/permissions/) are required: `indices:data/read/field_caps`, `indices:admin/resolve/index`, and `cluster:monitor/remote/info`. | ||
vagimeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| {: .note} | ||
|
|
||
| #### Example filter using query DSL | ||
| The query is designed to retrieve documents in which the `urlPath.keyword` field matches one of the following specified values: | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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 are using OpenSearch Dashboards to create your anomaly detectors you might notice issues creating a detector even with `anomaly_full_access`, this has been mitigated in OpenSearch 2.17. In order to mitigate this issue in prior versions, you should add these additional permissions: | ||||||
vagimeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Line above: What do we mean by "you may experience issues"? What "issue" may the user experience, specifically? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @amitgalitz Please see the editor's comment above. We should give the users context about what issues they may experience. I think we're referring to permissions issues. Please confirm. |
||||||
| - `indices:data/read/search` - You need the search permission because the Anomaly Detection plugin needs to search the data source in order to validate if there is enough data to train the model. | ||||||
|
||||||
| - `indices:data/read/search` - You need the search permission because the Anomaly Detection plugin needs to search the data source in order to validate if there is enough data to train the model. | |
| - `indices:data/read/search` -- You need this permission because the Anomaly Detection plugin needs to search the data source in order to validate whether there is enough data to train the model. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - `indices:admin/mappings/fields/get` and `indices:admin/mappings/fields/get*` - You need field mapping permissions since as part of detector creation we validate if the given data source has a valid timestamp field and categorical field (in case of creating a high cardinality detector) | |
| - `indices:admin/mappings/fields/get` and `indices:admin/mappings/fields/get*` -- You need these permissions to validate whether the given data source has a valid timestamp field and categorical field (in the case of creating a high-cardinality detector). |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This para needs some revision for completeness and clarity. Also, we should just tell the user what instructions they need to follow rather than telling them to follow instructions similar to something else.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please revise.
vagimeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
vagimeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
vagimeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
vagimeli marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line above: Last sentence needs some revision.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revised
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line below: Should "index pattern" be singular?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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."