Wazuh and Elastic Stack basic license

This section guides you through the upgrade process of the Wazuh server, Elasticsearch, and Kibana for the Elastic Stack basic license distribution.

Note

This guide is meant for upgrades from 7.x to 7.y. The upgrade instructions for Elastic Stack versions prior to 7.0 can be found in the Upgrading Elastic Stack from a legacy version section.

Note

You need root user privileges to run all the commands described below.

Preparing the upgrade

  1. Add the Wazuh repository. You can skip this step if the repository is already present and enabled on the node.

    Yum

    APT

    1. Import the GPG key.

      # rpm --import https://packages.wazuh.com/key/GPG-KEY-WAZUH

    2. Add the repository.

      # echo -e '[wazuh]\ngpgcheck=1\ngpgkey=https://packages.wazuh.com/key/GPG-KEY-WAZUH\nenabled=1\nname=EL-$releasever - Wazuh\nbaseurl=https://packages.wazuh.com/4.x/yum/\nprotect=1' | tee /etc/yum.repos.d/wazuh.repo

    1. Install the following packages if missing.

      # apt-get install gnupg apt-transport-https

    2. Install the GPG key.

      # curl -s https://packages.wazuh.com/key/GPG-KEY-WAZUH | gpg --no-default-keyring --keyring gnupg-ring:/usr/share/keyrings/wazuh.gpg --import && chmod 644 /usr/share/keyrings/wazuh.gpg

    3. Add the repository.

      # echo "deb [signed-by=/usr/share/keyrings/wazuh.gpg] https://packages.wazuh.com/4.x/apt/ stable main" | tee -a /etc/apt/sources.list.d/wazuh.list

    4. Update the packages information.

      # apt-get update

  2. Repeat the previous steps for every Wazuh node.

Upgrading the Wazuh manager

When upgrading a multi-node Wazuh manager cluster, run the upgrade in every node to make all the Wazuh manager nodes join the cluster. Start with the master node to reduce server downtime.

Note

Upgrading from Wazuh 4.2.x or lower creates the wazuh operating system user and group to replace ossec. To avoid upgrade conflicts, make sure that the wazuh user and group are not present in your operating system.

  1. Upgrade the Wazuh manager to the latest version.

    Yum

    APT

    # yum upgrade wazuh-manager

    # apt-get install wazuh-manager

    Note

    If the /var/ossec/etc/ossec.conf configuration file was modified, it will not be replaced by the upgrade. You will therefore have to add the settings of the new capabilities manually. More information can be found in User manual.

  2. Repeat the previous steps for every Wazuh manager node.

Upgrading Elastic Stack

Preparations

  1. Stop the services:

    Systemd

    SysV init

    # systemctl stop filebeat
# systemctl stop kibana

    # service filebeat stop
# service kibana stop

  2. Add the Elastic Stack repository:

    Yum

    APT

    ZYpp

    1. Import the GPG key:

      # rpm --import https://artifacts.elastic.co/GPG-KEY-elasticsearch

    2. Add the repository:

      # cat > /etc/yum.repos.d/elastic.repo << EOF
[elasticsearch-7.x]
name=Elasticsearch repository for 7.x packages
baseurl=https://artifacts.elastic.co/packages/7.x/yum
gpgcheck=1
gpgkey=https://artifacts.elastic.co/GPG-KEY-elasticsearch
enabled=1
autorefresh=1
type=rpm-md
EOF

    1. Install the GPG key:

      # curl -s https://artifacts.elastic.co/GPG-KEY-elasticsearch | gpg --no-default-keyring --keyring gnupg-ring:/usr/share/keyrings/elasticsearch.gpg --import && chmod 644 /usr/share/keyrings/elasticsearch.gpg

    2. Add the repository:

      # echo "deb [signed-by=/usr/share/keyrings/elasticsearch.gpg] https://artifacts.elastic.co/packages/7.x/apt stable main" | tee /etc/apt/sources.list.d/elastic-7.x.list

    3. Update the package information:

      # apt-get update

    1. Import the GPG key:

      # rpm --import https://packages.elastic.co/GPG-KEY-elasticsearch

    2. Add the repository:

      # cat > /etc/zypp/repos.d/elastic.repo <<\EOF
