Upgrade from Previous Versions

Upgrading the Genvid Toolbox from one version to another may include some manual steps. This page includes any steps required to update to version 1.44.0 from the last version. If you’re upgrading an older version of the SDK, start with any special upgrade instructions for your version found here.

General Upgrade Instructions

Upgrade the Genvid Toolbox

Important

Since version 1.33, the Genvid Toolbox package no longer depends on the Azure CLI. Instead, it uses the standalone Azure CLI Installer to avoid some dependency conflicts. When upgrading, you might get some conflict errors. However, the installation favors the last package, so your Toolbox installation will be successful despite these messages. As a precaution, you might want to remove the Azure CLI package and its dependencies and use the standalone Azure CLI installer instead.

To set up the Toolbox locally:

  1. Install the new toolbox.

  2. Run the Python script to install the Genvid Toolbox.

    py install-toolbox.py

  3. Run the Genvid Bastion script to update your bastion.

    genvid-bastion reinstall --reconfigure --resetconfig -b {mybastion} -uml

Update Your Cluster

We strongly recommend keeping your old clusters as-is and creating a new one for the update.

To create a new cloud-based cluster, follow the standard instructions:

  1. Set up a new wingame AMI that matches the new version.

  2. Create new clusters.

To create a new local cluster, follow the standard instructions listed in the Initializing a Local Cluster section.

Once you have replaced all your clusters, you can remove the old SDK repositories from the Modules Section page.

Updating an Existing Cluster

Warning

Updating your cluster can replace all your instances and even erase your current configuration. We recommend not updating a live cluster. If you do, carefully check the changes before applying the plan.

You can update the module used to build your cluster by clicking on Reimport Module in the module section of your cluster infrastructure, then select the module new version and import it. Finally, click apply in the Terraform section.

Note

Some changes can take time to propagate to AWS. This is especially true for IAM roles and policies, which could then create some conflicts when recreated. Re-applying the Terraform plan should fix the problem.

Upgrade from 1.43.0 to 1.44.0

Removal of the services check from the cluster-api calls

The cluster-api will no longer check if the services job is running before allowing a change in settings, jobs definitions or events definitions. Although most of the core services will behave correctly when such changes happen, some services and integrations may require a restart to register those changes.

AWS CLI upgrade from v1 to v2

The installed version of AWS CLI have been updated from version 1 to version 2 (2.10.3). This shouldn’t required any changes on your part, but you can check the Migration Guide for the new features available and if any change is required.

Deprecation of Events and Settings API

The Events and Settings API have been deprecated from the genvid.toolbox.ClusterAPI interface, and will now be provided by the SDK. Please, refer to the Genvid MILE SDK documentation for upgrade instructions.

Upgrading from Older Versions

For upgrading from version before the Genvid Toolbox 1.42.0, please refer to the Upgrade Notes of the Genvid MILE SDK 1.42.0 upgrade notes

Note

If there aren’t specific instructions listed for a version, then there aren’t any special steps for upgrading that version.