--- title: Charmhub | Deploy OpenSearch using Charmhub - The Open Operator Collection description: Deploy the latest version of OpenSearch on any cloud. Machine charm for OpenSearch url: https://charmhub.io/opensearch --- # OpenSearch [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical") * [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical") * [Databases](https://charmhub.io/?filter=databases) Platform: 24.04 22.04 2/stable 344 ``` juju deploy opensearch --channel 2/stable ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) --- Share your thoughts on this charm with the community on discourse. [Join the discussion](https://discourse.charmhub.io/) # Charmed OpenSearch Charmed OpenSearch is an open-source software operator that packages the [OpenSearch](http://opensearch.org/) 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](https://codilime.com/blog/day-0-day-1-day-2-the-software-lifecycle-in-the-cloud-age/) 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](https://canonical-charmed-opensearch.readthedocs-hosted.com/2/). 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](https://opensearch.org/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](https://charmhub.io/opensearch#p-40247-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](https://charmhub.io/data-integrator): ``` 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](https://canonical-charmed-opensearch.readthedocs-hosted.com/2/tutorial/) and how-to guides: * [How to deploy on LXD](https://canonical-charmed-opensearch.readthedocs-hosted.com/2/how-to/deploy/deploy-on-lxd/) * [How to enable TLS encryption](https://canonical-charmed-opensearch.readthedocs-hosted.com/2/how-to/tls-encryption/enable-tls-encryption/) * [How to create a backup](https://canonical-charmed-opensearch.readthedocs-hosted.com/2/how-to/back-up-and-restore/create-a-backup/) * [How to enable monitoring (COS)](https://canonical-charmed-opensearch.readthedocs-hosted.com/2/how-to/monitoring-cos/enable-cos/) ## [Full documentation](https://charmhub.io/opensearch#p-40247-full-documentation) For additional guidance, see our full [Charmed OpenSearch documentation](https://canonical-charmed-opensearch.readthedocs-hosted.com/2/) at . ## [Project and community](https://charmhub.io/opensearch#p-40247-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](https://github.com/canonical/opensearch-operator/issues). * Meet the community and chat with us in our [Matrix channel](https://matrix.to/#/#charmhub-data-platform:ubuntu.com) or join the discussion in the [Charmhub Discourse forum](https://discourse.charmhub.io/tag/opensearch). * See the Charmed OpenSearch [contribution guidelines](https://github.com/canonical/opensearch-operator/blob/main/CONTRIBUTING.md) on GitHub and read the Ubuntu Community’s [Code of Conduct](https://ubuntu.com/community/code-of-conduct). * Explore more [Canonical data platform solutions](https://canonical.com/data). ## [License & trademarks](https://charmhub.io/opensearch#p-40247-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](https://github.com/canonical/opensearch-operator/blob/2/edge/LICENSE). They install and operate OpenSearch, which is also licensed under the [Apache Software License, version 2.0](https://opensearch.org/trademark-brand-policy/). OpenSearch is a registered trademark of [The OpenSearch Software Foundation](https://opensearch.org/foundation/). --- [Help improve this document in the forum](https://discourse.charmhub.io/t/charmed-opensearch-documentation/19417) ([guidelines](https://discourse.charmhub.io/t/how-to-write-docs-our-documentation-guidelines-for-contributors/1245)). Last updated 10 months ago.