Getting Started

Frame may be a very robust and intricate platform, but being an end user is easy! The Getting Started Guide will outline important details for end users such as minimum system requirements, supported browser versions, and a glossary of common Frame terms to help you get comfortable with the jargon. We’ll also show you how to access your Frame account.

Use the links below to jump to different sections of this guide, if needed.

Glossary of Frame Terms for End Users

Launchpad

Launchpad refers to the end-user-facing part of the Frame interface where users can go to launch and manipulate applications. End users can be given access to multiple Launchpads depending on the needs of their organization. For instance, one Launchpad may contain applications for word editing while another Launchpad houses only billing-specific apps. Administrators can configure multiple Launchpad interfaces to show what application sets specific end users see and what features are exposed to them. If enabled, end users can switch between Launchpads by clicking on the rectangular Launchpad list icon at the top of their screen. Launchpads are accessible via URL and may look something like this:

https://console.nutanix.com/customer-name/organization-name/account-name1/launchpad/desktop
Session

A Frame session refers to the connection between a user’s browser and an instance/virtual machine. A session is created the moment the connection is requested by the user and ends as soon as the connection is closed. Once a session is closed, the VM is prepared and made available for others to use.

Instance

This is a commonly used industry term for a virtual machine which includes a complete operating system as well as installed applications. Typically, multiple instances run simultaneously on a single physical server but are independent in every other way. An instance can come in a variety of types, with specifications that are like those for PCs and servers. For example, Frame instances are typically distinguished by the number of CPUs, amount of RAM, and the number of GPUs. The instance may also be referred to as the “VM” (virtual machine), the “system,” or the “workstation.” Frame supports many different instance types. Frame has named these instance types (e.g., “Air 4GB”, “Air 8GB”, “Pro 16GB”) to help differentiate them based on their specifications. Each Frame instance type name maps to an infrastructure provider-specific name.

Pool

Your administrator configures a pool of available instances for their group of end users based on the expected workload and activity. In an organization, for example, the billing department may start sessions from a pool of Air 4GB instance types while the graphic design department pulls from a pool of Pro 16GB instance types. The administrator can set the amount of available instances in the pool, including how many of those instances are buffered or “warmed up” and how many of each type are available to their end users at a given time.

Authenticate

Authenticating is how you prove your identity to access your Frame account. Your account administrator will decide how you authenticate to the platform. You may simply authenticate directly through the Frame platform with a user name and password or you may use a third-party SAML2 authentication method such as Okta.

Cloud Storage

Cloud storage refers to services such as Dropbox, Google Drive, Box, and Microsoft OneDrive which save your files on their public clouds as a service. Frame can connect to these cloud storage services to allow end users to save their work.

Disconnect and Close Sessions

When an end user exits a session, there are two options:

  • Disconnect from the session but keep it active, in which case the user can return to the session.

  • Close Session to completely end the session.

This distinction is important, so please read on:

  • “Disconnect” is like disconnecting your monitor cable from a running PC. In this case, if the system is set up with an “idle timeout” setting, the session will continue running and the user can connect back within the set time to resume their session.

  • “Close Session” is equal to what you do at the end of a day with a PC: you save all of your work and then power off the system. In Frame’s case, closing a production session will end the session completely. For most situations, your instance will be returned to the pool of production instances – making it available for someone else to use. For persistent desktop users, your persistent desktop can now be powered off safely.

System Requirements

The Frame Platform has been developed to deliver an application’s graphical user interface through any HTML5/WebGL compatible browser. This includes support for the latest versions of Chrome, Firefox, Safari, and Edge on various desktops and mobile devices. We officially support up to the last 5 major releases of Google Chrome, Mozilla Firefox, Apple Safari, and Chromium-based Microsoft Edge. Internet Explorer 11 is not supported.

Frame running in HTML5/WebGL compatible browsers and Frame App are only supported on 64-bit OSes (e.g., Windows 10, Windows Server 2016/2019, macOS X, ChromeOS) to handle the Frame Remoting Protocol. As a 32-bit OS, Windows 7 is not supported.

Performance varies by browser, with Chrome, Firefox, and Microsoft Edge delivering the best overall experience. We test on the latest version of each browser and recommend our customers use the latest version as well.

Mobile Browser Support

The Frame platform is officially supported on mobile versions of Chrome and Safari at this time. Desktop mode is not supported on mobile browsers at this time.

Network Requirements

The following requirements must be met in order for the end user to access a Frame session:

  1. Support for HTTPS (TLS) connections on port 443 to the Frame Platform

  2. Support for HTTPS (TLS) and Secure WebSockets through all firewalls to the Frame-managed workload VM

