Upgrading Open Distro for Elasticsearch

This section guides through the upgrade process of Elasticsearch, Filebeat and Kibana for Open Distro for Elasticsearch distribution.

Note

Root user privileges are required to execute all the commands described below.

Preparing Open Distro for Elasticsearch

  1. Stop the services:

    # systemctl stop filebeat
    # systemctl stop kibana
    
  2. Prepare the repositories. Wazuh now hosts the Open Distro packages. In order to prevent accidental upgrades, it is recommended to disable the Open Distro repository. Besides, if Elastic repository was added, it is also recommended to disable it:

2.1. Disable the Open Distro for Elasticsearch repository:

# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/opendistroforelasticsearch-artifacts.repo

2.2. (Optional) Disable the Elastic Stack basic license repository:

# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/elastic.repo

2.3. Add the Wazuh 4.x repository:

  1. Import the GPG key:

    # rpm --import https://packages.wazuh.com/key/GPG-KEY-WAZUH
    
  2. Add the repository:

    # cat > /etc/yum.repos.d/wazuh.repo << EOF
    [wazuh]
    gpgcheck=1
    gpgkey=https://packages.wazuh.com/key/GPG-KEY-WAZUH
    enabled=1
    name=EL-$releasever - Wazuh
    baseurl=https://packages.wazuh.com/4.x/yum/
    protect=1
    EOF
    
  1. Clean the YUM cache:

# yum clean all

Upgrading Elasticsearch

This guide explains how to perform a rolling upgrade, which allows you to shut down one node at a time for minimal disruption of service. The cluster remains available throughout the process.

In the commands below 127.0.0.1 IP address is used. If Elasticsearch is bound to a specific IP address, replace 127.0.0.1 with your Elasticsearch IP. If using http, the option -k must be omitted and if not using user/password authentication, -u must be omitted.

  1. Disable shard allocation:

    curl -X PUT "https://127.0.0.1:9200/_cluster/settings"  -u <username>:<password> -k -H 'Content-Type: application/json' -d'
    {
      "persistent": {
        "cluster.routing.allocation.enable": "primaries"
      }
    }
    '
    
  2. Stop non-essential indexing and perform a synced flush:

    curl -X POST "https://127.0.0.1:9200/_flush/synced" -u <username>:<password> -k
    
  3. Shut down a single node:

    # systemctl stop elasticsearch
    
  4. Upgrade the node you shut down:

    # yum install opendistroforelasticsearch-1.11.0
    
  5. Restart the service:

    # systemctl daemon-reload
    # systemctl enable elasticsearch
    # systemctl start elasticsearch
    
  6. Start the newly-upgraded node and confirm that it joins the cluster by checking the log file or by submitting a _cat/nodes request:

    curl -X GET "https://127.0.0.1:9200/_cat/nodes" -u <username>:<password> -k
    
  7. Reenable shard allocation:

    curl -X PUT "https://127.0.0.1:9200/_cluster/settings" -u <username>:<password> -k -H 'Content-Type: application/json' -d'
    {
      "persistent": {
        "cluster.routing.allocation.enable": "all"
      }
    }
    '
    
  8. Before upgrading the next node, wait for the cluster to finish shard allocation:

    curl -X GET "https://127.0.0.1:9200/_cat/health?v" -u <username>:<password> -k
    
  9. Repeat the steps for every Elasticsearch node.

Note

The Open Distro for Elasticsearch performance analyzer plugin is installed by default and can have a negative impact on system resources. We recommend removing it with the following command /usr/share/elasticsearch/bin/elasticsearch-plugin remove opendistro_performance_analyzer. Please be sure to restart the Elasticsearch service afterwards.

Upgrading Filebeat

  1. Upgrade Filebeat:

    # yum install filebeat-7.9.1
    
  2. Download the alerts template for Elasticsearch:

    # curl -so /etc/filebeat/wazuh-template.json https://raw.githubusercontent.com/wazuh/wazuh/v4.0.4/extensions/elasticsearch/7.x/wazuh-template.json
    # chmod go+r /etc/filebeat/wazuh-template.json
    
  3. Download the Wazuh module for Filebeat:

    # curl -s https://packages.wazuh.com/4.x/filebeat/wazuh-filebeat-0.1.tar.gz | sudo tar -xvz -C /usr/share/filebeat/module
    
  4. Edit the /etc/filebeat/filebeat.yml configuration file. This step is only needed for the upgrade of a Distributed installation. In case of having an All-in-one installation, the file is already configured:

    output.elasticsearch:
      hosts: ["<elasticsearch_ip>:9200"]
    

    Replace elasticsearch_ip with the IP address or the hostname of the Elasticsearch server.

    During the installation, the default username and password were used. If those credentials were changed, replace those values in the filebeat.yml configuration file.

  5. Restart Filebeat:

    # systemctl daemon-reload
    # systemctl enable filebeat
    # systemctl start filebeat
    
  6. Upload the new Wazuh template to Elasticsearch. This step can be omitted in Wazuh single-node installations:

