Description
This component is resposible for setting up Elasticsearch for your instance.
Settings
As with all components, this component uses parent -> child inheritance. If you configure the settings on a parent instance, all child instances will initially inherit these settings.
Once the instance has rolled up you can change them as required.
| Setting | Description | Live Connector | Production | Development | Release Candidate |
|---|---|---|---|---|---|
| Enable | Whether Elastisearch should be enabled. | Y | Y | Y | Y |
| Version | The version of Elasticsearch to use. | Y | Y | Y | Y |
| Snapshot | The the snapshot use when creating development instances. (This can be use to make sure Elasticsearch has data in when the instance is initially created, avoiding the need to run a reindex). If set to "latest" and no snapshot found MDOQ will continue without importing a snapshot | Y | Y | Y | Y |
| Memory | The amount of memory allocated to Elasticsearch. This will update the -Xmx and -Xms service arguments. This can only be changed for MDOQ dedicated hosting. |
Y | Y | Y | Y |
| Direct Access | If enabled MDOQ will allow direct access to the Elasticsearch service via an auto-generated url. See here for more info. | Y | Y | Y | Y |
For Live connectors settings will only effect development instances, MDOQ can't alter you production infrastructure.
In Source Code Configuration
The is no source code configuration for this component
First time setup
There is no first time setup required, when you enable and recreate the component MDOQ will automatically configure your instance to use Elasticsearch.
If you have customer modules installed that require their own Elasticsearch configuration, the connection credentials will be:
- Host:
INSTANCE_ID-elastic-search(e.g if your instance ID is 1111 the host will be:1111-elastic-search - Port: 9200
- HTTP Auth: No
Direct Access
After enabling direct access within the instance settings you will need to synchronize Elasticsearch.
Once sync'd, three additional fields will be presented within the Elasticsearch settings for the instance:
- Username
- Password
- Url
Elasticsearch will be protect by basic authentication, the username and password will be displayed in under the Username and Password fields.
At present MDOQ will auto generate the username and the password, you cannot specify one.
The url presented will contain the username and password, so that you can visit it to check you have access.
The url for accessing Elasticsearch will always be in the format: https://elasticsearch-INSTANCE_ID.XX.mdoq.io
Reindexing
As part of the component creation MDOQ will look for an available Elasticsearch snapshot. If one exists MDOQ will import that and will not perform a reindex.
If one doesn't exist MDOQ will perform a reindex when the component is created.
Depending on your catalog size this can increase the time it takes to create an instance.
Using a snapshot can dramatically decrease the roll up time for larger catalogs. See Generating and storing an Elasticsearch snapshot for a guide on how to do this.