Upgrade Instructions

Upgrading the Genvid SDK from one version to another may include some manual steps. This page includes any steps required to update to version 1.18.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.

Upgrading the local installation

To set up the new SDK locally:

  1. Install the new SDK.
  2. Run the script install-toolbox.py from the new SDK.
  3. Run genvid-bastion reinstall --reconfigure -b mybastion -uml to update your bastion.

Updating your broadcast website

If you used code from the samples we provide in your own project, note that we recently enforced a best practice concerning service discovery using consul in those samples. You should check again the samples and update your project accordingly. We invite you to use the consul health api instead of the catalog api to fetch the url of your services, since it is more likely that the url will point to a healthy service.

Updating your game

To update your game without applying new features, just replace the old genvid.dll from the previous SDK with the one from the new SDK. The old plugins and integration should work as-is, with the exception of the specific upgrade instructions below.

Attention

Always follow the full upgrade path for the Genvid SDK version you’re using. For example: If you’re upgrading from version 1.6.0 to 1.10.0, start by upgrading from 1.6.0 to 1.7.0 then continue with each version.

See the full list of upgrade instructions for your specific version.

Warning

Genvid SDK 1.14.0 contains a new version of Consul. This new version requires special care to upgrade from the previous version. If you still need to upgrade to 1.14.0, please follow the instructions under Upgrade Bastion before upgrading from 1.13.0 to 1.14.0.

Note

If you haven’t upgraded to 1.15.1, you can upgrade directly from 1.15.0 to 1.16.0 without upgrading to 1.15.1 first. However, you should review the 1.15.1 release notes and upgrade notes for important information about the changes.

Upgrade the Javascript API

You should also upgrade the Genvid JavaScript API on your website.

Upgrading your cluster

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

To create a new cluster, follow the standard instructions:

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

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

Upgrading an existing cluster

Warning

Upgrading your cluster can replace all your instances and even erase your current configuration. We recommend not upgrading 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 Modify/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.17.0 to 1.18.0

Splitting of the genvid Web SDK into two libraries

For a smoother developer experience, we decided to extract the math library from the main genvid library. We now have a new library named genvid-math. The consequence is that you have to include the genvidmath.min.js file if you need the genvidMath functions.

Improvement of the use of the genvid library as a typescript module

You now have two ways of including genvid and genvid-math:

  • using typing and the script tag as usual (genvid/browser). You can have a look at the tutorial sample to see how it goes.
  • using the local module import system (genvid/browserModule). You can see an example of that way of importing in the unity web sample. This import method is also supported by node (genvid/node).

Call to Terraform import module now initialize the cluster

Whether it is through the command line or from the API, the call to import the Terraform Module into a cluster now also initializes the working directory. This could lead to an invalid state of cluster is not empty if you try to call the Terraform Init API after it.

UE4 REST API upgrade

In this release, we updated the UE4 REST API and now use automatically generated files instead of static files. To prevent any build issues with the new plugin, we recommend that you delete the folder PluginsGenvidPluginSourceGenvidEditor and replace it with the new one available with the current GenvidPlugin. This will prevent conflict with files that have been removed or classes available in other files.