# filebeat setup --index-management -E output.logstash.enabled=false

Upgrading Kibana

Warning

Since Wazuh 3.12.0 release, regardless of the Elastic Stack version, the location of the Wazuh Kibana plugin configuration file has been moved from /usr/share/kibana/plugins/wazuh/wazuh.yml, for the version 3.11.x, and from /usr/share/kibana/plugins/wazuh/config.yml, for the version 3.10.x or older, to /usr/share/kibana/optimize/wazuh/config/wazuh.yml.

Copy the Wazuh Kibana plugin configuration file to its new location. This step is not needed for upgrades from 3.12.x to 3.13.x:

Create the new directory and copy the Wazuh Kibana plugin configuration file:

# mkdir -p /usr/share/kibana/optimize/wazuh/config
# cp /usr/share/kibana/plugins/wazuh/wazuh.yml /usr/share/kibana/optimize/wazuh/config/wazuh.yml
  1. Replace the value user by username and set the username and password as wazuh in the file /usr/share/kibana/optimize/wazuh/config/wazuh.yml:

    hosts:
      - default:
          url: https://localhost
          port: 55000
          username: wazuh
          password: wazuh
          run_as: false
    
  2. Remove the Wazuh Kibana plugin:

    # cd /usr/share/kibana/
    # sudo -u kibana bin/kibana-plugin remove wazuh
    
  3. Upgrade Kibana:

    # yum install opendistroforelasticsearch-kibana-1.11.0
    
  4. Remove generated bundles and the wazuh-registry.json file:

    # rm -rf /usr/share/kibana/optimize/bundles
    # rm -f /usr/share/kibana/optimize/wazuh/config/wazuh-registry.json
    
  5. Update file permissions. This will prevent errors when generating new bundles or updating the Wazuh Kibana plugin:

    # chown -R kibana:kibana /usr/share/kibana/optimize
    # chown -R kibana:kibana /usr/share/kibana/plugins
    
  6. Install the Wazuh Kibana plugin:

    # cd /usr/share/kibana/
    # sudo -u kibana /usr/share/kibana/bin/kibana-plugin install https://packages.wazuh.com/4.x/ui/kibana/wazuh_kibana-4.0.4_7.9.1-1.zip
    
  7. Update configuration file permissions:

    # sudo chown kibana:kibana /usr/share/kibana/optimize/wazuh/config/wazuh.yml
    # sudo chmod 600 /usr/share/kibana/optimize/wazuh/config/wazuh.yml
    
  8. For installations on Kibana 7.6.x version and higher, it is recommended to increase the heap size of Kibana to ensure the Kibana's plugins installation:

    # cat >> /etc/default/kibana << EOF
    NODE_OPTIONS="--max_old_space_size=2048"
    EOF
    
  9. Link Kibana’s socket to privileged port 443:

    # setcap 'cap_net_bind_service=+ep' /usr/share/kibana/node/bin/node
    
  10. Restart Kibana:

    # systemctl daemon-reload
    # systemctl enable kibana
    # systemctl start kibana
    
  11. Once Kibana is accesible, remove the wazuh-alerts-3.x-* index pattern. Since Wazuh 4.0 it has been replaced by wazuh-alerts-* , it is necessary to remove the old pattern in order for the new one to take its place.

    # curl 'https://<kibana_ip>:<kibana_port>/api/saved_objects/index-pattern/wazuh-alerts-3.x-*' -X DELETE  -H 'Content-Type: application/json' -H 'kbn-version: 7.9.1' -k -uadmin:admin
    

    If you have a custom index pattern, be sure to replace it accordingly.

  12. Clean the browser's cache and cookies.

Disabling the repository

It is recommended to disable the Wazuh repository to prevent an upgrade to a newest Elastic Stack version due to the possibility of undoing changes with the Wazuh Kibana plugin:

# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo

Next step

The next step consists on upgrading the Wazuh agents.