Release & Upgrade Notes

Below, you’ll find the release notes for the latest version of the Genvid Toolbox. This section also includes release notes from previous versions of the SDK and instructions for upgrading earlier versions.

Genvid Toolbox 1.44.0

Welcome to the Genvid Toolbox 1.44.0. This Toolbox contains core components necessary for developing with the Genvid MILE SDK. The development team maintains these tools and publishes updates independently from the Genvid MILE SDK releases, as needed. We always work to ensure a smooth upgrade between releases and provide as much backward compatibility support as possible. You’ll find a list of our current Known Issues below. Please contact us from our support page if you’re planning a production deployment or need additional technical support.

Major Fixes and Changes

SDK & Toolbox Installation Split

The SDK and the Toolbox now have separate installers. See the documentation for each for more information.

Minor Changes and Other Fixes

  • [toolbox] Deprecated the genvid.toolbox.SDK and genvid.toolbox.ConfigurationLoader, which has been moved to the new genvid.sdk package, along with the genvid-sdk command.

  • [toolbox] Improved the display of errors from our Python scripts by displaying all chained exceptions instead of only the outer one.

  • [toolbox] Added genvid.toolbox.InvalidInstallationFolderError exception to capture exceptions on invalid installation folders.

  • [nomad] Upgraded Nomad from v1.3.5 to v1.4.4.

  • [awscli] Upgraded AWS CLI from version 1 to version 2.10.3.

  • [cluster-api] Events and Settings API from Cluster API are now provided by the Genvid MILE SDK. They are not guaranteed to work properly in the SDK after version 1.44.0.

  • [cluster-api] Removed the blocking check for the services job running from the different Cluster API calls.

  • [component] Upgraded Consul from v1.13.2 to v1.15.0.

  • [consul-template] Upgraded consul-template from v0.29.2 to v0.30.0.

  • [genvid-bastion] Fixed an issue where an exception was raised when calling genvid-bastion backup.

  • [terraform] Upgraded Terraform from 1.1.5 to 1.3.9.

  • [vault] Upgraded Vault from v1.11.3 to v1.12.3.

Known Issues

genvid-sdk upload-images or upload-images-sdk leads to error ERROR: (InvalidValuesForRequestParameters).

When running either genvid-sdk upload-images or genvid-sdk upload-images-sdk, you may see the following error message:

ERROR: (InvalidValuesForRequestParameters) Values for request parameters are invalid: networkAcls.ipRules[].

When running either command, the Genvid Toolbox adds your bastion’s IP addresses to the storage account. However, Azure storage accounts have a limit of 200 IP addresses. So, running either command may exceed that limit. See the official Azure documentation for more information.

Workaround: remove the extra IP addresses from the storage account. From the Azure portal:

  1. Go to Home ‣ Storage Accounts ‣ [Your account] ‣ Networking.

  2. Select Enabled from selected virtual networks and IP addresses.

  3. Remove IP addresses from the list.

  4. Save your changes.

  5. Run the genvid-sdk command that caused the error.

Azure reports requested instance size not available.

On Azure, we are using a compute instance type Standard_NV6 for the game machine. For some accounts, only the promo version of this instance type is available (Standard_NV6_Promo).

When doing the Terraform setup on the Azure module, you may encounter the error:

The requested size for resource 'XXXX-game-1' is currently not available in location 'XXXX'

Workaround:

  1. Open the Terraform Settings page.

  2. Change the instance_game_type to Standard_NV6_Promo.

  3. Open the Commands page.

  4. Select Plan apply ‣ Apply again.

When changing Availability Zones (AZ) in Azure, resources need to be destroyed and rebuilt.

When changing AZs in Azure, deleting the public IP might fail due to it not being detached from the virtual machine. This is a bug in the Terraform provider. See the issue on the Hashicorp Github for more information.

Workaround: manually detach the offending public IPs from the virtual machines in the Azure portal.

genvid-sdk upload-images-sdk command fails to upload the Docker image on Azure Cloud.

Some Docker images can’t be uploaded to Azure Cloud using the genvid-sdk upload-images-sdk command due to large sizes. (You will get an SSL error and a Max retries exceeded message.)

Workaround:

  1. Open the Azure UI.

  2. Upload your image manually.

  3. Run genvid-sdk upload-images-sdk again.

The user is required to manually remove the subdomain NS record when updating the subdomain on an existing AWS cluster.

When creating an AWS cluster using basic_cluster_alb_ssl or minimal_cluster_alb_ssl, the domain and subdomain are provided. When updating an existing cluster’s subdomain, the route53 NS record for the previous subdomain needs to be removed manually from the main domain. This is due to how the NS record is handled within our Terraform.

Unable to delete subnets in cluster basic_cluster_alb_ssl using AWS.

When changing subnet_cidr_block_size in basic_cluster_alb_ssl, decreasing the number of AZs, or reordering existing AZs, the cluster will get stuck trying to delete the subnets. Reapplying the configuration won’t resolve the issue.

Workaround: delete and recreate the cluster.

Bastion cluster Settings page modal window not closing.

In the Bastion Settings page for a cluster, the Properties modal window for custom tags doesn’t close when you click outside of it.

Workaround: click on Properties again to close the modal window.

Limitations

The application doesn’t work properly after Windows comes back from sleep.

Nomad has some difficulties with sleeping jobs, including its own. This is unlikely to get fixed in Nomad, but shouldn’t happen in a production environment.

Workaround: do not allow Windows to go to sleep when you are running the service, or simply to restart the service with a genvid-bastion reinstall. (Unfortunately, genvid-bastion restart is not sufficient.)

Default value for an Azure resource group name may be too long.

If no values are provided for the variable resource_group_name, the value is set to a combination of {bastionid}-{clustername}. This can yield names longer than 64 characters, which is the maximum number of characters allowed for an Azure resource group name.

To avoid this problem, always provide a value of 64 characters or less for the variable resource_group_name.

See the Azure Github for more information on Azure naming conventions.

AWS clusters subnet collision error.

If you reduce the subnet_cidr_block_size and increase the number of AZs for an AWS cluster at the same time, it causes a subnet collision error.

If you encounter this issue, reapply the configuration to resolve it.

No new tags on Azure disk when updating a cluster.

When applying new tags to Azure clusters, tags will not be applied to disk unless the virtual machine instance that owns the disk gets recreated during the apply process.

Workaround: delete and recreate the cluster to resolve the issue.

Cluster names are limited to 64 characters.

Cluster names are limited to 64 characters due to limitations with the file system in Windows. Objects like the system’s username and cluster name factor into the max number of characters of the file directory.

Avoid using more than 64 characters, as the results can be unpredictable.