[elasticsearch-7.x]
name=Elasticsearch repository for 7.x packages
baseurl=https://artifacts.elastic.co/packages/7.x/yum
gpgcheck=1
gpgkey=https://artifacts.elastic.co/GPG-KEY-elasticsearch
enabled=1
autorefresh=1
type=rpm-md
EOF

  3. Before the upgrade process, it is important to ensure that the Wazuh repository is disabled, as it contains Filebeat packages used by Open Distro for Elasticsearch distribution, which might be accidentally installed instead of the Elastic package. In case of having enabled the Wazuh repository, it can be disabled using:

    Yum

    APT

    ZYpp

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

    # sed -i "s/^deb/#deb/" /etc/apt/sources.list.d/wazuh.list
# apt-get update

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

Upgrade

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.

The IP address 127.0.0.1 is used in the commands below. If Elasticsearch is bound to a specific IP address, replace 127.0.0.1 with your Elasticsearch IP address. 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:

    Systemd

    SysV init

    # systemctl stop elasticsearch

    # service elasticsearch stop

  4. Upgrade the node you shut down:

    Yum

    APT

    ZYpp

    # yum install elasticsearch-7.17.9

    # apt-get install elasticsearch=7.17.9

    It's recommended to keep your currently installed version of the configuration file (option N or O if prompted).

    # zypper update elasticsearch-7.17.9

  5. Restart the service:

    Systemd

    SysV init

    # systemctl daemon-reload
# systemctl enable elasticsearch
# systemctl start elasticsearch

    Choose one option according to the OS used:

    1. Debian based OS

    # update-rc.d elasticsearch defaults 95 10
# service elasticsearch start

    1. RPM based OS

    # chkconfig --add elasticsearch
# service elasticsearch start

  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.

Upgrading Filebeat

The following steps need to be run in the Wazuh server or servers in the case of Wazuh multi-node cluster.

  1. Upgrade Filebeat:

    Yum

    APT

    ZYpp

    # yum install filebeat-7.17.9

    # apt-get install filebeat=7.17.9

    It's recommended to keep your currently installed version of the configuration file (option N or O if prompted).

    # zypper update filebeat-7.17.9

  2. Download the alerts template for Elasticsearch:

    # curl -so /etc/filebeat/wazuh-template.json https://raw.githubusercontent.com/wazuh/wazuh/v4.4.3/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.2.tar.gz | sudo tar -xvz -C /usr/share/filebeat/module

  4. Edit the /etc/filebeat/filebeat.yml configuration file. Replace YOUR_ELASTIC_SERVER_IP with the IP address or the hostname of the Elasticsearch server. For example:

    output.elasticsearch.hosts: ['http://YOUR_ELASTIC_SERVER_IP:9200']

  5. Restart Filebeat:

    Systemd

    SysV init

    # systemctl daemon-reload
# systemctl enable filebeat
# systemctl start filebeat

    Choose one option according to the OS used:

    1. Debian based OS

    # update-rc.d filebeat defaults 95 10
# service filebeat start

    1. RPM based OS

    # chkconfig --add filebeat
# service filebeat start

  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

The location of the Wazuh Kibana plugin configuration file has been moved to /usr/share/kibana/data/wazuh/config/wazuh.yml

  1. Copy the Wazuh Kibana plugin configuration file to its new location:

    For upgrades from 3.12.x or newer

    For upgrades from 3.11.x

    For upgrades from 3.10.x or older

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

    # mkdir -p /usr/share/kibana/data/wazuh/config/
# cp /usr/share/kibana/optimize/wazuh/config/wazuh.yml /usr/share/kibana/data/wazuh/config/wazuh.yml

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

    # mkdir -p /usr/share/kibana/data/wazuh/config/
# cp /usr/share/kibana/plugins/wazuh/wazuh.yml /usr/share/kibana/data/wazuh/config/wazuh.yml

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

    # mkdir -p /usr/share/kibana/data/wazuh/config/
# cp /usr/share/kibana/plugins/wazuh/config.yml /usr/share/kibana/data/wazuh/config/wazuh.yml

    Edit the /usr/share/kibana/data/wazuh/config/wazuh.yml configuration file and add to the end of the file the following default structure to define an Wazuh API entry:

    hosts:
  - <id>:
     url: http(s)://<api_url>
     port: <api_port>
     username: <api_user>
     password: <api_password>
     run_as: false

    The following values need to be replaced:

    • <id>: an arbitrary ID.

    • <api_url>: url of the Wazuh API.

    • <api_port>: port.

    • <api_user>: credentials to authenticate.

    • <api_password>: credentials to authenticate.

    In case of having more Wazuh API entries, each of them must be added manually.

  2. (For upgrades from 3.x versions) Replace the value user by username and set the username and password as wazuh-wui in the file /usr/share/kibana/data/wazuh/config/wazuh.yml:

    hosts:
  - default:
      url: https://localhost
      port: 55000
      username: wazuh-wui
      password: wazuh-wui
      run_as: false

  3. Remove the Wazuh Kibana plugin:

    # cd /usr/share/kibana/
