Merge pull request #32 from bowenlan-amzn/main
Index Management doc change for bwc
This commit is contained in:
Ashwin Kumar
GitHub
commit
c5977c86f0
|
|
@ -3,3 +3,4 @@ _site
|
|||
.jekyll-metadata
|
||||
.DS_Store
|
||||
Gemfile.lock
|
||||
.idea
|
||||
|
|
|
|||
|
|
@ -219,7 +219,7 @@ Create an index rollup job.
|
|||
This example picks the `order_date`, `customer_gender`, `geoip.city_name`, `geoip.region_name`, and `day_of_week` fields and rolls them into an `example_rollup` target index:
|
||||
|
||||
```json
|
||||
PUT _opensearch/_rollup/jobs/example
|
||||
PUT _plugins/_rollup/jobs/example
|
||||
{
|
||||
"rollup": {
|
||||
"enabled": true,
|
||||
|
|
|
|||
|
|
@ -28,8 +28,8 @@ You must provide the `seq_no` and `primary_term` parameters.
|
|||
#### Request
|
||||
|
||||
```json
|
||||
PUT _opensearch/_rollup/jobs/<rollup_id> // Create
|
||||
PUT _opensearch/_rollup/jobs/<rollup_id>?if_seq_no=1&if_primary_term=1 // Update
|
||||
PUT _plugins/_rollup/jobs/<rollup_id> // Create
|
||||
PUT _plugins/_rollup/jobs/<rollup_id>?if_seq_no=1&if_primary_term=1 // Update
|
||||
{
|
||||
"rollup": {
|
||||
"source_index": "nyc-taxi-data",
|
||||
|
|
@ -141,7 +141,7 @@ Returns all information about an index rollup job based on the `rollup_id`.
|
|||
#### Request
|
||||
|
||||
```json
|
||||
GET _opensearch/_rollup/jobs/<rollup_id>
|
||||
GET _plugins/_rollup/jobs/<rollup_id>
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -166,7 +166,7 @@ Deletes an index rollup job based on the `rollup_id`.
|
|||
#### Request
|
||||
|
||||
```json
|
||||
DELETE _opensearch/_rollup/jobs/<rollup_id>
|
||||
DELETE _plugins/_rollup/jobs/<rollup_id>
|
||||
```
|
||||
|
||||
#### Sample response
|
||||
|
|
@ -185,8 +185,8 @@ Start or stop an index rollup job.
|
|||
#### Request
|
||||
|
||||
```json
|
||||
POST _opensearch/_rollup/jobs/<rollup_id>/_start
|
||||
POST _opensearch/_rollup/jobs/<rollup_id>/_stop
|
||||
POST _plugins/_rollup/jobs/<rollup_id>/_start
|
||||
POST _plugins/_rollup/jobs/<rollup_id>/_stop
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -206,7 +206,7 @@ Returns detailed metadata information about the index rollup job and its current
|
|||
#### Request
|
||||
|
||||
```json
|
||||
GET _opensearch/_rollup/jobs/<rollup_id>/_explain
|
||||
GET _plugins/_rollup/jobs/<rollup_id>/_explain
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ Creates a policy.
|
|||
#### Request
|
||||
|
||||
```json
|
||||
PUT _opensearch/_ism/policies/policy_1
|
||||
PUT _plugins/_ism/policies/policy_1
|
||||
{
|
||||
"policy": {
|
||||
"description": "ingesting logs",
|
||||
|
|
@ -145,7 +145,7 @@ Adds a policy to an index. This operation does not change the policy if the inde
|
|||
#### Request
|
||||
|
||||
```json
|
||||
POST _opensearch/_ism/add/index_1
|
||||
POST _plugins/_ism/add/index_1
|
||||
{
|
||||
"policy_id": "policy_1"
|
||||
}
|
||||
|
|
@ -171,7 +171,7 @@ Updates a policy. Use the `seq_no` and `primary_term` parameters to update an ex
|
|||
#### Request
|
||||
|
||||
```json
|
||||
PUT _opensearch/_ism/policies/policy_1?if_seq_no=7&if_primary_term=1
|
||||
PUT _plugins/_ism/policies/policy_1?if_seq_no=7&if_primary_term=1
|
||||
{
|
||||
"policy": {
|
||||
"description": "ingesting logs",
|
||||
|
|
@ -288,7 +288,7 @@ Gets the policy by `policy_id`.
|
|||
#### Request
|
||||
|
||||
```json
|
||||
GET _opensearch/_ism/policies/policy_1
|
||||
GET _plugins/_ism/policies/policy_1
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -358,7 +358,7 @@ Removes any ISM policy from the index.
|
|||
#### Request
|
||||
|
||||
```json
|
||||
POST _opensearch/_ism/remove/index_1
|
||||
POST _plugins/_ism/remove/index_1
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -385,7 +385,7 @@ In this example, the policy applied on the `index_1` index is changed to `policy
|
|||
#### Request
|
||||
|
||||
```json
|
||||
POST _opensearch/_ism/change_policy/index_1
|
||||
POST _plugins/_ism/change_policy/index_1
|
||||
{
|
||||
"policy_id": "policy_1",
|
||||
"state": "delete",
|
||||
|
|
@ -417,7 +417,7 @@ Retries the failed action for an index. For the retry call to succeed, ISM must
|
|||
#### Request
|
||||
|
||||
```json
|
||||
POST _opensearch/_ism/retry/index_1
|
||||
POST _plugins/_ism/retry/index_1
|
||||
{
|
||||
"state": "delete"
|
||||
}
|
||||
|
|
@ -443,7 +443,7 @@ Gets the current state of the index. You can use index patterns to get the statu
|
|||
#### Request
|
||||
|
||||
```json
|
||||
GET _opensearch/_ism/explain/index_1
|
||||
GET _plugins/_ism/explain/index_1
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -469,7 +469,7 @@ Deletes the policy by `policy_id`.
|
|||
#### Request
|
||||
|
||||
```json
|
||||
DELETE _opensearch/_ism/policies/policy_1
|
||||
DELETE _plugins/_ism/policies/policy_1
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ After you create a policy, your next step is to attach this policy to an index o
|
|||
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:
|
||||
|
||||
```json
|
||||
PUT _opensearch/_ism/policies/policy_id
|
||||
PUT _plugins/_ism/policies/policy_id
|
||||
{
|
||||
"policy": {
|
||||
"description": "Example policy.",
|
||||
|
|
|
|||
|
|
@ -201,7 +201,7 @@ Deletes a managed index.
|
|||
Rolls an alias over to a new index when the managed index meets one of the rollover conditions.
|
||||
|
||||
The index format must match the pattern: `^.*-\d+$`. For example, `(logs-000001)`.
|
||||
Set `index.opendistro.index_state_management.rollover_alias` as the alias to rollover.
|
||||
Set `index.plugins.index_state_management.rollover_alias` as the alias to rollover.
|
||||
|
||||
Parameter | Description | Type | Example | Required
|
||||
:--- | :--- |:--- |:--- |
|
||||
|
|
@ -526,7 +526,7 @@ The following sample template policy is for a rollover use case.
|
|||
1. Create a policy with an `ism_template` field:
|
||||
|
||||
```json
|
||||
PUT _opensearch/_ism/policies/rollover_policy
|
||||
PUT _plugins/_ism/policies/rollover_policy
|
||||
{
|
||||
"policy": {
|
||||
"description": "Example rollover policy.",
|
||||
|
|
@ -561,7 +561,7 @@ The following sample template policy is for a rollover use case.
|
|||
{
|
||||
"index_patterns": ["log*"],
|
||||
"settings": {
|
||||
"opendistro.index_state_management.rollover_alias": "log"
|
||||
"plugins.index_state_management.rollover_alias": "log"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -17,17 +17,17 @@ All settings are available using the OpenSearch `_cluster/settings` operation. N
|
|||
|
||||
Setting | Default | Description
|
||||
:--- | :--- | :---
|
||||
`opendistro.index_state_management.enabled` | True | Specifies whether ISM is enabled or not.
|
||||
`opendistro.index_state_management.job_interval` | 5 minutes | The interval at which the managed index jobs are run.
|
||||
`opendistro.index_state_management.coordinator.sweep_period` | 10 minutes | How often the routine background sweep is run.
|
||||
`opendistro.index_state_management.coordinator.backoff_millis` | 50 milliseconds | The backoff time between retries for failures in the `ManagedIndexCoordinator` (such as when we update managed indices).
|
||||
`opendistro.index_state_management.coordinator.backoff_count` | 2 | The count of retries for failures in the `ManagedIndexCoordinator`.
|
||||
`opendistro.index_state_management.history.enabled` | True | Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
|
||||
`opendistro.index_state_management.history.max_docs` | 2,500,000 | The maximum number of documents before rolling over the audit history index.
|
||||
`opendistro.index_state_management.history.max_age` | 24 hours | The maximum age before rolling over the audit history index.
|
||||
`opendistro.index_state_management.history.rollover_check_period` | 8 hours | The time between rollover checks for the audit history index.
|
||||
`opendistro.index_state_management.history.rollover_retention_period` | 30 days | How long audit history indices are kept.
|
||||
`opendistro.index_state_management.allow_list` | All actions | List of actions that you can use.
|
||||
`plugins.index_state_management.enabled` | True | Specifies whether ISM is enabled or not.
|
||||
`plugins.index_state_management.job_interval` | 5 minutes | The interval at which the managed index jobs are run.
|
||||
`plugins.index_state_management.coordinator.sweep_period` | 10 minutes | How often the routine background sweep is run.
|
||||
`plugins.index_state_management.coordinator.backoff_millis` | 50 milliseconds | The backoff time between retries for failures in the `ManagedIndexCoordinator` (such as when we update managed indices).
|
||||
`plugins.index_state_management.coordinator.backoff_count` | 2 | The count of retries for failures in the `ManagedIndexCoordinator`.
|
||||
`plugins.index_state_management.history.enabled` | True | Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
|
||||
`plugins.index_state_management.history.max_docs` | 2,500,000 | The maximum number of documents before rolling over the audit history index.
|
||||
`plugins.index_state_management.history.max_age` | 24 hours | The maximum age before rolling over the audit history index.
|
||||
`plugins.index_state_management.history.rollover_check_period` | 8 hours | The time between rollover checks for the audit history index.
|
||||
`plugins.index_state_management.history.rollover_retention_period` | 30 days | How long audit history indices are kept.
|
||||
`plugins.index_state_management.allow_list` | All actions | List of actions that you can use.
|
||||
|
||||
|
||||
## Audit history indices
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ has_toc: false
|
|||
With ISM installed, you can refresh search analyzers in real time with the following API:
|
||||
|
||||
```json
|
||||
POST /_opensearch/_refresh_search_analyzers/<index or alias or wildcard>
|
||||
POST /_plugins/_refresh_search_analyzers/<index or alias or wildcard>
|
||||
```
|
||||
For example, if you change the synonym list in your analyzer, the change takes effect without you needing to close and reopen the index.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue