Charmed OpenSearch

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.

The charm helps ops teams and administrators automate OpenSearch operations from Day 0 to Day 2 with additional capabilities, such as: automated deployment, TLS encryption, user management, horizontal scaling, replication, password rotation, and easy integration with other applications.

See Full Charmed OpenSearch documenation.

OpenSearch is a community-driven, open-source search and analytics engine for log analytics, application search and more, maintained by the OpenSearch Project and supported by the OpenSearch Software Foundation.

This charm is suitable for teams running large data infrastructures, developers who need a powerful search backend for their applications, and anyone who wants a guided way to learn OpenSearch with Juju.

Getting started

Deploying Charmed OpenSearch with Juju only takes a few commands. A typical highly available setup uses three units:​

juju deploy opensearch -n 3

To enable TLS with self-signed certificates, deploy the self-signed-certificates charm:

juju deploy self-signed-certificates --config ca-common-name="Test CA"
juju integrate self-signed-certificates opensearch

To allow an external application to connect, use the Data Integrator charm:

juju deploy data-integrator --channel=stable --config index-name=test-index
juju integrate opensearch data-integrator

The integration automatically provisions a user, password and index for your application and exposes the connection details through the Data Integrator.

To check the status of your deployment:

juju status

For more information, see our tutorial and how-to guides:

• How to deploy on LXD
• How to enable TLS encryption
• How to create a backup
• How to enable monitoring (COS)

Full documentation

For additional guidance, see our full Charmed OpenSearch documentation at https://canonical-charmed-opensearch.readthedocs-hosted.com/.

Project and community

Charmed OpenSearch is Canonical’s 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 join the discussion in the Charmhub Discourse forum.
• See the Charmed OpenSearch contribution guidelines on GitHub and read the Ubuntu Community’s Code of Conduct.
• Explore more Canonical data platform solutions.

License & trademarks

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 The OpenSearch Software Foundation.