Virto Commerce OpenSearch Module

The Virto Commerce OpenSearch module implements the ISearchProvider defined in the VirtoCommerce Search module. It leverages the OpenSearch engines to store indexed documents.

The module supports the following OpenSearch deployment options:

• OpenSearch
• Amazon OpenSearch Service

Configuration

The OpenSearch Search provider can be configured using the following keys:

• Search.Provider: Specifies the search provider name, which must be set to "OpenSearch".
• Search.Scope: Specifies the common name (prefix) for all indexes. Each document type is stored in a separate index, and the full index name is scope-{documenttype}. This allows one search service to serve multiple indexes. (Optional: Default value is "default".)
• Search.OpenSearch.Server: Specifies the network address and port of the OpenSearch server.
• Search.OpenSearch.User: Specifies the username for private OpenSearch server. (Optional: Default value is "openSearch".)
• Search.OpenSearch.Password: Specifies the password for either the Elastic Cloud cluster or private OpenSearch server. (Optional)
• Search.OpenSearch.EnableHttpCompression: Set this to "true" to enable gzip compressed requests and responses or "false" (default) to disable compression. (Optional)

For more information about configuration settings, refer to the Virto Commerce Configuration Settings documentation.

Samples

Here are some sample configurations:

OpenSearch v2.x

For OpenSearch v2.x without security features enabled:

"Search": {
    "Provider": "OpenSearch",
    "Scope": "default",
    "OpenSearch": {
        "Server": "https://localhost:9200"
    }
}

For OpenSearch v2.x with ApiKey authorization:

"Search": {
    "Provider": "OpenSearch",
    "Scope": "default",
    "OpenSearch": {
        "Server": "https://localhost:9200",
        "User": "{USER_NAME}",
        "Password": "{PASSWORD}"
    }
}

Documentation

• REST API
• View on GitHub

References

• Deployment
• Installation
• Home
• Community
• Download latest release

License

Copyright (c) Virto Solutions LTD. All rights reserved.

Licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://virtocommerce.com/opensourcelicense

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.