Charmed OpenSearch Documentation
Charmed OpenSearch is an open-source software operator that packages the OpenSearch search and data analytics suite with simplified deployment, operation, and management via the Juju CLI. It can be deployed on physical and virtual machines, as well as other cloud and cloud-like environments, including AWS, Azure, OpenStack and VMWare.
Charmed OpenSearch has multiple operator features such as automated deployment, TLS encryption, user management, horizontal scaling, replication, password rotation, and easy integration with other applications.
This charm is for anyone looking for a complete data analytics suite. You could be a team of system administrators maintaining large data infrastructures, a software developer who wants to connect their application with a powerful search engine, or even someone curious to learn more about Charmed OpenSearch through our guided tutorial.
To see the Charmed OpenSearch features and releases, visit our GitHub Releases page.
In this documentation
| Tutorials Get started - a hands-on introduction to using the Charmed OpenSearch operator for new users |
How-to guides Step-by-step guides covering key operations such as scaling, TLS encryption, or monitoring |
| Reference Technical information such as system requirements |
Project & community
If you find a bug in this operator or want to request a specific feature, here are the useful links:
- Raise the issue or feature request in the Canonical Github repository.
- Meet the community and chat with us if there are issues and feature requests in our Mattermost Channel and join the Discourse Forum.
- To learn about contribution guidelines, check the Charmed OpenSearch CONTRIBUTING.md on GitHub and read the Ubuntu Community’s Code of Conduct.
License & trademark
The Charmed OpenSearch ROCK, Charmed OpenSearch Snap, and Charmed OpenSearch Operator are free software, distributed under the Apache Software License, version 2.0. They install and operate OpenSearch, which is also licensed under the Apache Software License, version 2.0.
OpenSearch is a registered trademark of Amazon Web Services. Other trademarks are property of their respective owners. Charmed OpenSearch is not sponsored, endorsed, or affiliated with Amazon Web Services.
This documentation follows the Diataxis Framework.
Navigation
| Level | Path | Navlink |
|---|---|---|
| 1 | tutorial | Tutorial |
| 2 | t-overview | Overview |
| 2 | t-set-up | 1. Set up the environment |
| 2 | t-deploy-opensearch | 2. Deploy OpenSearch |
| 2 | t-enable-tls | 3. Enable encryption |
| 2 | t-integrate | 4. Integrate with a client application |
| 2 | t-passwords | 5. Manage passwords |
| 2 | t-horizontal-scaling | 6. Scale horizontally |
| 2 | t-clean-up | 7. Clean up the environment |
| 1 | how-to | How To |
| 2 | h-deploy-lxd | Deploy on LXD |
| 2 | h-horizontal-scaling | Scale horizontally |
| 2 | h-enable-tls | Enable TLS encryption |
| 2 | h-enable-monitoring | Enable monitoring |
| 2 | h-backups | Back up and restore |
| 3 | h-configure-s3 | Configure S3 |
| 3 | h-create-backup | Create a backup |
| 3 | h-restore-backup | Restore a local backup |
| 3 | h-migrate-cluster | Migrate a cluster |
| 2 | h-contribute | Contribute |
| 1 | reference | Reference |
| 2 | r-system-requirements | System requirements |
| 2 | r-software-testing | Charm testing |