How to Upgrade Swarm

Get Products and Docs

  1. Navigate to the Downloads section on the DataCore Support Portal.

  2. Scroll down and open the Swarm toggle

    • These bundles are updated and the ZIP file name changes to reflect the release date for the bundle when an updated component version is available such as an updated release of Content Gateway.

  3. Download the corresponding PDF from the Documentation Archive page. 

    • The comprehensive PDF matching all components at those versions is uploaded to the Documentation Archive using a filename including the same release date for the matching bundle.

    • The Swarm online documentation is continually updated to the current release; because the PDF is a snapshot tied to a bundle release, consider it the definitive source for that bundle.

    • The DataCore Support team's searchable Knowledge Base contains technical articles and the latest documentation, which may be newer than the installed version. 

  4. Expand the software bundle. In the top-level directory of the bundle, locate and read the README.txt for version guidance on using the bundle.

  5. Open the PDF for the bundle and see the Release Notes for each component, which include upgrade instructions as well as changes and watch items.

Upgrade Planning

  1. Plan upgrade impacts — Review and plan for this release's upgrade impacts and the impacts for each of the releases since the currently running version. For Swarm 9 impacts, see Swarm Storage 9 Releases.

  2. No volume retires — Do not start any elective volume retirements during the upgrade. Wait until the upgrade is complete before initiating any retires, or verify they are complete before upgrading.

  3. Choose the reboot type — Swarm supports rolling upgrades (a single cluster running mixed versions during the upgrade process) and requires no data conversion unless noted for a release. Upgrades are performed without scheduling an outage or bringing down the cluster. Restart the swarm nodes one at a time with the new version and the cluster continues serving applications during the upgrade process. 

    • Rolling upgrade: Reboot one node at a time and wait for its status to show as "OK" in the UI before rebooting the next node. 

    • Alternative: Reboot the entire cluster at once after the software on all USB flash drives or the centralized configuration location has been updated.

  4. Follow the Upgrade Path, below.

  5. Review the Application and Configuration Guidance.

Upgrade Paths

Swarm upgrade paths depend on the implementation environment. See Installing and Initializing Swarm Storage for first time Swarm installations.

Component-only upgrades

Not all components update in every release; some upgrades contain a single RPM. The currently running Swarm version determines which components require an upgrade. Follow the release tables on the Documentation Archive to track component versions. 

Upgrade Path options:

  1. Running Elasticsearch 2.3.3 or 5.6.12, see Upgrading from Unsupported Elasticsearch, below.

  2. Not using a Search feed or running Elasticsearch 6.8.6, continue with the upgrade path.

CSN

No CSN

CSN

No CSN

  1. Run settings checker and review upgrade impacts

  2. Review and address report with Support

  3. Download the CSN Swarm bundle from the Downloads section on the DataCore Support Portal

  4. Upgrade the Storage RPM or run the script (see flowchart)

  5. Select the new Storage version and reboot the cluster to activate it

  6. Standalone Gateway: 

    1. Upgrade Gateway (with Swarm UI, Content UI)

  7. Standalone Elasticsearch: 

    1. Verify Swarm 14 is working (no downgrading after ES goes to 7)

    2. On ES 6, first install the Search and Metrics RPMs.

    3. Run the config script provided, which installs and configures ES 7:

      1 configure_elasticsearch_with_swarm_search.py
  1. Run settings checker and review upgrade impacts

  2. Review and address report with Support

  3. Download the Swarm bundle from the Downloads section on the DataCore Support Portal

  4. Upgrade Storage (fsimage/kernel files via USB key or PXE server)

  5. Complete required cluster reboot

  6. Standalone Gateway: 

    1. Upgrade Gateway (with Swarm UI, Content UI)

  7. Standalone Elasticsearch: 

    1. Verify Swarm 14 is working (no downgrading after ES goes to 7)

    2. On ES 6, first install the Search and Metrics RPMs.

    3. Run the config script provided, which installs and configures ES 7:

      1 configure_elasticsearch_with_swarm_search.py

Upgrading from Unsupported Elasticsearch

Contact DataCore Support to guarantee a smooth migration process with no down-time if running unsupported Elasticsearch versions 2.3.3 or 5.6.12.

Swarm 9.6

Gateway 5.4

Elasticsearch 2.3.3

Migration to ES 6.8.6 required
(new cluster and new Search feed)

Swarm 11.3

 

Gateway 5.4.1

Elasticsearch 2.3.3

Gateway 7.0

Elasticsearch 5.6.12

Elasticsearch 6.8.6

 

Swarm 14.1

Gateway 7.7

Elasticsearch 6.8.6

Upgrade in-place to ES 7.5.2

Elasticsearch 7.5.2

Upgrade in-place to future ES version

Swarm 14.1

Gateway 7.9

Elasticsearch 7.5.2

Upgrade in-place to future ES version

The high-level upgrade sequence is as follows:

  1. Swarm 11 bundle:

    1. Upgrade Swarm to 11.3, as guided by DataCore Support and the Settings Checker report.

    2. Upgrade to Gateway 5.4.1 if currently running Elasticsearch 2.3.3. Upgrade to Gateway 7.0 if currently running Elasticsearch 5.6.12. Refer to Upgrading from Gateway 5.x.

    3. Add an Elasticsearch 6 cluster and start a search feed, leaving the old feed as primary (see Migrating from Older Elasticsearch).

      1. Verify the [storage cluster] managementPassword is set properly in the gateway.cfg file if errors are encountered during feed creation. Correct the value and restart the gateway service if a change is needed.

    4. When the feed completes, make it primary.

    5. Upgrade to Gateway 7.0 if currently running Gateway 5.4.1.

    6. Configure gateway.cfg indexerHosts to point to the new Elasticsearch 6 cluster and restart CloudGateway:

      1 sudo systemctl restart cloudgateway
  2. Swarm 14 bundle:

    • Follow the appropriate column in Upgrade Paths, above.
      This is the general order:

      1. Upgrade to Swarm 14.

      2. Upgrade to Gateway 7.7 (from version 5.4.1, follow Upgrading from Gateway 5.x)

      3. Verify Swarm operations (this is the time to downgrade).

      4. Run the ES config script to upgrade in-place to Elasticsearch 7.

      5. Upgrade Gateway 7.7 to Gateway 7.8.