Since the virtualized application window or desktop is streamed to the end user’s browser over the network, a user needs to have sufficient network bandwidth between their browser and the Frame-managed workload VM running the virtualized applications and/or desktop. The following table provides high-level guidance on average bandwidth consumption per Frame session based on the applications to be used, VM instance type (CPU only or GPU-backed), display resolution, and frame rate.

Average Bandwidth (Mbps)

Applications

VM instance type

Display resolution

Frame rate

1

Office productivity applications

CPU-only

up to 1920 x 1080

up to 20 fps

5

CAD applications

GPU

up to 1920 x 1080

up to 60 fps

10

Video editing/animation/sustained playback

GPU

up to 1920 x 1080

up to 60 fps

20

Video editing/animation/sustained playback

GPU

up to 3840 x 2160

up to 60 fps

Frame App

While Frame was designed to be accessed from an HTML5-enabled browser, some end users may access their Frame environment from Frame App. Frame App provides additional features to organizations that aren’t available through a modern web browser. If you are accessing your account from Frame App, we will cover some of the basics here. If you are accessing your account from your web browser, you can move on to the next section.

To launch Frame App from your local machine, simply click on the icon:

../_images/eu_fapp1.png

Using Frame App is simple, and there are only a few differences from using Frame in a web browser.

../_images/eu_fapp2.png

The menu options and definitions are as follows:

  • Frame > Quit Frame: Closes the window. If you select this option while in a session, your session will only disconnect. You will still be able to access your session by relaunching Frame App. More details are covered in the next guide.

  • View > Reload: Reloads the window. Performs the same action as the “refresh” button in a web browser.

  • View > Show Certificate: This window displays SSL information that you may be asked to access for troubleshooting reasons.

  • View > Toggle Full Screen: Enables/disables full screen mode.

  • History> Back/Forward: The Frame App equivalent of the back and forward buttons in a modern web browser.

  • Help > About: Provides information about Frame App including your current version and a link to our EULA.

  • Help > Preferences: Opens the “preferences” window where your administrator will set the startup URL for Frame App.

The section below will outline how you can log in to your Frame account.

Accessing your Account

It’s finally time to sign in to your Frame account. Depending on how your administrator has configured your account, there are two methods you can use to set up and access your account.

Authenticated Sign In

Many organizations choose to leverage a third-party identity provider (IdP) to control their users’ access to various tools and platforms. There is no need to set up your account credentials since your organization can simply provide Frame access to you through the third-party IdP. Frame integrates with most SAML2 identity providers, which means you may access your Frame account in a variety of ways. Accessing Frame through your IdP is simple, we will outline the different methods below.

Sign In

If your administrator has configured the Frame account to authenticate users through your organization’s SAML2 provider, they will typically provide you with a login URL which should look something like this:

https://console.nutanix.com/customer-name/organization-name/

If you are not already authenticated with your IdP, your sign on screen may look something like this:

../_images/eu_saml1.png

Notice the “Sign in with Okta” button with the yellow lock symbol

In this example, Okta is the identity provider. Your administrator may use another provider such as Microsoft Azure AD, Microsoft ADFS, Google Suite, or others. Click on the “Sign in with ____” button to authenticate to the platform. You will be redirected to your identity provider’s login page where you’ll be prompted to enter your IdP credentials. Once you log in, you will automatically be taken to the Frame platform.

URL Authentication

Your administrator may have optimized your Frame login URL to authenticate through your IdP. If so, the URL they provide you may look something like this:

https://console.nutanix.com/?idp=idp_name

Launch Frame from IdP

Identity providers often supply end users with a landing page where they can select from their available applications and launch them, pre-authenticated. As an end user, you may see Frame as an option. Using Okta as an example, you may be able to select your Frame “chiclet” from the Okta “My Apps” page:

../_images/eu_chiclet.png

In this case, starting Frame is as simple as clicking on the button. Many IdPs provide a similar interface to their end users.

Basic Sign In

If your admin has opted to use the built-in Frame platform sign in feature, you will set your own credentials to access your account. The first thing you will need to do is check your email to see if you have received your invitation.

../_images/eu_invite1.png

You’ve been invited!

Open the email and click the blue button to proceed.

../_images/eu_invite2.png

Fill in your user details and click “Set Password.”

../_images/eu_invite3.png

Once you’ve set your user name and password, click “Proceed to Login.” You’ll be asked to log in with your new credentials.

From this point forward, you can log in to your Frame platform account by going to https://frame.nutanix.com/ and clicking “Sign in with email/password.”

../_images/eu_basiclogin.png

Forgot your Password?

If you find that you have forgotten your password, simply click on the “Forgot your password?” link below the sign in button and follow the prompts. You will receive an email with reset instructions. If you authenticate using a third-party SAML2 or OAuth2 provider, please contact your administrator to reset your password.

All set! You can move on to the next End User guide if you’re ready!