For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/it/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/it/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/it/guides/public-cloud/databases/opensearch-capabilities.md.
Vai al contenuto

OpenSearch - Capabilities and Limitations

Vedi come Markdown

Discover the capabilities and limitations of Public Cloud Databases for OpenSearch

Objective

This page provides the technical capabilities and limitations of the Public Cloud Databases for OpenSearch offer.

We continuously improve our offers. You can follow and submit ideas to add to our roadmap at https://github.com/orgs/ovh/projects/16/views/5.

Capabilities and limitations

Supported regions and multi-AZ

The Public Cloud Databases offer is available in all Public Cloud 1-AZ and 3-AZ regions.

Database nodes have to be in the same region.

OpenSearch versions

The Public Cloud Databases offer supports the following OpenSearch versions:

  • OpenSearch 2.19
  • OpenSearch 3.3

Please refer to the lifecycle policy guide for recommendations on version upgrades and end of life announcements of major versions. Additionally, you can follow the OpenSearch version history on their official page: https://docs.opensearch.org/latest/version-history/.

OpenSearch clients and plugins compatibility

You can use any of the OpenSearch language clients to access and populate your instance. For the plugins enabled by default, see the Plugin enabled by default section.

Plans

Three plans are available:

  • Essential/Discovery: 1 node
  • Business/Production: 3 nodes
  • Enterprise/Advanced: 6 nodes

In 3-AZ regions (for example EU-WEST-PAR), only the Discovery, Production and Advanced plans are available.

Your choice of plan affects the number of nodes your cluster can run, the SLA, and a few other features such as backup retention.

License type

OpenSearch software is under the Apache 2.0 license, a liberal open-source license. More information on https://github.com/opensearch-project/.

Hardware resources

For detailed information about node types and pricing, please refer to the Public Cloud pricing page.

Features

Plugin enabled by default

Here is the list of plugins enabled by default:

  • ICU Analysis
  • Phonetic Analysis
  • kuromoji (Japanese Analysis)
  • Mapper Size
  • OpenSearch SQL plugin
  • OpenSearch Alerting plugin
  • Anomaly detection
  • Asynchronous search
  • Index Management
  • k-NN
  • Notebooks
  • Performance Analyzer
  • OpenSearch Dashboards Reports
  • Scheduler for Dashboards Reports
  • OpenSearch Dashboards GANTT Charts
  • OpenSearch Dashboards Trace Analytics

Network

OpenSearch clusters are reachable through the port specified in the OVHcloud Console or API, which is specific to each service. OpenSearch Dashboards is reachable over HTTPS (port 443) on the same host. TLS is always enabled.

Public as well as private networking (vRack) can be used for all the offers.

Ingress and Egress traffic are included in the service plans and unmetered.

The database service's IP address is subject to change periodically. Thus, it is advised not to rely on these IPs for any configuration, such as connection or egress policy. Instead, utilize the provided DNS record and implement CIDR-based egress policies for more robust and flexible network management.

Private network considerations

Here are some considerations to take into account when using private network:

  • Network ports are created in the private network of your choice. Thus, further operations on that network might be restricted - e.g. you won’t be able to delete the network if you didn’t stop the Public Cloud Databases services first.
  • When connecting from an outside subnet, the Openstack IP gateway must be enabled in the subnet used for the Database service. The customer is responsible for any other custom network setup.
  • Subnet sizing should include considerations for service nodes, other co-located services within the same subnet, and an allocation of additional available IP addresses for maintenance purposes. Failure to adequately size subnets could result in operational challenges and the malfunctioning of services.
  • OpenStack subnets routes announcement will not be applied to your services.
  • You can only create private network services if you are the original owner of the network. You can not create private network services on a shared network.
Authorised IPs

Once your service is up and running, you will be able to specify IP addresses (or CIDR blocks) to authorise incoming traffic. Until then, your service will be unreachable.

Advanced parameters

You can further customise your OpenSearch by using advanced parameters. See the Advanced parameters references documentation for more information on the supported parameters, and the advanced configuration guide to change them. Changing the advanced configuration may restart the service.

