Revision 168 release notes
24 September 2024
Charmed OpenSearch Revision 168 has been deployed to the 2/stable
channel on Charmhub.
To upgrade from a previous revision of the OpenSearch charm, see how to perform a minor upgrade.
Summary
- Highlights and features
- Requirements and compatibility
- Integrations
- Software contents
- Known issues and limitations
- Join the community
Highlights
This section goes over the features included in this release, starting with a description of major highlights, and finishing with a comprehensive list of all other features.
Large scale deployments
Deploy a single OpenSearch cluster composed of multiple Juju applications. Each application executes any of the available roles in OpenSearch. Large deployments support a diverse range of deployment constraints, roles, and regions.
Security automations
Manage TLS certificates and passwords in single point with Juju integrations and rotate your TLS certificates without any downtime.
Monitoring
Integrate with the Canonical Observability Stack (COS) and the OpenSearch Dashboards charm to monitor operational performance and visualize stored data across all clusters.
Backups
Backup and restore with an Amazon S3-compatible storage backend.
Other features
- Automated rolling restart
- Automated minor upgrade of OpenSearch version
- Automated deployment for single and multiple clusters
- Backup and restore for single and multiple clusters
- User management and automated user and index setup with the Data Integrator charm
- TLS encryption (HTTP and transport layers) and certificate rotation
- Observability of OpenSearch clusters and operational tooling via COS and the OpenSearch Dashboards charm
- Plugin management: Index State Management, KNN and MLCommons
- OpenSearch security patching and bug-fixing mechanisms
For a detailed list of commits throughout all revisions, check our GitHub Releases.
Requirements and compatibility
- Juju
v3.5.3+
- Older minor versions of Juju 3 may be compatible, but are not officially supported.
- LXD
v6.1
- Older LXD versions may be compatible, but are not officially supported.
- Integration with a TLS charm
self-signed-certificates
revision 155+ ormanual-tls-certificates
revision 108+
See the system requirements page for more information about software and hardware prerequisites.
Integrations
Like all Juju charms, OpenSearch can easily integrate with other charms by implementing common interfaces/endpoints.
OpenSearch can be seamlessly integrated out of the box with:
- TLS certificates charms
- Note: Charmed OpenSearch supports integration with tls-certificates library
v2
or higher. - See also: How to enable TLS
- Note: Charmed OpenSearch supports integration with tls-certificates library
- COS Lite
- OpenSearch Dashboards
- Data Integrator
- S3 Integrator
See the Integrations page for a list of all interfaces and compatible charms.
Software contents
This charm is based on the Canonical opensearch-snap. It packages:
- OpenSearch v2.17.0
- OpenJDK
v21
Known issues and limitations
The following issues are known and scheduled to be fixed in the next maintenance release.
- We currently do not support node role repurposing from cluster manager to a non cluster manager
- Storage re-attachment from previous clusters is not currently automated. For manual instructions, see the how-to guide How to recover from attached storage.
Join the 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.