# sudo -u kibana bin/kibana-plugin remove wazuh

  4. Upgrade Kibana:

    Yum

    APT

    ZYpp

    # yum install kibana-7.17.9

    # apt-get install kibana=7.17.9

    It's recommended to keep your currently installed version of the configuration file (option N or O if prompted).

    # zypper update kibana=7.17.9

  5. (For upgrades from 3.x versions) 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

  6. Update file permissions. This will prevent errors when generating new bundles or updating the Wazuh Kibana plugin:

    # chown -R kibana:kibana /usr/share/kibana

  7. 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.4.3_7.17.9-1.zip

  8. Update configuration file and certificates permissions:

    # chown kibana:kibana /usr/share/kibana/data/wazuh/config/wazuh.yml
# chmod 600 /usr/share/kibana/data/wazuh/config/wazuh.yml
# chown -R kibana: /etc/kibana/certs
# chmod -R 500 /etc/kibana/certs
# chmod 400 /etc/kibana/certs/ca/ca.* /etc/kibana/certs/kibana.*

  9. 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

  10. Edit the /etc/kibana/kibana.yml configuration file:

    server.host: <kibana_ip>
server.port: 443
elasticsearch.hosts: https://<elasticsearch_DN>:9200
elasticsearch.password: <elasticsearch_password>

# Elasticsearch from/to Kibana

elasticsearch.ssl.certificateAuthorities: /etc/kibana/certs/ca/ca.crt
elasticsearch.ssl.certificate: /etc/kibana/certs/kibana.crt
elasticsearch.ssl.key: /etc/kibana/certs/kibana.key

# Browser from/to Kibana
server.ssl.enabled: true
server.ssl.certificate: /etc/kibana/certs/kibana.crt
server.ssl.key: /etc/kibana/certs/kibana.key

# Elasticsearch authentication
xpack.security.enabled: true
elasticsearch.username: elastic
uiSettings.overrides.defaultRoute: "/app/wazuh"
elasticsearch.ssl.verificationMode: certificate

    • elasticsearch.hosts: In case of having an IP, replace it with a DNS name (Starting Elasticsearch 7.11.0, IP addresses are not allowed). For example, https://localhost:9200

    • Replace server.defaultRoute: /app/wazuh with uiSettings.overrides.defaultRoute: "/app/wazuh"

    • Add the following line to select certificate as verification mode: elasticsearch.ssl.verificationMode: certificate

  11. Link Kibana’s socket to privileged port 443:

    # setcap 'cap_net_bind_service=+ep' /usr/share/kibana/node/bin/node

  12. Restart Kibana:

    Systemd

    SysV init

    # systemctl daemon-reload
# systemctl enable kibana
# systemctl start kibana

    Choose one option according to the OS used:

    1. Debian based OS

    # update-rc.d kibana defaults 95 10
# service kibana start

    1. RPM based OS

    # chkconfig --add kibana
# service kibana start

  13. (For upgrades from 3.x versions) Once Kibana is accessible, remove the wazuh-alerts-3.x-* index pattern. Since it has been replaced in Wazuh 4.0 by wazuh-alerts-*, it is necessary to remove the old pattern 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.17.9' -k -uelastic:<elastic_password>

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

  14. Clear the browser's cache and cookies.

Finishing the upgrade

  1. Recommended action - Disable the Wazuh repository when finished upgrading the Wazuh installation in the node to prevent an upgrade to the newest Elastic Stack version due to the possibility of undoing changes with the Wazuh Kibana plugin.

    Yum

    APT

    ZYpp

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

    # sed -i "s/^deb/#deb/" /etc/apt/sources.list.d/elastic-7.x.list
# apt-get update

    Alternatively, the user can set the package state to hold, which will stop updates. It will be still possible to upgrade it manually using apt-get install:

    # echo "elasticsearch hold" | sudo dpkg --set-selections
# echo "filebeat hold" | sudo dpkg --set-selections
# echo "kibana hold" | sudo dpkg --set-selections

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

Next steps

The next step consists in upgrading the Wazuh agents.