Upgrade WEKA versions

Upgrade your WEKA system with the latest version.

WEKA release model

WEKA operates a dual-track release model with two types of versions: Innovation releases and Long-Term Support (LTS) releases.

  • Innovation releases deliver new features and enhancements frequently, providing early access to cutting-edge functionality.

  • LTS releases focus on stability and reliability.

Each release in get.weka.io is tagged as either Innovation or LTS.

Related topic

Release support and commitments

Software versions

WEKA uses a structured versioning scheme to indicate the scope and type of changes introduced in each release. This helps users quickly identify whether a release includes major new features, minor improvements, or incremental fixes.

  • Major version: The major version represents substantial changes, such as new features, architectural updates, or significant enhancements.

    • Defined by the first two numbers in the version string.

    • Example: In 5.0.4, the major version is 5.0.

  • Minor version: The minor version reflects smaller updates, such as bug fixes, performance improvements, or minor feature additions.

    • Defined by the third number in the version string.

    • Example: In 5.0.4, the minor version is 4.

  • Build number: The build number (fourth component, if present) identifies incremental builds.

    • Used for hotfixes or release candidates that address specific issues without altering core functionality.

    • Example: 5.0.4.384, the build number is 384.

Version compatibility guidelines

  • Upgrade direction: Upgrades must always progress from older to newer versions.

  • Compatibility basis: Compatibility is determined by the release date of the target version relative to the source version.

  • Major version upgrades: Upgrades must follow consecutive order (for example, 4.2 → 4.3). LTS releases upgrade to Innovation, and Innovation releases upgrade to the next LTS.

  • LTS upgrades: Clusters and clients can be upgraded between consecutive LTS releases (for example, 4.2.6 and above may be upgraded to the latest minor release of 4.4).

  • Client upgrades: Clients are supported if they are at most one major version behind the backend. In multi-hop upgrades, such as from 4.2 to 4.4 to 5.0, clients must be upgraded before the cluster to maintain compatibility.

  • SCMC deployments: The client-target-version parameter must be identical across all clusters and compatible with the target backend upgrade. See Mount filesystems from Single Client to Multiple Clusters (SCMC).

  • Reference information: For detailed source-to-target support per release, refer to the upgrade section at get.weka.io.

Upgrade examples

Target version: 5.0.1.101

Supported upgrades

Unsupported upgrades

Releases example on get.weka.io
Target version: 4.4.9.130

4.4.9.130 was release on August 20, 2025. The minimum required version to upgrade from is 4.2.1.

What is a non-disruptive upgrade (NDU)

In MCB architecture, each container serves a single type of process, drive, frontend, or compute function. Therefore, upgrading one container at a time (rolling upgrade) is possible while the remaining containers continue serving the clients.

Some background tasks, such as snapshot uploads or downloads, must be postponed or aborted. See the prerequisites in the upgrade workflow for details.

Internal upgrade process

Once you run the upgrade command in ndu mode, the following occurs:

  1. Downloading the version and preparing all backend servers.

  2. Rolling upgrade of the drive containers.

  3. Rolling upgrade of the compute containers.

  4. Rolling upgrade of the frontend configured with backend mode and protocol containers (including frontend and protocol containers hosted on a dedicated protocol server).

To review the frontend containers that will be upgraded, check their configuration mode by running the following command: $ weka cluster process --role frontend -o containerId,hostname,mode

Example output:

CONTAINER ID HOSTNAME MODE 10 DataSphere-1 backend 13 DataSphere-2 backend 14 DataSphere-3 backend 16 DataSphere-6 client

NDU process at a glance

Related topics

Cluster architecture overview

Upgrade workflow

1. Verify system upgrade prerequisites

Ensure the environment meets the necessary prerequisites before proceeding with any system upgrade. The WEKA Upgrade Checker Tool automates these essential checks, comprehensively assessing the system’s readiness. Whether performing a single-version upgrade or a multi-hop upgrade, following this procedure is mandatory.

