Upgrade from Previous Versions

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.28.1 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 SDK

To set up the new SDK locally:

  1. Install the new SDK.

  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 -b {mybastion} -uml
    

Update 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.

Update 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.

Upgrade the Javascript API

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

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 Initialize 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.

Update Genvid SDK Samples

Along with your own project, make sure you update any of the Genvid SDK samples you’ve previously installed.

Upgrade from 1.27.0 to 1.28.0

genvid-sdk package command now can create package with either hierarchical or flattening behaviour.

By default, the genvid-sdk package command creates the package with hierarchical behaviour (the directory structure is preserved in the zipped archive). We added the --flatten option to create the package with flattening behaviour (extracting files from the directory and subdirectories then packaging it).

In previous versions, only flattening behaviour was supported and was the default behaviour.

Terraform Upgrade

The previous version of the SDK was released with Terraform 0.13. It is NOT possible to directly upgrade a cluster from 0.12 directly to 0.14.

We included a script to assist with updating your existing cluster for Terraform 0.14 compatibility. You can find it in your bastion-services directory at bastion-services/terraform/upgrade/terraform_14_upgrade.py.

Important

After upgrading to 1.28.0, run the script before performing any other actions with Terraform or your clusters. An Internet connection is required.

We recommend you back up your tfstate before running the script.

Only the Terraform 0.13 executable can migrate 0.12 states, so the script runs in the following order:

  • Moves the bundled Terraform 0.14 executable.
  • Downloads the Terraform 0.13 executable.
  • Performs the 0.13 update.
  • Restores the 0.14 executable.
  • Performs the 0.14 update.

This script only affects the Terraform state. The final state will be ready to work with.

Warning

It is possible to receive Error: Failed to query available provider packages when upgrading an existing cluster. You can resolve this by navigating to %USERPROFILE%.genvidterraformworkdir{cluster name}tf, deleting the terraform lock file, and reinitializing the cluster.

See the Terraform upgrade guide for information on updating your custom modules for the new provider pattern.

We also removed Provider versions from Bastion UI. See Terraform Provider Versions if you want to manually modify the provider version.