{"__v":12,"_id":"5694425e73f48f0d0075ca50","category":{"__v":6,"_id":"55d6b4f3250d7d0d004274cd","pages":["55da9b55a955100d00def94f","55da9d0a6caa860d006f22f8","55e75a3559f5ed21004f5535","569433afd8c04d1700e5ae0a","5694425e73f48f0d0075ca50","5694812b3e9d080d00f065cc"],"project":"55d535ca988e130d000b3f5c","version":"55d535cb988e130d000b3f5f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-21T05:19:47.960Z","from_sync":false,"order":0,"slug":"introduction","title":"Read me first!"},"parentDoc":null,"project":"55d535ca988e130d000b3f5c","user":"55d535835082980d0009c965","version":{"__v":12,"_id":"55d535cb988e130d000b3f5f","hasDoc":true,"hasReference":false,"project":"55d535ca988e130d000b3f5c","createdAt":"2015-08-20T02:04:59.052Z","releaseDate":"2015-08-20T02:04:59.052Z","categories":["55d535cc988e130d000b3f60","55d6b238d2a8eb1900109eef","55d6b4f3250d7d0d004274cd","55d7967960fc730d00fc2852","55da9804e835f20d009fc5d0","55e75b1de06f4b190080dbfd","55e75b39e06f4b190080dbfe","55e75b7ae06f4b190080dbff","564f5a4e33082f0d001bb709","570fb64aa38d470e0060cbff","586d0dd89a854123001acd65","586d0e3b9a854123001acd66"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T00:01:34.891Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Frame products and services use a number of terms common in the cloud platform and virtualization space, but we have some terms that are specific to Frame. So read on for our quick guide to help you get up to speed:\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Instance\",\n  \"body\": \"This is a commonly used industry term for a virtual machine which includes a complete operating system and also installed applications.\"\n}\n[/block]\nTypically, 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 has several **instance** types, including the \"Air 4GB\" system and the \"Pro 16GB\" system.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sandbox\",\n  \"body\": \"This refers to a special instance on Frame accounts that is used as the place where you install your applications.\"\n}\n[/block]\nFor Frame Personal accounts, it is essentially your \"PC in the cloud\" and is referred to as your \"Desktop.\" In Frame for Business/Education and Frame Platform accounts, the **Sandbox** serves as your \"gold master image.\" It is where you set up and configure your applications as well as anything else specific to your environment (e.g., Windows settings).  \n\nNote that your Sandbox is always set to power off automatically if not currently in use when the next   hourly usage increment is about to be incurred. This saves you from paying for unused server time.  So don't worry about powering off the sandbox. We'll do it for you. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This is the process of registering an application with the Frame backend, so that it will appear in a browser and become accessible from it.\",\n  \"title\": \"Onboarding\"\n}\n[/block]\nWhen you install an application in the Sandbox, Frame prompts you to **onboard** the application. You can also **onboard** previously installed applications by right clicking on the executable file and selecting \"Onboard to Frame.\"  \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Publish\",\n  \"body\": \"This is when you push all the changes and configurations you setup on your sandbox to go live for your end users.\"\n}\n[/block]\nOnce your apps are onboarded, and your Sandbox is ready and configured the way you like it, you need to copy it to a pool of \"production instances,\" which is what your users connect to in Frame for Business/Education and Frame Platform accounts. This process of copying the Sandbox is called **\"publishing.\"** (See http://fra.me/how-it-works for more details on this process). \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Production instances\",\n  \"body\": \"This is a pool of instances that are used for Frame for Business/Education and Frame Platform accounts to serve end users.\"\n}\n[/block]\nWhen users connect to run an application, they will run it on one of these **production instances** (and NOT on the Sandbox). Administrators of Frame accounts set up parameters that govern the size of the **production instance** pool, which determines its capacity to support a number of users.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Elastic scaling or elasticity\",\n  \"body\": \"This is a feature that Frame uses to automatically scale the availability of your production instances to meet the changing demand of your end users.\"\n}\n[/block]\nSince one component of the cost of using Frame is hourly usage, **elasticity** is important as usage is calculated only when instances are powered on. Thus, you only want to power on instances when users actually need access. For example, in most cases at night, you want the system to power off your production instances -- so that you are not consuming hours when no one connects. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Stateless apps (or stateless sessions)\",\n  \"body\": \"After a user is finished running an application, all the changes that the user has made to the instance running the app are deleted, and the instance is returned to a \\\"known good state.\\\"\"\n}\n[/block]\nThis is the most common mode of using production instances on Frame. Since many different users may connect to the same instance over time, it is important that the instance does not keep any user data. With **stateless sessions,** any changes made during a session, including any data saved directly to the instance, are erased after the session ends. This way, every user starts a session with a \"clean\" instance.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Cloud storage\",\n  \"body\": \"This refers to services such as Dropbox, Google Drive, and Box, which save your files on their public clouds as a service.\"\n}\n[/block]\nFrame connects to these **cloud storage** services in order to save your files. Therefore, there is no need to save any of your data directly on Frame.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Launchpad\",\n  \"body\": \"This refers to the end-user-facing part of the Frame software interface and lets users launch and manipulate applications.\"\n}\n[/block]\nAdministrators also access a special view of the **Launchpad** that lets them configure what applications end users see and what features are exposed to them. This is what the **Launchpad** looks like:\n[block:image]\n{\n  \"images\": [\n    {\n      \"caption\": \"\",\n      \"image\": [\n        \"https://files.readme.io/KKjVAReVQWt1q3DBNtdH_Screenshot%202015-06-21%2014.45.06.png\",\n        \"Screenshot 2015-06-21 14.45.06.png\",\n        \"1386\",\n        \"827\",\n        \"#113c5d\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Dashboard\",\n  \"body\": \"This refers to the administrator-facing part of the Frame software interface that give admins full access to all aspects of the Frame service, including onboarding apps, setting app properties, managing capacity, and more.\"\n}\n[/block]\nThe **Dashboard** is not visible to Frame demo accounts, Frame end-user accounts, or Frame Personal accounts. It is only visible to Frame for Business/Education and Frame Platform accounts. This is what the **Dashboard** looks like:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/i29Ygf2LRpKNc3gXmeM0_Screenshot%202015-06-21%2014.54.10.png\",\n        \"Screenshot 2015-06-21 14.54.10.png\",\n        \"1386\",\n        \"842\",\n        \"#3b78ab\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Embedded player\",\n  \"body\": \"This refers to one way of distributing applications onboarded to Frame Platform. Essentially, you can insert an application into any web page by adding a single line of code provided by your Frame Platform account's app sharing page.\"\n}\n[/block]\nThe **embedded player** can be customized to fit to a specific software vendor's branding needs and more. Here's what an **embedded player** looks like when used on a Frame preview page:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/KWvJWqMIQpqakcupDVUO_Screenshot%202015-06-21%2014.59.06.png\",\n        \"Screenshot 2015-06-21 14.59.06.png\",\n        \"973\",\n        \"602\",\n        \"#735455\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Disconnect, Power off, and Quit\",\n  \"body\": \"When an end user exits a session, there are, generally, two options:  \\n\\nto **Disconnect** from the session but keep it active, in which case user can return to the session; \\nto **Power off** (also referred to as **\\\"Quit\\\"**) to completely end the session.\"\n}\n[/block]\nThis distinction is important, so please read on:\n\n1) to **\"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 and resume the session. \n\n2) to **\"Power off\"** is like what you do at the end of a day with a PC: you save all your work and then power off the system. In Frame's case, powering off a production session will end the session completely and return the instance to the pool of production instances -- making it available for someone else to use. This power off process takes about 2 minutes -- and so in that time, the user will not be able to access a new session.  \n\nNote that when an admin is in a Sandbox or Utility Server session, instead of **\"Power Off,\"** he/she is given the option to **\"Quit\"** the session. When the admin quits, the Sandbox or Utility server stays on and can only be powered off from the Dashboard (or automatically powered off after 1 hour, in the case of the Sandbox).","excerpt":"Knowing what's what will make things clearer - don't skip this! [stay calm and read on!]","slug":"glossary-of-frame-terms","type":"basic","title":"Glossary of Frame terms"}

Glossary of Frame terms

Knowing what's what will make things clearer - don't skip this! [stay calm and read on!]

Frame products and services use a number of terms common in the cloud platform and virtualization space, but we have some terms that are specific to Frame. So read on for our quick guide to help you get up to speed: [block:callout] { "type": "info", "title": "Instance", "body": "This is a commonly used industry term for a virtual machine which includes a complete operating system and also installed applications." } [/block] 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 has several **instance** types, including the "Air 4GB" system and the "Pro 16GB" system. [block:callout] { "type": "info", "title": "Sandbox", "body": "This refers to a special instance on Frame accounts that is used as the place where you install your applications." } [/block] For Frame Personal accounts, it is essentially your "PC in the cloud" and is referred to as your "Desktop." In Frame for Business/Education and Frame Platform accounts, the **Sandbox** serves as your "gold master image." It is where you set up and configure your applications as well as anything else specific to your environment (e.g., Windows settings). Note that your Sandbox is always set to power off automatically if not currently in use when the next hourly usage increment is about to be incurred. This saves you from paying for unused server time. So don't worry about powering off the sandbox. We'll do it for you. [block:callout] { "type": "info", "body": "This is the process of registering an application with the Frame backend, so that it will appear in a browser and become accessible from it.", "title": "Onboarding" } [/block] When you install an application in the Sandbox, Frame prompts you to **onboard** the application. You can also **onboard** previously installed applications by right clicking on the executable file and selecting "Onboard to Frame." [block:callout] { "type": "info", "title": "Publish", "body": "This is when you push all the changes and configurations you setup on your sandbox to go live for your end users." } [/block] Once your apps are onboarded, and your Sandbox is ready and configured the way you like it, you need to copy it to a pool of "production instances," which is what your users connect to in Frame for Business/Education and Frame Platform accounts. This process of copying the Sandbox is called **"publishing."** (See http://fra.me/how-it-works for more details on this process). [block:callout] { "type": "info", "title": "Production instances", "body": "This is a pool of instances that are used for Frame for Business/Education and Frame Platform accounts to serve end users." } [/block] When users connect to run an application, they will run it on one of these **production instances** (and NOT on the Sandbox). Administrators of Frame accounts set up parameters that govern the size of the **production instance** pool, which determines its capacity to support a number of users. [block:callout] { "type": "info", "title": "Elastic scaling or elasticity", "body": "This is a feature that Frame uses to automatically scale the availability of your production instances to meet the changing demand of your end users." } [/block] Since one component of the cost of using Frame is hourly usage, **elasticity** is important as usage is calculated only when instances are powered on. Thus, you only want to power on instances when users actually need access. For example, in most cases at night, you want the system to power off your production instances -- so that you are not consuming hours when no one connects. [block:callout] { "type": "info", "title": "Stateless apps (or stateless sessions)", "body": "After a user is finished running an application, all the changes that the user has made to the instance running the app are deleted, and the instance is returned to a \"known good state.\"" } [/block] This is the most common mode of using production instances on Frame. Since many different users may connect to the same instance over time, it is important that the instance does not keep any user data. With **stateless sessions,** any changes made during a session, including any data saved directly to the instance, are erased after the session ends. This way, every user starts a session with a "clean" instance. [block:callout] { "type": "info", "title": "Cloud storage", "body": "This refers to services such as Dropbox, Google Drive, and Box, which save your files on their public clouds as a service." } [/block] Frame connects to these **cloud storage** services in order to save your files. Therefore, there is no need to save any of your data directly on Frame. [block:callout] { "type": "info", "title": "Launchpad", "body": "This refers to the end-user-facing part of the Frame software interface and lets users launch and manipulate applications." } [/block] Administrators also access a special view of the **Launchpad** that lets them configure what applications end users see and what features are exposed to them. This is what the **Launchpad** looks like: [block:image] { "images": [ { "caption": "", "image": [ "https://files.readme.io/KKjVAReVQWt1q3DBNtdH_Screenshot%202015-06-21%2014.45.06.png", "Screenshot 2015-06-21 14.45.06.png", "1386", "827", "#113c5d", "" ] } ] } [/block] [block:callout] { "type": "info", "title": "Dashboard", "body": "This refers to the administrator-facing part of the Frame software interface that give admins full access to all aspects of the Frame service, including onboarding apps, setting app properties, managing capacity, and more." } [/block] The **Dashboard** is not visible to Frame demo accounts, Frame end-user accounts, or Frame Personal accounts. It is only visible to Frame for Business/Education and Frame Platform accounts. This is what the **Dashboard** looks like: [block:image] { "images": [ { "image": [ "https://files.readme.io/i29Ygf2LRpKNc3gXmeM0_Screenshot%202015-06-21%2014.54.10.png", "Screenshot 2015-06-21 14.54.10.png", "1386", "842", "#3b78ab", "" ] } ] } [/block] [block:callout] { "type": "info", "title": "Embedded player", "body": "This refers to one way of distributing applications onboarded to Frame Platform. Essentially, you can insert an application into any web page by adding a single line of code provided by your Frame Platform account's app sharing page." } [/block] The **embedded player** can be customized to fit to a specific software vendor's branding needs and more. Here's what an **embedded player** looks like when used on a Frame preview page: [block:image] { "images": [ { "image": [ "https://files.readme.io/KWvJWqMIQpqakcupDVUO_Screenshot%202015-06-21%2014.59.06.png", "Screenshot 2015-06-21 14.59.06.png", "973", "602", "#735455", "" ] } ] } [/block] [block:callout] { "type": "info", "title": "Disconnect, Power off, and Quit", "body": "When an end user exits a session, there are, generally, two options: \n\nto **Disconnect** from the session but keep it active, in which case user can return to the session; \nto **Power off** (also referred to as **\"Quit\"**) to completely end the session." } [/block] This distinction is important, so please read on: 1) to **"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 and resume the session. 2) to **"Power off"** is like what you do at the end of a day with a PC: you save all your work and then power off the system. In Frame's case, powering off a production session will end the session completely and return the instance to the pool of production instances -- making it available for someone else to use. This power off process takes about 2 minutes -- and so in that time, the user will not be able to access a new session. Note that when an admin is in a Sandbox or Utility Server session, instead of **"Power Off,"** he/she is given the option to **"Quit"** the session. When the admin quits, the Sandbox or Utility server stays on and can only be powered off from the Dashboard (or automatically powered off after 1 hour, in the case of the Sandbox).