Charmed OpenSearch documentation¶
Charmed OpenSearch is an open-source operator, packaged as a Juju charm, that simplifies the deployment, scaling, and management of OpenSearch clusters on physical hardware, VMs, and cloud environments including AWS, Azure, OpenStack, and VMware.
The charm automates OpenSearch operations from Day 0 to Day 2 with capabilities such as TLS encryption, user management, horizontal scaling, replication, password rotation, monitoring, and application integration.
In this documentation¶
Charmed OpenSearch documentation has the following topics.
Get started¶
Getting started |
Requirements • Tutorial: Introduction • Step 1: Environment setup |
Deployment |
|
Cluster management |
Horizontal scaling • Applications integration • Version upgrades • Version rollback |
Monitoring & performance |
Monitoring • SMTP notifications • Performance optimization • Load testing • OpenSearch Dashboards |
Backups |
Create a backup • Azure configuration • S3 configuration • Restore from a local backup • Migrate a cluster • Recover from attached storage |
Security |
Overview • Enable encryption • Rotate certificates • OAuth • JWT Auth • Cryptography |
Internals |
Alert rules • Monitoring overview • Software testing • Release notes |
How the documentation is organized¶
This documentation uses the Diátaxis documentation structure:
The Tutorial walks you through deploying your first Charmed OpenSearch cluster from scratch, step by step.
How-to guides help you solve specific operational tasks such as enabling TLS, scaling, or integrating with other applications.
Reference lets you look up system requirements, release notes, and configuration options.
Explanation helps you understand the design decisions behind security, monitoring, and software testing.
Project & community¶
Charmed OpenSearch is an official distribution of OpenSearch. It’s an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback:
Raise an issue or feature request in the GitHub repository.
Meet the community and chat with us in our Matrix channel or leave a comment.
See the Charmed OpenSearch contribution guidelines 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.