WARNING: Version 5.6 of the Elastic Stack has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Introduction Migrating to X-Pack »
Elastic Docs ›X-Pack for the Elastic Stack [5.6]

Installing X-Pack

edit

Installing X-Pack

edit

To use X-Pack you need:

You must run the version of X-Pack that matches the version of Elasticsearch you are running.

X-Pack also provides a monitoring UI for Logstash.

To install X-Pack:

  1. Install X-Pack on Elasticsearch
  2. Install X-Pack on Kibana
  3. Install X-Pack on Logstash

The X-Pack installation scripts require direct internet access to download and install X-Pack. If your servers don’t have internet access, you can manually download the X-Pack zip file and transfer it to a temporary directory on the offline machines. The plugins for Elasticsearch, Kibana and Logstash are all included in a single zip file. For more information about installing X-Pack on offline machines, see the product-specific X-Pack installation instructions.

Enabling and Disabling X-Pack Features

edit

By default, all X-Pack features are enabled. You can enable or disable specific X-Pack features in the elasticsearch.yml, kibana.yml, and logstash.yml configuration files.

Setting Description

xpack.graph.enabled

Set to false to disable X-Pack graph features.

xpack.ml.enabled

Set to false to disable X-Pack machine learning features.

xpack.monitoring.enabled

Set to false to disable X-Pack monitoring features.

xpack.reporting.enabled

Set to false to disable X-Pack reporting features.

xpack.security.enabled

Set to false to disable X-Pack security features.

xpack.watcher.enabled

Set to false to disable Watcher.

For more information about which settings exist in each configuration file, see X-Pack Settings.

Upgrading X-Pack

edit

To upgrade X-Pack:

  1. Stop Elasticsearch.

  2. Uninstall X-Pack from Elasticsearch:

    bin/elasticsearch-plugin remove x-pack

  3. Install the new version of X-Pack into Elasticsearch.

    bin/elasticsearch-plugin install x-pack

  4. Restart Elasticsearch.

    If you’re upgrading a production cluster, perform a rolling upgrade to ensure recovery is as quick as possible. Rolling upgrades are supported when upgrading to a new minor version. A full cluster restart is required when upgrading to a new major version.

  5. Uninstall X-Pack from Kibana:

    bin/kibana-plugin remove x-pack

  6. Install the new version of X-Pack into Kibana.

    bin/kibana-plugin install x-pack
  7. Restart Kibana.

Uninstalling X-Pack

edit

To uninstall X-Pack:

  1. Stop Elasticsearch.

  2. Remove X-Pack from Elasticsearch:

    bin/elasticsearch-plugin remove x-pack
  3. Restart Elasticsearch.

  4. Remove X-Pack from Kibana:

    bin/kibana-plugin remove x-pack
  5. Restart Kibana.

  6. Remove X-Pack from Logstash:

    bin/logstash-plugin remove x-pack
  7. Restart Logstash.
« Introduction Migrating to X-Pack »