# Charmed OpenSearch > This is the documentation for Charmed OpenSearch, an open-source operator > that simplifies the deployment, scaling, and management of OpenSearch > clusters on physical hardware, VMs, and cloud environments. 2026 ## Pages - [Charmed OpenSearch documentation](https://canonical.com/data/opensearch/docs/2/index.html.md): Deploy and manage OpenSearch clusters with automated operations, TLS encryption, backups, and horizontal scaling on any cloud using Juju. - [How to contribute](https://canonical.com/data/opensearch/docs/2/contributing/index.html.md): How to contribute to Charmed OpenSearch - report issues, contribute code and documentation, get in touch with the team, and learn about Canonical career opportunities. - [How to access OpenSearch using OAuth](https://canonical.com/data/opensearch/docs/2/how-to/access-using-oauth/index.html.md): Secure Charmed OpenSearch with OAuth authentication using Canonical Identity Platform (Hydra) and query with OAuth tokens. - [How-to guides](https://canonical.com/data/opensearch/docs/2/how-to/index.html.md): Step-by-step guides for deploying, managing, and maintaining Charmed OpenSearch including TLS, backups, monitoring, and scaling. - [How to enable JWT authentication](https://canonical.com/data/opensearch/docs/2/how-to/enable-jwt-authentication/index.html.md): Enable JSON Web Token (JWT) authentication in Charmed OpenSearch using the JWT integrator charm for secure token-based access. - [How to manage persistent storage](https://canonical.com/data/opensearch/docs/2/how-to/persistent-storage/index.html.md): Reuse and recover OpenSearch data from Juju-managed disks, including last-resort disaster-recovery metadata cleanup. - [How to enable monitoring (COS)](https://canonical.com/data/opensearch/docs/2/how-to/monitoring/index.html.md): Enable monitoring for Charmed OpenSearch on VMs or Kubernetes by integrating with COS Lite bundle, Grafana, Loki, and Prometheus. - [How to integrate with an application](https://canonical.com/data/opensearch/docs/2/how-to/integrate-with-an-application/index.html.md): Integrate client applications with Charmed OpenSearch using the opensearch_client interface or data-integrator charm. - [How to scale a cluster horizontally](https://canonical.com/data/opensearch/docs/2/how-to/scale-horizontally/index.html.md): Scale Charmed OpenSearch clusters horizontally by adding or removing units, safely and without data loss. - [How to upgrade, rollback, and recover](https://canonical.com/data/opensearch/docs/2/how-to/upgrade/index.html.md): Upgrade Charmed OpenSearch on machines or Kubernetes from one minor version to another, including pre-upgrade checks, in-place upgrades, health verification, and rollback procedures. - [How to perform load testing](https://canonical.com/data/opensearch/docs/2/how-to/perform-load-testing/index.html.md): Perform load testing on Charmed OpenSearch deployments with COS monitoring on AWS and other cloud platforms. - [How to optimize cluster performance with profiles](https://canonical.com/data/opensearch/docs/2/how-to/optimize-cluster-performance/index.html.md): Optimize Charmed OpenSearch performance using testing and production profiles to configure resources and JVM heap size. - [How to enable email notifications](https://canonical.com/data/opensearch/docs/2/how-to/add-smtp-credentials/index.html.md): Configure SMTP credentials for Charmed OpenSearch email notifications using the SMTP integrator charm. - [How to manage passwords](https://canonical.com/data/opensearch/docs/2/how-to/manage-passwords/index.html.md): Retrieve and rotate the admin password in Charmed OpenSearch, and rotate the credentials issued to integrated client applications. - [How to manage TLS encryption](https://canonical.com/data/opensearch/docs/2/how-to/tls-encryption/index.html.md): Manage TLS encryption for Charmed OpenSearch, including enabling TLS, updating private keys, and rotating TLS and CA certificates. - [How to enable LDAP authentication](https://canonical.com/data/opensearch/docs/2/how-to/enable-ldap-authentication/index.html.md): Enable LDAP authentication in Charmed OpenSearch on machines or Kubernetes. - [How to back up and restore](https://canonical.com/data/opensearch/docs/2/how-to/back-up-and-restore/index.html.md): Back up and restore Charmed OpenSearch including S3, Azure, and Google Cloud Storage configuration, and cluster migration. - [How to configure Azure storage](https://canonical.com/data/opensearch/docs/2/how-to/back-up-and-restore/configure-azure-storage/index.html.md): Set up Azure Storage for Charmed OpenSearch backups using the Azure Storage Integrator charm and configure integration. - [How to configure Google Cloud Storage](https://canonical.com/data/opensearch/docs/2/how-to/back-up-and-restore/configure-gcs-storage/index.html.md): Set up Google Cloud Storage for Charmed OpenSearch backups using the GCS Integrator charm and configure integration. - [How to configure S3 storage](https://canonical.com/data/opensearch/docs/2/how-to/back-up-and-restore/configure-s3/index.html.md): Configure AWS S3 or Ceph RadosGW storage for Charmed OpenSearch backups using the S3 Integrator charm with Juju. - [How to deploy](https://canonical.com/data/opensearch/docs/2/how-to/deploy/index.html.md): Deployment guides for Charmed OpenSearch including LXD setup and large-scale production deployments with Juju. - [How to deploy Charmed OpenSearch](https://canonical.com/data/opensearch/docs/2/how-to/deploy/standard/index.html.md): Deploy Charmed OpenSearch on LXD virtual machines or on Kubernetes with Juju, including prerequisites, kernel tuning, and bootstrap steps. - [How to launch a large deployment](https://canonical.com/data/opensearch/docs/2/how-to/deploy/large/index.html.md): Deploy large-scale Charmed OpenSearch clusters on VMs or Kubernetes with node roles, data tiers, and production configurations for high-performance workloads. - [Charmed OpenSearch Dashboards](https://canonical.com/data/opensearch/docs/2/dashboards/docs/index.html.md): [OpenSearch Dashboards](https://opensearch.org/docs/latest/dashboards/) is a frontend application - [How to access OpenSearch Dashboards using OAuth](https://canonical.com/data/opensearch/docs/2/dashboards/docs/how-to/access-using-oauth/index.html.md): This guide shows how to configure OpenSearch Dashboards to support single sign-on (SSO) - [How-to guides](https://canonical.com/data/opensearch/docs/2/dashboards/docs/how-to/index.html.md): The following guides cover key processes and common tasks for Charmed OpenSearch Dashboards. - [How to enable JWT authentication](https://canonical.com/data/opensearch/docs/2/dashboards/docs/how-to/enable-jwt-authentication/index.html.md): This document shows how to enable authentication with JSON Web Tokens (JWT) in OpenSearch. - [How to enable monitoring (COS)](https://canonical.com/data/opensearch/docs/2/dashboards/docs/how-to/enable-monitoring/index.html.md): All commands are written for Juju 3.4 or later. - [How to deploy, connect, and scale](https://canonical.com/data/opensearch/docs/2/dashboards/docs/how-to/deploy-connect-scale/index.html.md): This guide covers deploying the OpenSearch Dashboards charm, connecting it to an - [How to manage security](https://canonical.com/data/opensearch/docs/2/dashboards/docs/how-to/manage-security/index.html.md): This guide covers enabling TLS encryption and changing the `kibanaserver` - [Reference](https://canonical.com/data/opensearch/docs/2/dashboards/docs/reference/index.html.md): * [Monitoring reference: metrics and alert rules](https://canonical.com/data/opensearch/docs/2//dash... - [Monitoring reference: metrics and alert rules](https://canonical.com/data/opensearch/docs/2/dashboards/docs/reference/monitoring/index.html.md): This reference describes the OpenSearch Dashboards metrics and alert rules available - [Release notes](https://canonical.com/data/opensearch/docs/2/dashboards/docs/reference/release-notes/index.html.md): * [Revision 21](https://canonical.com/data/opensearch/docs/2//dashboards/docs/reference/release-note... - [Revision 21](https://canonical.com/data/opensearch/docs/2/dashboards/docs/reference/release-notes/revision-21/index.html.md): 24 September 2024 - [Tutorial](https://canonical.com/data/opensearch/docs/2/dashboards/docs/tutorial/index.html.md): This tutorial guides you through how to get Charmed OpenSearch Dashboards up and running. - [Reference](https://canonical.com/data/opensearch/docs/2/reference/index.html.md): Technical reference documentation for Charmed OpenSearch including release notes, system requirements, and software testing. - [Default alert rules](https://canonical.com/data/opensearch/docs/2/reference/alert-rules/index.html.md): Monitor Charmed OpenSearch with Canonical Observability Stack (COS) using Grafana, Prometheus metrics, and alert rules. - [System requirements](https://canonical.com/data/opensearch/docs/2/reference/system-requirements/index.html.md): Minimum software and hardware requirements for deploying Charmed OpenSearch including Ubuntu, Juju, LXD, and storage specifications. - [Revision 168 release notes](https://canonical.com/data/opensearch/docs/2/reference/release-notes/revision-168/index.html.md): Charmed OpenSearch Revision 168 release notes - large scale deployments, security automation, monitoring, and backup features. - [Release notes](https://canonical.com/data/opensearch/docs/2/reference/release-notes/index.html.md): Release notes for all Charmed OpenSearch versions with new features, bug fixes, and upgrade information. - [Revision 315](https://canonical.com/data/opensearch/docs/2/reference/release-notes/revision-315/index.html.md): Charmed OpenSearch Revision 315 release notes - Ubuntu 24.04 support, OAuth/JWT authentication, and OpenSearch 2.19.4 upgrade. - [Tutorial](https://canonical.com/data/opensearch/docs/2/tutorial/index.html.md): Complete hands-on tutorial to deploy Charmed OpenSearch with Juju, enable TLS encryption, integrate applications, and scale your cluster. - [5. Manage passwords](https://canonical.com/data/opensearch/docs/2/tutorial/5-manage-passwords/index.html.md): Learn how to retrieve and rotate admin passwords in Charmed OpenSearch for enhanced security and credential management. - [1. Set up the environment](https://canonical.com/data/opensearch/docs/2/tutorial/1-set-up-the-environment/index.html.md): Learn how to set up your development environment with LXD and Juju to deploy Charmed OpenSearch on Ubuntu. - [7. Clean up the environment](https://canonical.com/data/opensearch/docs/2/tutorial/7-clean-up-the-environment/index.html.md): Remove your Charmed OpenSearch deployment and clean up Juju resources to free up system resources after completing the tutorial. - [3. Enable encryption](https://canonical.com/data/opensearch/docs/2/tutorial/3-enable-encryption/index.html.md): Enable TLS encryption in Charmed OpenSearch by integrating with the Self Signed Certificates charm for secure data transmission. - [2. Deploy OpenSearch](https://canonical.com/data/opensearch/docs/2/tutorial/2-deploy-opensearch/index.html.md): Deploy a three-unit Charmed OpenSearch cluster with Juju using performance profiles for optimal resource usage. - [4. Integrate with a client application](https://canonical.com/data/opensearch/docs/2/tutorial/4-integrate-with-a-client-application/index.html.md): Connect client applications to Charmed OpenSearch using the Data Integrator charm to manage users, credentials, and access permissions. - [6. Scale horizontally](https://canonical.com/data/opensearch/docs/2/tutorial/6-scale-horizontally/index.html.md): Scale your Charmed OpenSearch cluster horizontally by adding or removing Juju units to handle growing data and traffic demands. - [Explanation](https://canonical.com/data/opensearch/docs/2/explanation/index.html.md): Deep-dive explanations of Charmed OpenSearch concepts including security, encryption, and authentication. - [Persistent storage and disk recovery](https://canonical.com/data/opensearch/docs/2/explanation/persistent-storage/index.html.md): Understand persistent storage, disk reuse risks, dangling indices, and last-resort coordination-metadata recovery in Charmed OpenSearch. - [Node roles and cluster topology](https://canonical.com/data/opensearch/docs/2/explanation/node-roles/index.html.md): Understand OpenSearch node roles, data tiers, and large deployment topology with the main orchestrator pattern in Charmed OpenSearch. - [Monitoring](https://canonical.com/data/opensearch/docs/2/explanation/monitoring/index.html.md): The OpenSearch charm integrates with the Canonical Observability Stack (COS) to provide infrastructu... - [Cluster health and scaling](https://canonical.com/data/opensearch/docs/2/explanation/cluster-health/index.html.md): Understand OpenSearch cluster health states (green, yellow, red), how they map to Juju status, and safe scaling practices in Charmed OpenSearch. - [Performance profiles](https://canonical.com/data/opensearch/docs/2/explanation/performance-profiles/index.html.md): Understand Charmed OpenSearch performance profiles, JVM heap sizing, and resource requirements for testing and production deployments. - [Software testing for charms](https://canonical.com/data/opensearch/docs/2/explanation/software-testing/index.html.md): Software testing guide for Charmed OpenSearch covering unit tests, integration tests, and performance benchmarking procedures. - [Security hardening guide](https://canonical.com/data/opensearch/docs/2/explanation/security/index.html.md): Comprehensive security hardening guide for Charmed OpenSearch covering cloud security, Juju security, and deployment best practices. - [TLS certificates](https://canonical.com/data/opensearch/docs/2/explanation/security/tls-certificates/index.html.md): Understand TLS certificate categories, rotation mechanics, and CA rotation in Charmed OpenSearch. - [Cryptography](https://canonical.com/data/opensearch/docs/2/explanation/security/cryptography/index.html.md): Understand cryptography implementation in Charmed OpenSearch including resource checksums, source verification, and SHA validation. --- For more comprehensive documentation, see [llms-full.txt](https://canonical.com/data/opensearch/docs/2/llms-full.txt)