Charmed OpenSearch Documentation

charm
, , ,
1

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

Charmed OpenSearch is an official distribution of OpenSearch . It’s an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.

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

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 Deploy
3 h-deploy-lxd Deploy on LXD
3 h-large-deployment Launch a large deployment
2 h-tls TLS encryption
3 h-enable-tls Enable TLS encryption
3 h-rotate-tls-ca-certificates Rotate TLS/CA certificates
2 h-horizontal-scaling Scale horizontally
2 h-integrate Integrate with an application
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-upgrade Upgrade
3 h-minor-upgrade Perform a minor upgrade
3 h-minor-rollback Perform a minor rollback
2 h-load-testing Perform load testing
2 h-attached-storage Recover from attached storage
2 h-enable-monitoring Enable monitoring
1 reference Reference
2 release-notes Release notes
3 revision-168 Revision 168
2 r-system-requirements System requirements
2 r-software-testing Charm testing