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

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

  4. If you have a local cluster running, you should update the configuration of the cluster by running.

    genvid-sdk setup
genvid-sdk load-config-sdk

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.33.0 to 1.34.0

Enforced Validation for Bastion and Consul Connection Environment

We reinforced the validation of CONSUL_HTTP_ADDR and GENVID_BASTION_URL in our scripts. If one or both of those variables are set but aren’t formatted properly, the ConsulTool constructor will throw a ValueError indicating which value is incorrectly formatted.

Upgrade to Nomad v1.2.4

We upgraded Nomad from v0.12.1 to v1.2.4 to take advantage of features this version includes. This upgrade breaks backward compatibility in multiple places.

In particular is the job format conversion to HCLv2. To streamline your upgrade, we added an optional flag to the job configuration.

job "my-job" {
   hclv1 = true
}

This temporary change lets you upgrade before fully converting your job definition to HCLv2. However, you won’t benefit from any features provided by the Nomad upgrade until you complete the conversion.

See the HashiCorp upgrade guide for Nomad for more information.

Upgrade to Terraform v1.1.5

We upgraded Terraform from version 0.14.7 to v1.1.5. This upgrade includes a major change in how sensitive values are viewed in Terraform output.

Values derived from sensitive values (either as variables or outputs) now must be marked as such. They will not be displayed in the default output of a plan or apply command. However, they are still accessible through the output link in the Bastion Terraform Commands interface in JSON format.

See the HashiCorp upgrade guide for Terraform for more information.

nats Job Now an SDK Job Instead of a Setup Job

The nats job is now part of the standard jobs of the SDK, along with services and bins. To help with your upgrade, the genvid-bastion reinstall command has a new --resetconfig parameter that clears the bastion from its previous job definitions.