Summary of the WEKA Upgrade Checker Tool results:

  1. Passed checks (Green): The system meets all prerequisites for the upgrade.

  2. Warnings (Yellow): Address promptly to resolve potential issues.

  3. Failures (Red): Do not proceed; they may lead to data loss.

Sample list of the verification steps performed by the WEKA Upgrade Checker Tool

Multi-hop version upgrades:

After completing an upgrade, a background process initiates the conversion of metadata to a new format (in specific versions). This conversion may take several minutes before another upgrade can commence. To monitor the progress, use the weka status CLI command and check if a data upgrade task is RUNNING.

By diligently following this system readiness validation procedure, you can confidently proceed with system upgrades, minimizing risks and ensuring a smooth upgrade.

Demo: WEKA Upgrade Checker
  • Prioritize running the WEKA Upgrade Checker 24 hours before any scheduled upgrades. This step is critical to identify and address any potential issues proactively.

  • Ensure passwordless SSH access is set up on all backend servers. This is crucial for the seamless execution of the Python script while running the WEKA Upgrade Checker.

Procedure

  1. Log in to one of the backend servers as a root user:

    • Access the server using the appropriate credentials.

  2. Obtain the WEKA Upgrade Checker: Choose one of the following methods:

    • Method A: Direct download

      • Clone the WEKA Upgrade Checker GIT repository with the command: git clone https://github.com/weka/tools.git

    • Method B: Update from existing tools repository

      • If you have previously downloaded the tools repository, navigate to the tools directory.

      • Run git pull to update the tools repository with the latest enhancements. (The WEKA tools, including the WEKA Upgrade Checker, continuously evolve.)

  3. Run the WEKA Upgrade Checker: Navigate to the weka_upgrade_checker directory. It includes a binary version and a Python script of the tool. A minimum of Python 3.8 is required if you run the Python script.

    • Run the Python script:

      python3.8 ./weka_upgrade_checker.py --target-version <version>

    Or

    • Run the Python precompiled script: ./weka_upgrade_checker --target-version <version>

    Replace <version> with your target version. For example 4.4.4. The tool scans the backend servers and verifies the upgrade prerequisites.

  4. Review the results:

    • Pay attention to the following indicators:

      • Green: Passed checks. Ensure the tool's version is the latest.

      • Yellow: Warnings that require attention and remedy.

      • Red: Failed checks. If any exist, do not proceed. Contact the Customer Success Team.

  5. Send the log file to the Customer Success Team:

    • The weka_upgrade_checker.log is located in the same directory where you ran the tool. Share the latest log file with the Customer Success Team for further analysis.

2. Prepare the cluster for upgrade

Download the new WEKA version to one of the backend servers using one of the following methods depending on the cluster deployment:

  • Method A: Using a distribution server

  • Method B: Direct download and install from get.weka.io

  • Method C: If the connectivity to get.weka.io is limited

For details, select the relevant tab.

Use this method if the cluster environment includes a distribution server from which the target WEKA version can be downloaded.

If the distribution server contains the target WEKA version, run the following commands from the cluster backend server:

Where: <version> is the target WEKA version, for example: 5.0.4.

If the distribution server does not contain the target WEKA version, add the option --from to the command, and specify the get.weka.io distribution site, along with the token.

Example:

3. Prepare the backend servers for upgrade (optional)

When working with many backend servers, preparing them separately from the upgrade process in advance is possible to minimize the total upgrade time. For a small number of backend servers, this step is not required.

The preparation phase prepares all the connected backend servers for the upgrade, which includes downloading the new version and getting it ready to be applied.

Once the new version is downloaded to one of the backend servers, run the following CLI command:

Where:

<new-version>: Specify the new version. For example, 5.0.3.

4. Upgrade the backend servers

Once a new software version is installed on one of the backend servers, upgrade the entire cluster backend servers to the new version by running the following command on the backend server.

If you already ran the preparation step, the upgrade command skips the download and preparation operations.

