https://github.com/opensearch-project/index-management
🗃 Automate periodic data operations, such as deleting indices at a certain age or performing a rollover at a certain size
https://github.com/opensearch-project/index-management
opensearch-plugins
Last synced: 3 months ago
JSON representation
🗃 Automate periodic data operations, such as deleting indices at a certain age or performing a rollover at a certain size
- Host: GitHub
- URL: https://github.com/opensearch-project/index-management
- Owner: opensearch-project
- License: apache-2.0
- Created: 2021-04-02T17:57:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T10:46:41.000Z (3 months ago)
- Last Synced: 2025-03-28T07:05:15.730Z (3 months ago)
- Topics: opensearch-plugins
- Language: Kotlin
- Homepage: https://opensearch.org/docs/latest/im-plugin/index/
- Size: 120 MB
- Stars: 55
- Watchers: 14
- Forks: 118
- Open Issues: 157
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/opensearch-project/index-management/actions)
[](https://codecov.io/gh/opensearch-project/index-management)
[](https://github.com/opensearch-project/index-management/projects/1)
[](https://opensearch.org/docs/im-plugin/index/)
[](https://forum.opensearch.org/c/plugins/index-management/47)
- [OpenSearch Index Management](#opensearch-index-management)
- [Highlights](#highlights)
- [Contributing](#contributing)
- [Getting Help](#getting-help)
- [Code of Conduct](#code-of-conduct)
- [Security](#security)
- [License](#license)
- [Copyright](#copyright)
# OpenSearch Index Management
OpenSearch Index Management provides a suite of features to monitor and manage indexes.
It currently contains an automated system for managing and optimizing indices throughout their life, Index State Management.
View the original [request for comments](docs/rfc.md).
## Highlights
With Index State Management you will be able to define custom policies, to optimize and manage indices and apply them to index patterns.
Each policy contains a default state and a list of states that you define for the index to transition between.
Within each state you can define a list of actions to perform and transitions to enter a new state based off certain conditions.
The current supported actions are:
* Delete
* Close
* Open
* Force merge
* Notification
* Read only
* Read write
* Replica count
* Rollover
The current supported transition conditions are:
* Index doc count
* Index size
* Index age
* Cron expression
## Contributing
See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md).
## Getting Help
If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.
For more information, see [project website](https://opensearch.org/) and [documentation](https://opensearch.org/docs/latest/im-plugin/index/). If you need help and are unsure where to open an issue, try [Forum](https://forum.opensearch.org/c/plugins/index-management/47).
## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## Security
If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to [email protected]. Please do **not** create a public GitHub issue.
## License
This project is licensed under the [Apache v2.0 License](./LICENSE)
## Copyright
Copyright OpenSearch Contributors. See [NOTICE](NOTICE) for details.