Installation
editInstallation
editDeploy Elastic Enterprise Search on Elastic Cloud or run the solution on-premises.
Get started now with a free Elastic Cloud trial:
Or, run self-managed deployments on your own infrastructure:
Deploying on Elastic Cloud
editDeploy Enterprise Search on Elastic Cloud with the following steps. For more details, see the relevant Elastic Cloud documentation.
Step 1. Log in to Elastic Cloud. If you’re using Elastic Cloud for the first time, create an account. New accounts include a free trial.
Step 2. Within Elastic Cloud, navigate to Create a deployment to create your Enterprise Search deployment. If you’re using a new account, your free trial starts you on this screen automatically.
Name your deployment.
Optionally, change the values of other fields, such as cloud provider and geographic region.
Click Create deployment to deploy Enterprise Search. All new deployments include Enterprise Search.
Step 3. While waiting for the deployment to start, download or copy the elastic
user password shown on the screen.
You don’t need these credentials now, but they are shown only once.
Record them securely.
When available, choose Open Enterprise Search, which redirects you to the Enterprise Search home screen.
You’re ready to use Enterprise Search!
App Search is packaged with Workplace Search as a single solution, but each product provides different tools to meet your use case.
Learn more to determine which is the best product for your needs:
From the Enterprise Search home screen, select the product to set up first.
Then, continue with the Getting Started documentation for your selected product:
Elastic Cloud documentation
editFor more information about Enterprise Search on Elastic Cloud, refer to the following Elastic Cloud documentation:
Resetting the Enterprise Search password
editIf you lose the password for the elastic
user, you will need to reset it through the Elastic Cloud console.
Navigate to the specific deployment within Elastic Cloud, and then click Manage and Reset password to get to the Security screen.
From there, click Reset password to complete the process.
Running on ECE (Elastic Cloud Enterprise)
editYou can deploy ECE on public or private clouds, virtual machines, or your own premises. ECE has supported Enterprise Search since version 2.6.
Learn how to enable Enterprise Search on ECE.
Running on ECK (Elastic Cloud on Kubernetes)
editOrchestrate Enterprise Search on Kubernetes using Elastic Cloud on Kubernetes (ECK), which supports Enterprise Search since ECK 1.2.
See Run Enterprise Search on ECK in the ECK documentation.
Running using Docker images
editElastic distributes Docker images for Enterprise Search for running the solution within your development environment or on production systems you have provisioned.
For help using these images, see Running Enterprise Search using Docker.
Running using tar, deb, and rpm packages
editElastic distributes tar, deb, and rpm packages to install Elasticsearch, Kibana and Enterprise Search within your development environment or on production systems you have provisioned.
Before installing Enterprise Search packages, you need to satisfy all dependencies:
- 64-bit Linux or MacOS (10.13+).
- Java 8 or Java 11.
- 6GB of available RAM (4GB if running Elasticsearch on a separate machine).
- 5GB of available storage.
- Running installation of Elasticsearch
- Running installation of Kibana
Follow the Enterprise Search download and installation steps for your distribution.
After installation, see Configuration for additional configuration details.
You’re ready to use Enterprise Search!
App Search is packaged with Workplace Search as a single solution, but each product provides different tools to meet your use case.
Learn more to determine which is the best product for your needs:
From the Enterprise Search home screen, select the product to setup first.
Then, continue with the Getting Started documentation for your selected product:
Elasticsearch cluster settings
editEnterprise Search makes alterations to the auto_create_index
persistent and transient settings within Elasticsearch when using allow_es_settings_modification: true
. Avoid making changes to those settings as it may result in unintended consequences.
An alternative approach involves setting the auto_create_index
configuration in elasticsearch.yml
for the target Elasticsearch cluster:
action.auto_create_index: ".ent-search-*-logs-*,-.ent-search-*,-test-.ent-search-*,+*"
Using this alternative approach allows you to maintain all Elasticsearch-specific settings at the cluster level.
Resetting the Enterprise Search password
editIf you’ve lost access to Enterprise Search, you can recover specific users or reset all access to Enterprise Search.
Refer to the following sections:
Elasticsearch version
editEnterprise Search should be configured to run against an Elasticsearch node of the same version. This is the officially supported configuration.
Running different major version releases of Enterprise Search and Elasticsearch (e.g. Enterprise Search 7.x and Elasticsearch 6.x) is not supported, nor is running a minor version of Enterprise Search that is newer than the version of Elasticsearch (e.g. Enterprise Search 7.14 and Elasticsearch 7.13).
Running a minor version of Elasticsearch that is higher than Enterprise Search will generally work in order to facilitate an upgrade process where Elasticsearch is upgraded first (e.g. Enterprise Search 7.13 and Elasticsearch 7.14). In this configuration, a warning will be logged on Enterprise Search server startup, so it’s only meant to be temporary until Enterprise Search is upgraded to the same version as Elasticsearch.
Running different patch version releases of Enterprise Search and Elasticsearch (e.g. Enterprise Search 7.13.0 and Elasticsearch 7.13.1) is generally supported, though we encourage users to run the same versions of Enterprise Search and Elasticsearch down to the patch version.
See also the Elastic support compatibility matrix.