Consider the following guidelines:

  • Before switching the cluster to the new software release, the upgrade command distributes the new release to all cluster servers. It makes the necessary preparations, such as compiling the new wekafs driver.

  • If a failure occurs during the preparation, such as a disconnection of a server or failure to build a driver, the upgrade process stops, and a summary message indicates the problematic server.

  • If cleanup issues occur during a specific upgrade phase, rerun it with the relevant option:

  • If the container running the upgrade process uses a port other than the default (14000), include the option --mgmt-port <existing-port> to the command.

5. Verify LLQ and WC are enabled in AWS

Enabling the Low Latency Queue (LLQ) improves data processing efficiency in AWS by reducing I/O operation delays. LLQ is enabled by default after an upgrade, but if Write Combining (WC) is not activated in the igb_uio driver, the LLQ driver option does not function. After upgrading the backends, verify that WC is enabled.

Procedure

  1. Check for upgrade events:

    • Review the upgrade events on the backends.

    • If NetDevDriverReloadFailed appears, restart the WEKA service by running the following commands on each backend server:

  2. Verify WC activation:

    • Check if WC is activated by running:

    • If the output is #1, WC is activated, which enables the LLQ driver option.

6. Upgrade the clients

Manage client upgrades to ensure software alignment with the backend clusters. The client upgrade is an online process that does not require unmounting filesystems. You can trigger the client upgrade remotely from the backends while the clients remain active.

Client upgrade types

Learn the available methods for upgrading clients to a new software version.

  • Hot upgrade: Allows clients to remain mounted and operational throughout the client software update.

    • Local (on-client) trigger: An administrative action performed from the client itself to perform hot upgrade.

    • Remote trigger: An administrative action performed from the backend servers to trigger hot upgrades on specific client(s).

  • Remount-based upgrade: An alternative method where a client automatically upgrades following a remount of all mounted wekafs on a client or reboot.

  • Persistent client coordination: A dedicated client acting as a protocol gateway manages containers with allow-protocols true. During upgrades, it coordinates with backend servers to maintain continuous protocol service availability.

  • Multi-cluster clients: Perform online upgrades locally for clients without unmounting filesystems. Related topic: Mount filesystems from Single Client to Multiple Clusters (SCMC).

Upgrade a client locally

Update the software of a single stateless or persistent client by connecting directly to the server. You can perform this as an online upgrade without unmounting filesystems.

Before you begin

Procedure

  1. Download the target version package from a backend server to the client.

  2. Update the agent software.

  3. Upgrade the client containers. For a client connected to a single cluster, run:

    For a client connected to multiple clusters, upgrade all containers simultaneously:

Version management flags

Reference these flags for the weka version command to manage package downloads and visibility.

Flag
Description

--client-only

Downloads only the essential components required for stateless client operations.

--full

Displays version information only when the complete set of components is present on the server.

Upgrade clients in batches (via remote trigger)

Use the backend servers to remotely trigger online upgrades for multiple stateless or persistent clients. This method ensures clients stay mounted while the software updates.

Before you begin

  • Identify the client IDs for the target group.

  • Ensure the backend servers are running the target version.

Procedure

  • Run the remote upgrade command from a backend container.

Remote upgrade parameters

Reference the following table for parameters used with the weka local run upgrade command.

Parameter
Description
Default

--mode=clients-upgrade

Activates the remote upgrade process for clients.

N/A

--client-rolling-batch-size

Defines the number of clients to upgrade in each sequential batch.

1

--clients-to-upgrade

Specifies a comma-separated list of client IDs to include.

All clients

--drop-host

Specifies a comma-separated list of client IDs to exclude from the upgrade.

None

--from backends

Directs the client to pull the upgrade package from the backend servers.

N/A

Example

The following command upgrades two clients in two sequential batches, with each batch containing one client:

7. Check the status after the upgrade

Once the upgrade is complete, verify that the cluster is in the new version by running the weka status command.

Last updated