Skip to main content
Version: Developer

Glossary

This glossary defines the core Kasm Workspaces terms in alphabetical order. Each entry states what the term means and, where useful, names the Docker container or links to related how-to guidance.

Activation Key

An Activation Key is provided as part of the purchase process for a Kasm Workspaces license, and it licenses a Kasm Workspaces installation. For an offline installation, use the Activation Key with the Installation ID in the Kasm Workspaces activation tool to generate a license key.

Agent

The Agent is the Kasm Workspaces component that provisions instances of end-user session containers when the web application requests them. The Agent reports available system resources to the Manager and downloads the Kasm Images defined in the application. Agents appear in the Servers tab of the Administration area.

Database

Kasm Workspaces uses a PostgreSQL database to store application data. The Docker container kasm_db holds this database.

Deployment Zone

A Deployment Zone is a logical or geographic grouping of Agents and Managers. Large or complex installations deploy multiple sets of Agents and Managers across different zones to serve users in separate logical or geographic areas.

Desktop

(container: kasmweb/desktop) The default base desktop configuration, based on Ubuntu 16.04. This base image contains the configurations that allow the container to function within the Kasm ecosystem. All additional images are based on this base image.

Desktop Deluxe

(container: kasmweb/desktop-deluxe) A Kasm image based on the Desktop container. This image is an example custom configuration that provides additional productivity software.

Docker

Docker is the platform that creates and runs Kasm Workspaces containers. For more information, see the Docker homepage.

Egress Plugin Service

The Egress Plugin Service is a Kasm cloud service used with the Managed Egress feature. When a license that grants Managed Egress is applied to an installation, the installation communicates with the Egress Plugin Service to obtain Managed Egress Providers and Managed Egress Accounts.

Firefox

(container: kasmweb/firefox) A Kasm image based on the Desktop container. This image is an example of hosting a single application, in this case the Firefox browser.

Installation ID

The Installation ID is the key generated by a specific Server installation, and it is used to license Kasm Workspaces. The Installation ID appears in the System Info tab on the navigation menu.

License Key

A License Key licenses an offline Kasm Workspaces installation. The Kasm Workspaces activation tool provides the License Key.

Manager

The Manager is the Kasm Workspaces component that monitors the status of Agents and end-user sessions. Agents report to the Manager through an automatic check-in process. It can be found in the Docker container kasm_agent.

Proxy

The Proxy forwards traffic to the correct service container. The Docker container kasm_proxy holds the nginx configuration that the Proxy uses.

Server

A Server is a physical or virtual host that serves desktops or applications using RDP, VNC, SSH, or KasmVNC. Kasm Workspaces manages sessions to fixed Servers that support one or more concurrent users. Kasm Workspaces can also AutoScale Servers to meet user demand. Linux and Windows Servers are supported.

Session

A Session is an on-demand instance of a Workspace registered in the application. End users request Sessions, which the Agent provisions. Each Session container houses the desktop or application presented to the end user through the web application.

Web Application

The Web Application is the user interface for the Kasm Workspaces server. It is usually hosted on the selected domain on port 443 for HTTPS traffic, and it contains the tabs used for operating and administering the server.

Workspace

A Workspace is a full desktop, a single application, or a direct web link made available to users based on group membership. Desktops and applications can be containerized workloads started on demand or direct connections to KasmVNC or RDP endpoints. Any number of Workspaces can be registered through the web application. An Administrator can customize a Workspace to add software and configurations, and can set the CPU, memory, and network resources for each Workspace through the Workspace settings. Several Docker images are installed and registered as Workspaces by default. For the list, see Default Docker images.