2.2. Update an existing installation

This section covers the software update of a Host Network Accelerator appliance.

2.2.1. Prerequisites

Note

In Host Network Accelerator version X.Y.Z, digits are referred to as follows:

  • X = major

  • Y = minor

  • Z = maintenance

  • Update between maintenance versions within the same minor version is supported.

  • Update between consecutive minor versions is supported.

  • Update between major versions requires a fresh install.

  • Update between inconsecutive minor versions requires to update in several steps between consecutive minor versions.

  • Downgrade is not supported.

Examples:

Update from

To

Supported

3.0.1

3.0.5

Yes

3.0.5

3.1.0

Yes

2.2.6

3.0.0

No; backup your configurations, install from scratch and restore your configurations

3.8.5

3.10.0

The recommended path is to update via 3.9.x, but it could work provided the conditions are met, see the note below.

3.0.0

2.2.6

No; install from scratch. Configuration backup/restore is not supported when downgrading.

The rationale for these restrictions is to properly support API deprecation.

Warning

Starting with 3.6.8, upgrade to VSR 3.7 is only possible to 3.7.2 or above.

Note

Starting with 3.10, it is possible to upgrade from N-2 to N, e.g. 3.8 to 3.10, provided that the deprecation / obsolete warnings have been fixed in the current configuration, and that no obsolete items are found during the update procedure.

2.2.2. Backup existing files

If you are updating from Host Network Accelerator 2.x, make sure that you update to the latest 2.x version first. Refer to Host Network Accelerator 2.x documentation.

  1. Before updating to a new revision, ensure that you are not using a deprecated API, at least in the startup configuration:

    vsr> validate startup
OK.

    Note

    Any use of deprecated or obsolete API should be fixed. It is advised to also check the saved configurations.

  2. Backup your existing configurations, private keys and certificates.

    vsr> cmd backup export url <backup-url>
OK.

    Warning

    The backup file contains sensitive data, like private keys. Make sure to keep it private.

    See also

    The command reference for details.

If you are updating from Host Network Accelerator 2.x, move to the installation section. Else, move to the next section.

2.2.3. Update to the new version

Container case

As soon as the Host Network Accelerator pod is running, you can import the backup configuration.

2.2.4. API deprecation

When the API changes between Host Network Accelerator versions, the new API coexists with the previous one, which is progressively deprecated, obsoleted and removed, as follows:

GA version

API state

N

API v1 is valid and fully supported.

N + 1

API v2 is introduced; API v1 is deprecated and this is reported at update and when editing the configuration in the CLI. Both APIs are supported; switching to v2 is recommended.

N + 2

API v1 is obsolete. It can still be loaded and displayed in the CLI, but it is ineffective. API v1 is not supported; switching to v2 is required.

N + 3

API v1 is removed and cannot be used.