Versions Compared

Version Old Version 52 New Version Current
Changes made by

Anjali Tyagi

Anjali Tyagi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  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 Online Swarm 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 https://perifery.atlassian.net/wiki/spaces/KB 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 Swarm Release Notes for each component, which include upgrade instructions as well as changes and watch items.

...

Info

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:

Running Elasticsearch 2.3.3

...

, 5.6.12 or 6.8.6, seehttps://perifery.atlassian.net/wiki/spaces/public/pages/2443804878/How+to+Upgrade+Swarm#Upgrading-from-Unsupported-Elasticsearch, below.

...

Otherwise continue with the upgrade path

...

:

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 15 16 is working (no downgrading after ES goes to 7)

    2. On all ES 67 nodes, first install the Search and Metrics RPMs.Run caringo-elasticsearch-search RPM.

    3. On each node run the config script provided, which installs/upgrades and configures the latest ES 7:

      Code Block
      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 15 16 is working (no downgrading after ES goes to 7)

    2. On all ES 67 nodes, first install the Search and Metrics RPMs.Run caringo-elasticsearch-search RPM.

    3. On each node run the config script provided, which installs/upgrades and configures the latest ES 7:

      Code Block
      configure_elasticsearch_with_swarm_search.py

...

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 1516.21

Gateway 7.7.1-2 with
Storage UI 3.4.1

Elasticsearch 6.8.6

Upgrade in-place to ES 7.5.2

Elasticsearch 7.5.2

Upgrade in-place to future ES version

Swarm 1516.31

Gateway 7.108.x with
Storage UI 3.5.0

Elasticsearch 7.5.2, 7.17.9

Upgrade in-place to future ES version

Note

Downgrading, even to minor versions, is not supported with Elasticsearch 7.17. 9. But, the earlier versions of Swarm storage, e.g. Swarm 15+ and Gateway 7.8+, will work with Elasticsearch 7.17.9.

The high-level upgrade sequence when upgrading from Swarm 11 or earlier 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:

      Code Block
      sudo systemctl restart cloudgateway

  2. Swarm 1516 bundle:
    Follow the appropriate column in Upgrade Paths above. The general sequence is:

    1. Upgrade to the latest SCS 1version.5.

    2. Upgrade to Swarm Storage 1516.1.

    3. Gateway 7.7 is required if upgrading from Elasticsearch 6. Ask support for the RPM. Upgrade to Elasticsearch 7.5.2 temporarily (configure_elasticsearch_with_swarm_search.py --esversion 7.5.2) and then upgrade to the latest Gateway 78.10 x as Gateway 7.7 is not compatible with Elasticsearch 7.17.

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

    5. Run the latest ES configuration script for an in-place upgrade to the latest Elasticsearch 7.

    6. Upgrade to the latest Gateway 78.10x. See Upgrading Gateway for upgrading the gateway.

Upgrading to the Latest SCS Version

Directly upgrading from SCS 1.2 to SCS 1.3 is not supported, but this limitation is removed starting with SCS 1.4. Swarm supports upgrading from SCS 1.1, 1.2, or 1.3 to SCS 1.4 and booting from Storage bundle v15.0 with multicast disabled.

Upgrade Notes

  • Any version before SCS 1.4 cannot boot versions of Swarm storage that include the optional multicast feature (version 15.0 and later). This is due to changes required in SCS to properly support this feature.

  • Complete the SCS upgrade first if upgrading both SCS and Swarm Storage simultaneously. Then add the new Swarm Storage component to the SCS repo (using scsctl repo component add ...). During this process, scsctl will prompt as to whether or not to enable multicast for the storage cluster by asking to set a value for cip.multicastEnabled. Select True to enable the use of multicast (this matches the behavior of prior versions of Swarm), or False to disable it. If you are unsure which to choose, contact DataCore Support.

  • Installing a new Swarm Storage component version does not automatically activate the version for PXE booting; the new version must be explicitly activated. Run the below command and choose the new version to activate:

    Code Block
    languagebash
    scsctl storage software activate

Refer to the following steps to upgrade SCS:

  1. Install the new RPM.

    Code Block
    yum install -y [scs rpm]

  2. Run the below command:

    Code Block
    languagebash
    scsctl diagnostics upgrade_check

  3. Run the diagnostics check

    Code Block
    scsctl diagnostics config scan_missing

  4. Re-initialize DHCP:

Code Block
scsctl init dhcp --dhcp-reserve-lower [integer]

Troubleshooting Notes

Refer to the following steps if an error occurs during the upgrade_check command:

  1. Code Block
    systemctl restart swarm-platform && sleep 90
  2. Code Block
    scsctl platform software activate

    Choose the version that matches the recently installed RPM.

  3. Proceed with re-initializing DHCP as listed above.

Info

A customer might see the below error in the output while upgrading to SCS 1.7 or above, but this is safe to ignore it.

Running step [4/11]: Re-enable systemd management of SCS Linux services Disabling service "swarm-platform.service" for pod "swarm-platform"... Failed to disable services: b'Failed to execute operation: No such file or directory\n' Deleting service file for pod "swarm-platform": /etc/systemd/system/swarm-platform.service [exists: False, symlink: True] Retry: Disabling service "swarm-platform.service" for pod "swarm-platform"..
Info
Code Block
Info

Do not upgrade to ES 7.17+, if any gateways are still running with gateway <=7.7.