Backups

Essential/Discovery plan clusters are automatically backed up hourly and daily. Backup retention is 24 hours for hourly backups and 3 days for daily backups.

Business/Production plan clusters are automatically backed up hourly and daily. Backup retention is 24 hours for hourly backups and 14 days for daily backups.

Enterprise/Advanced plan clusters are automatically backed up hourly and daily. Backup retention is 24 hours for hourly backups and 30 days for daily backups.

Backups can be restored by duplicating them to a new service. They cannot be deleted, and Point In Time Recovery (PITR) is not available for OpenSearch.

See the Automated Backups guide and the Restore a backup guide for more information.

Logs and metrics

Logs and metrics are available through the OVHcloud Console, API and can be forwarded to Logs Data Platform. Metrics can also be collected through a Prometheus endpoint, disabled by default (see the Prometheus guide). Additionally, cross service integration can be configured so that other Public Cloud Databases services (for example MySQL or PostgreSQL) send their logs to your OpenSearch service, where you can explore them with OpenSearch Dashboards. See the Cross Service Integration documentation for more information. For more details on logs forwarding, see the How to set up logs forwarding guide.

  • Logs retention: 1000 lines of logs
  • Metrics retention: 1 calendar month

Please note that if the database instance is deleted, logs and metrics are also automatically deleted.

Index patterns (index retention)

The Index patterns tab of the OVHcloud Console (also available through the API) lets you limit the number of indexes kept for a given pattern. For each pattern, you set a Max index count (0 means unlimited): when more indexes match the pattern, the oldest ones are deleted. This is useful, for example, to keep a given number of days of logs when one index is created per day.

The same tab lists the indexes of your service, which you can delete. Indexes cannot be created from the OVHcloud Console or the OVHcloud API: they are created through the OpenSearch API, or automatically on first write.

Users

You can create service users via the OVHcloud Console and API. A default user, avnadmin, is created without any ACL rule: when ACLs are enabled, it has no access until you give it the admin permission on the * pattern.

By default, you can create up to 50 service users per service. If you need more than 50 users, contact OVHcloud Support to request a limit increase.

Access control (ACL)

We support index-level access control lists (ACL) to control permissions. This approach allows you to limit the operations that are available to specific connections and to restrict access to certain data sets, which improves the security of your data.

You can grant the following permissions:

  • deny: no access
  • admin: full access to APIs and documents
  • readwrite: full access to documents
  • read: allow only searching and retrieving documents
  • write: allow updating, adding, and deleting documents

Note: Write permission allows the service user to create new indexes that match the pattern, but it does not allow deletion of those indexes.

Rules are defined separately for each user as pattern/permission combinations. The pattern defines the indexes that the permission applies to. Patterns are glob-style, where * matches any number of characters and ? matches any character.

When multiple rules match, they are applied in the order listed above. If no rules match, access is denied.

Controlling access to top-level APIs

OpenSearch has several "top-level" API endpoints (_mget, _msearch, and so on). When ACLs are enabled (Enable ACLs switch in the Users tab, disabled by default), requests to these endpoints are checked against the user's index rules: a user can, for example, run _msearch or _mget on the indexes it is allowed to access, without any dedicated rule. To grant broader access to top-level APIs, use patterns similar to the index patterns, for example:

  • _*/admin grants unlimited access to all top-level APIs
  • _msearch/admin grants unlimited access to the _msearch API only

Access control and OpenSearch Dashboards

Enabling ACLs does not restrict access to OpenSearch Dashboards itself, but all requests done by OpenSearch Dashboards are checked against the current user's ACLs: a user only sees and queries the indexes its rules allow.

We want your feedback!

We would love to help answer questions and appreciate any feedback you may have.

For training or technical assistance implementing our solutions, contact your sales representative or visit our Professional Services page to request a quote and have your project analysed by our experts.

Are you on Discord? Connect to our channel at https://discord.gg/ovhcloud and interact directly with the team that builds our databases service!

Questa pagina ti è stata utile?