Skip to content

Commit

Permalink
expanded README.md with section on testing cluster state notices
Browse files Browse the repository at this point in the history
  • Loading branch information
jloleysens committed Sep 29, 2020
1 parent 5619743 commit 7775b06
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions x-pack/plugins/index_lifecycle_management/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Index Lifecycle Management

## Quick steps for testing ILM in Index Management
## Testing

### Quick steps for testing ILM in Index Management

You can test that the `Frozen` badge, phase filtering, and lifecycle information is surfaced in
Index Management by running this series of requests in Console:
Expand Down Expand Up @@ -92,4 +94,26 @@ After about a minute, there should be an error on this index. When you click the
ILM information in the detail panel as well as an error. You can dismiss the error by clicking
`Manage > Retry lifecycle step`.

![image](https://user-images.githubusercontent.com/1238659/78087984-a6811000-7377-11ea-880e-1a7b182c14f1.png)
![image](https://user-images.githubusercontent.com/1238659/78087984-a6811000-7377-11ea-880e-1a7b182c14f1.png)

### Data tier notifications

When creating or editing an ILM policy the UI should notify users that under certain conditions their data will not be
moved to a tier corresponding to a phase. For instance, when a cluster only has hot-tier nodes. We test the UI
with this cluster state by starting an ES node with the `data_hot` role. Using this command:

```bash
yarn es snapshot --license=trial -E node.roles=data_hot,master,data_content
```

This will create a cluster where we have a single node that belongs to the hot-tier. In the data allocation section of
both the warm and cold phase you should see notice like the following:

![image](https://user-images.githubusercontent.com/8155004/94132944-4b306600-fe60-11ea-9c3d-02229e3055b8.png)

Default configuration for a node is that it belongs to all tiers, in which case you should not see this notice. Test
this by running:

```bash
yarn es snapshot --license=trial
```

0 comments on commit 7775b06

Please sign in to comment.