- Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure: other versions:
- Introducing Elastic Cloud Enterprise
- Preparing your installation
- Installing Elastic Cloud Enterprise
- Identify the deployment scenario
- Install ECE on a public cloud
- Install ECE on your own premises
- Alternative: Install ECE with Ansible
- Log into the Cloud UI
- Install ECE on additional hosts
- Migrate ECE to Podman hosts
- Post-installation steps
- Configuring your installation
- System deployments configuration
- Configure deployment templates
- Tag your allocators
- Edit instance configurations
- Create instance configurations
- Create deployment templates
- Configure system deployment templates
- Configure index management for templates
- Updating custom templates to support
node_roles
and autoscaling - Updating custom templates to support Integrations Server
- Default instance configurations
- Include additional Kibana plugins
- Manage snapshot repositories
- Manage licenses
- Change the ECE API URL
- Change endpoint URLs
- Enable custom endpoint aliases
- Configure allocator affinity
- Change allocator disconnect timeout
- Migrate ECE on Podman hosts to SELinux in
enforcing
mode
- Securing your installation
- Monitoring your installation
- Administering your installation
- Working with deployments
- Create a deployment
- Access Kibana
- Adding data to Elasticsearch
- Migrating data
- Ingesting data from your application
- Ingest data with Node.js on Elastic Cloud Enterprise
- Ingest data with Python on Elastic Cloud Enterprise
- Ingest data from Beats to Elastic Cloud Enterprise with Logstash as a proxy
- Ingest data from a relational database into Elastic Cloud Enterprise
- Ingest logs from a Python application using Filebeat
- Ingest logs from a Node.js web application using Filebeat
- Manage data from the command line
- Administering deployments
- Change your deployment configuration
- Maintenance mode
- Terminate a deployment
- Restart a deployment
- Restore a deployment
- Delete a deployment
- Migrate to index lifecycle management
- Disable an Elasticsearch data tier
- Access the Elasticsearch API console
- Work with snapshots
- Restore a snapshot across clusters
- Upgrade versions
- Editing your user settings
- Deployment autoscaling
- Configure Beats and Logstash with Cloud ID
- Keep your clusters healthy
- Keep track of deployment activity
- Secure your clusters
- Deployment heap dumps
- Deployment thread dumps
- Traffic Filtering
- Connect to your cluster
- Manage your Kibana instance
- Manage your APM & Fleet Server (7.13+)
- Manage your APM Server (versions before 7.13)
- Manage your Integrations Server
- Switch from APM to Integrations Server payload
- Enable logging and monitoring
- Enable cross-cluster search and cross-cluster replication
- Access other deployments of the same Elastic Cloud Enterprise environment
- Access deployments of another Elastic Cloud Enterprise environment
- Access deployments of an Elasticsearch Service organization
- Access clusters of a self-managed environment
- Enabling CCS/R between Elastic Cloud Enterprise and ECK
- Edit or remove a trusted environment
- Migrate the cross-cluster search deployment template
- Enable App Search
- Enable Enterprise Search
- Enable Graph (versions before 5.0)
- Troubleshooting
- RESTful API
- Authentication
- API calls
- How to access the API
- API examples
- Setting up your environment
- A first API call: What deployments are there?
- Create a first Deployment: Elasticsearch and Kibana
- Applying a new plan: Resize and add high availability
- Updating a deployment: Checking on progress
- Applying a new deployment configuration: Upgrade
- Enable more stack features: Add Enterprise Search to a deployment
- Dipping a toe into platform automation: Generate a roles token
- Customize your deployment
- Remove unwanted deployment templates and instance configurations
- Secure your settings
- API reference
- Changes to index allocation and API
- Script reference
- Release notes
- Elastic Cloud Enterprise 3.7.3
- Elastic Cloud Enterprise 3.7.2
- Elastic Cloud Enterprise 3.7.1
- Elastic Cloud Enterprise 3.7.0
- Elastic Cloud Enterprise 3.6.2
- Elastic Cloud Enterprise 3.6.1
- Elastic Cloud Enterprise 3.6.0
- Elastic Cloud Enterprise 3.5.1
- Elastic Cloud Enterprise 3.5.0
- Elastic Cloud Enterprise 3.4.1
- Elastic Cloud Enterprise 3.4.0
- Elastic Cloud Enterprise 3.3.0
- Elastic Cloud Enterprise 3.2.1
- Elastic Cloud Enterprise 3.2.0
- Elastic Cloud Enterprise 3.1.1
- Elastic Cloud Enterprise 3.1.0
- Elastic Cloud Enterprise 3.0.0
- Elastic Cloud Enterprise 2.13.4
- Elastic Cloud Enterprise 2.13.3
- Elastic Cloud Enterprise 2.13.2
- Elastic Cloud Enterprise 2.13.1
- Elastic Cloud Enterprise 2.13.0
- Elastic Cloud Enterprise 2.12.4
- Elastic Cloud Enterprise 2.12.3
- Elastic Cloud Enterprise 2.12.2
- Elastic Cloud Enterprise 2.12.1
- Elastic Cloud Enterprise 2.12.0
- Elastic Cloud Enterprise 2.11.2
- Elastic Cloud Enterprise 2.11.1
- Elastic Cloud Enterprise 2.11.0
- Elastic Cloud Enterprise 2.10.1
- Elastic Cloud Enterprise 2.10.0
- Elastic Cloud Enterprise 2.9.2
- Elastic Cloud Enterprise 2.9.1
- Elastic Cloud Enterprise 2.9.0
- Elastic Cloud Enterprise 2.8.1
- Elastic Cloud Enterprise 2.8.0
- Elastic Cloud Enterprise 2.7.2
- Elastic Cloud Enterprise 2.7.1
- Elastic Cloud Enterprise 2.7.0
- Elastic Cloud Enterprise 2.6.2
- Elastic Cloud Enterprise 2.6.1
- Elastic Cloud Enterprise 2.6.0
- Elastic Cloud Enterprise 2.5.1
- Elastic Cloud Enterprise 2.5.0
- Elastic Cloud Enterprise 2.4.3
- Elastic Cloud Enterprise 2.4.2
- Elastic Cloud Enterprise 2.4.1
- Elastic Cloud Enterprise 2.4.0
- Elastic Cloud Enterprise 2.3.2
- Elastic Cloud Enterprise 2.3.1
- Elastic Cloud Enterprise 2.3.0
- Elastic Cloud Enterprise 2.2.3
- Elastic Cloud Enterprise 2.2.2
- Elastic Cloud Enterprise 2.2.1
- Elastic Cloud Enterprise 2.2.0
- Elastic Cloud Enterprise 2.1.1
- Elastic Cloud Enterprise 2.1.0
- Elastic Cloud Enterprise 2.0.1
- Elastic Cloud Enterprise 2.0.0
- Elastic Cloud Enterprise 1.1.5
- Elastic Cloud Enterprise 1.1.4
- Elastic Cloud Enterprise 1.1.3
- Elastic Cloud Enterprise 1.1.2
- Elastic Cloud Enterprise 1.1.1
- Elastic Cloud Enterprise 1.1.0
- Elastic Cloud Enterprise 1.0.2
- Elastic Cloud Enterprise 1.0.1
- Elastic Cloud Enterprise 1.0.0
- What’s new with the Elastic Stack
- About this product
Manage Elastic Stack versions
editManage Elastic Stack versions
editElastic Cloud Enterprise ships with a number of different versions of the Elastic Stack containing Elasticsearch and Kibana. Periodically, you might need to manage Elastic Stack versions for one of the following reasons:
- To add new versions of the Elastic Stack as they become available
- To obtain information about existing Elastic Stack versions
- To update existing versions of the Elastic Stack
- To add the Elastic Stack versions that shipped with a version of ECE that you upgraded to
New or updated versions of the Elastic Stack must be prepared to work with Elastic Cloud Enterprise and are provided as packs that you can download.
Elasticsearch 7.8 and later comes with Index Lifecycle Management (ILM) always enabled. Before upgrading to 7.8 or later, to avoid any unpredictable behavior it is important to configure hot-warm clusters on Elastic Cloud Enterprise with ILM rather than index curation. Check migrate to index lifecycle management for existing clusters, and configure index management for new clusters.
Most recent Elastic Stack packs
editThe following are the most recently released Elastic Stack packs for version 8.x, 7.x, and 6.x, respectively:
Required downloads | Minimum required ECE version |
---|---|
Elasticsearch, Kibana, APM, and Enterprise Search stack pack: 8.17.0 |
ECE 3.0.0 (+ Docker 20.10.10+ required for 8.16+) |
Elasticsearch, Kibana, APM, and Enterprise Search stack pack: 7.17.27 |
ECE 2.2.2 |
ECE 1.1.4 |
All available Elastic Stack packs
editFollowing is the full list of available packs containing Elastic Stack versions. Note that Enterprise Search was introduced with ECE 2.6.0 and requires that version or higher.
Expand to view the full list
For offline or air-gapped installations, additional steps are required to add Elastic Stack packs, as these packs do not contain any Docker images. After downloading a stack pack, you also need to pull and load the Docker images that match the Elastic Stack version. To learn more about what Docker images you need and about pulling and loading Docker images, check Install ECE offline.
Before you begin
editThe examples shown all use HTTPS over port 12443, which requires that you have a TLS certificate configured. Alternatively, you can specify the -k
option to turn off certificate verification, as shown in our examples, or use HTTP over port 12400.
Get Elastic Stack information
editYou can obtain information about existing Elastic Stack versions that are available in your installation through the Cloud UI or through the command line.
To obtain information about available Elastic Stack versions through the Cloud UI:
- Log into the Cloud UI.
- From the Platform menu, select Elastic Stack.
-
Select the version that you want.
The available Elastic Stack versions are shown. More detailed information about Docker images, plugins, and related Kibana versions are also available for each Elasticsearch version.
To obtain information about available Elastic Stack versions through the command line:
curl -X GET -u USER:PASSWORD https://COORDINATOR_HOST:12443/api/v1/stack/versions
For example (output abridged for brevity):
curl -X GET -u admin:4Z52y8Gq7PrxMDy47ipJPSh4ozBMynOGa9HWxcy2D3j https://10.56.12.153:12443/api/v1/stack/versions { "stacks": [ { "version": "2.4.5", "template": { "template_version": "", "hashes": [] }, "elasticsearch": { "docker_image": "docker.elastic.co/cloud-enterprise/elasticsearch:2.4.5-0", "plugins": [ "graph", "analysis-icu", "analysis-kuromoji", "analysis-smartcn", "analysis-stempel", "analysis-phonetic", "watcher", "mapper-attachments", "delete-by-query" ], "default_plugins": [ "found-elasticsearch", "cloud-aws", "found-license-plugin", "shield", "marvel-agent" ... ] } }, { "version": "5.2.2", "template": { "template_version": "", "hashes": [] }, "elasticsearch": { "docker_image": "docker.elastic.co/cloud-enterprise/elasticsearch:5.2.2-0", "plugins": [ "analysis-icu", "analysis-kuromoji", "analysis-smartcn", "analysis-stempel", "analysis-phonetic", "mapper-attachments", "ingest-attachment", "ingest-geoip", "ingest-user-agent" ], "default_plugins": [ "repository-s3", "found-elasticsearch", "x-pack" ... ] } } ] }
You can also query for a specific version with a URI such as https://COORDINATOR_HOST:12443/api/v1/stack/versions/5.3.2
, for example.
Add Elastic Stack packs
editYou can add new Elastic Stack packs to your installation through the Cloud UI, through the Elastic Cloud Enterprise installation script, or through the RESTful API.
To add a new Elastic Stack pack from the Cloud UI:
- Download the Elastic Stack version that you want.
- Log into the Cloud UI.
- From the Platform menu, select Elastic Stack.
- Select Upload Elastic Stack pack.
-
Select a .zip file that contains an Elastic Stack pack and upload it.
After the stack pack has been uploaded successfully, the new version appears in the list of Elastic Stack versions and can be used when you create or change a deployment.
To add a new Elastic Stack pack through the Elastic Cloud Enterprise installation script from the command line:
- Log into a host running Elastic Cloud Enterprise.
-
Add the Elastic Stack pack with the
add-stack-version
action:For example:
bash elastic-cloud-enterprise.sh add-stack-version \ --user admin --pass pGX5DwKzVAAIeCIpTwwAkCuJDu0ASdFP33UmYpfogfF \ --version 5.4.0
To add a new Elastic Stack pack through the RESTful API from the command line:
- Download the pack on an internet-connected host from Elastic and make it available locally.
-
Add the Elastic Stack pack with the following API call:
curl -X POST -u USER:PASSWORD https://COORDINATOR_HOST:12443/api/v1/stack/versions \ -H 'content-type: application/zip' \ --data-binary "@PATH/STACK_PACK_FILE"
For example:
curl -X POST -u admin:pGX5DwKzVAAIeCIpTwwAkCuJDu0ASdFP33UmYpfogfF https://10.56.12.153:12443/api/v1/stack/versions \ -H 'content-type: application/zip' \ --data-binary "@/Users/iuriitceretian/Documents/stacks/5.4.0.zip"
Update Elastic Stack packs
editUpdating an Elastic Stack pack might become necessary if an Elastic Stack version has been updated with security fixes, for example. You can update an existing Elastic Stack version through the Cloud UI or through the command line.
Updated versions of Elasticsearch and Kibana are used when you create new Elasticsearch clusters, but they are not automatically applied to already running clusters. To update existing Elasticsearch clusters and Kibana after an updated Elastic Stack pack has been added, you need to change the deployment configuration.
To update Elastic Stack packs through the Cloud UI:
- Download the Elastic Stack version that you want.
- Log into the Cloud UI.
- From the Platform menu, select Elastic Stack.
- Delete the old pack you want to replace.
- Select Upload Elastic Stack pack.
-
Select a ZIP file that contains an Elastic Stack pack and upload it.
After the stack pack has been uploaded successfully, the updated Elastic Stack version replaces the existing one.
To update Elastic Stack packs through the RESTful API from the command line:
- Download an updated pack on an internet-connected host from Elastic and make it available locally.
-
Update the Elastic Stack pack with the following API call:
curl -X PUT -u USER:PASSWORD https://COORDINATOR_HOST:12443/api/v1/stack/versions/VERSION \ -H 'content-type: application/zip' \ --data-binary "@PATH/STACK_PACK_FILE"
For example:
curl -X PUT -u admin:pGX5DwKzVAAIeCIpTwAAkCuJDu0ASdFP33UmYpfogfF https://10.58.12.153:12443/api/v1/stack/versions/6.4.0 \ -H 'content-type: application/zip' \ --data-binary "@/Users/johnsmith/Documents/stacks/6.4.0.zip"
On this page