Streaming Gateway Appliance 3

The Nutanix Frame Streaming Gateway Appliance (SGA) 3 is a secure reverse proxy that supports Frame Remoting Protocol (FRP) 7 and 8. FRP7 is our WebSocket-based protocol and FRP8 is our WebRTC-based protocol. FRP8 provides the foundation for a number of new features including webcam support and improved audio/video synchronization. As with SGA 2.x, SGA 3.x allows organizations to securely grant users access to virtualized applications and/or desktops hosted within a private network without the need for VPN access.

Manual vs. Auto-deployed SGA

Nutanix Frame provides two options for deploying one or more SGAs. Administrators should review the following considerations before moving forward with the configuration process:

Considerations

Manual SGA Deployment

Auto SGA Deployment

Infrastructure

  • Required for AHV-based accounts

  • Optional for public cloud accounts

  • Applicable for Frame accounts in public cloud infrastructure

Networking

  • Manual deployment of SGA allowed for Frame accounts.

  • Two or more SGA VMs require a third-party load balancer

  • 1-4 SGA VMs per Frame account.

  • Load balancer automatically provisioned with two or more SGA VMs.

  • SGAs are created for each new Frame account.

Additional Considerations

  • Customers utilizing load balancers with their SGA configurations can significantly reduce or eliminate downtime for future upgrades of SGA.

  • Customers utilizing the Frame Disaster Recovery (DR) Early Access feature may need to configure the DR cluster with its own SGA, depending on the setup.

  • SGA upgrades require the termination and recreation of SGA VM(s). Scheduled downtime is required.

Auto-deployed SGA Upgrade Instructions

Administrators need simply to set aside time for maintenance of their Frame account and contact Nutanix Frame Support to upgrade their auto-deployed SGA. Provide support with the list of Frame accounts associated with the SGA you wish to upgrade and coordinate a maintenance window with scheduled downtime when the upgrade process will be executed.

Warning

Initiating an SGA upgrade is expected to take up to an hour depending on the infrastructure your account is using, infrastructure traffic, and other variables.

Manually Deployed SGA Upgrade Instructions

If you wish to manually upgrade your SGA, start by following the deployment instructions below to configure your new SGA 3. Once you have completed the SGA 3 deployment, contact Nutanix Frame Support and provide support with the SGA version and list of Frame accounts that are using the newly configured SGA. Support will then update the SGA configuration details within Nutanix Frame backplane to ensure the upgrade is complete.

Manual SGA 3 Deployment Instructions

SGA 3 Management Console

Once you have completed the setup and configuration process above and have changed the IP address, SGA management portal can be accessed using an HTML5 browser. Open a new browser tab and enter the internal IP address and port number (8888, by default) of SGA. When the login screen appears, enter the administrator credentials.

Note

Refer to the SGA Configuration file for the username and password.

Access to the SGA management portal is only allowed from the private network (and not from the Internet), by default.

../../../_images/sga_mgmt2.png

Use the tabs below to navigate through the features of the SGA 3 Management Console:

The SGA Management Console gives you access to a variety of options and functionality. Click the “Status report” link under the Welcome header to ensure all required services are operational.

../../../_images/sga_status2.png

Clicking on “Graphs” within the SGA Management Console will display an assortment of system metrics including network interface details and SGA VM traffic. Use the blue links under the header to select the desired time frame for your metrics.

../../../_images/sga_metrics1.png

Administrators troubleshooting their SGA can download log files generated by the SGA VM by clicking on “Logs” from the management console and selecting the desired data set.

../../../_images/sga_mgmt4.png

See the example below:

../../../_images/sga_logs1.png

The last option to select from the management console is the speed test, which is included to assist in troubleshooting the network path between the administrator’s browser and the SGA VM.

../../../_images/sga_speedtest1.png

Troubleshooting

Renew Your SSL Certificate

If you have found that your SSL certificate for your SGA has expired, simply follow the instructions in Steps 2 through 5 of the Manual SGA 3 Deployment Instructions to create a new SSL certificate, update the configuration file, and create the new SGA VM. The process is as follows:

  • Update/create the new YAML file

  • Create a new SGA VM using the new YAML file

  • Shut down the old (expired) SGA VM

  • Configure the new SGA VM with the same network settings as the previous SGA VM

  • Reboot

If you need additional help in troubleshooting your SGA 3 setup or configuration, consider filing a support case.