Installation Guide

This help article applies to CloudShell 9.3. To see the latest, click here.

You are here: CloudShell Suite Installation Guide > CloudShell Components

CloudShell Components

The following diagram illustrates a basic CloudShell deployment:

* TestShell and CloudShell Authoring are paid CloudShell add-on solutions.

For details about the ports required for communication between the components, see CloudShell Required Ports. For details about CloudShell in High Availability mode, see High Availability Deployment Types.

The CloudShell components are described in the following table:

Component

Description

Quali Server

Runs the CloudShell framework and manages CloudShell data.

CloudShell Portal

A self-service web client that enables you to manage your resources, create and manage blueprints and sandboxes, as well as manage and schedule your automated testing.

You can leverage CloudShell’s extensive automation capabilities to run blueprint and resource commands as well as automate business use cases within Sandboxes.

Execution Server

Remotely executes setup, teardown and sandbox commands. It can also execute test suites and jobs from the Job Scheduling dashboard. This component adds to CloudShell Portal's total execution capacity. Execution servers can be either Windows or Linux-based.

CloudShell Authoring *

Code-free hardware interface editor for quick driver development for any blueprint, supporting full equipment interchangeability and automatic documentation for easy collaboration.

CloudShell Resource Management Client

Use CloudShell Resource Manager to manage resources and usage. For an example of using this component, see Import User Definitions from an Active Directory (Optional).

CloudShell Remote Runner

Executes CloudShell-specific automation steps or complete scenarios on remote stations, enabling the launch of any script or protocol on a remote machine, without requiring complex infrastructure.

TestShell Studio *

Desktop applications for GUI based test authoring and execution. (Studio and Runner are automatically installed with TestShell Studio.)

CloudShell License Server

Manages network license distribution. The License Server can be installed on any machine, and should be installed before installing client components.

CloudShell Runtime

Supports the execution of CloudShell flows and drivers.

Quali API

The Quali API library provides access to job scheduling operations from outside of the Job Scheduling dashboard, as well as functions related to sandboxes, for example, attach file to sandbox and import and export of blueprints.

TestShell API *

The TestShell API library comprises functions for interacting with Quali Server. For example, you can use API functions to create and configure resources, blueprints, routes, and Sandboxes. This API library also provides a set of lab management batch operation functions.

CloudShell Sandbox API

The CloudShell Sandbox API is a REST API that enables you to consume and interact with CloudShell sandboxes. Using Sandbox API, it is possible to integrate CloudShell with software interfaces to develop and automate Continuous Integration/DevOps processes. For example, you can use API functions to view details about blueprints and sandboxes related to a particular user domain and user permissions, and the available actions that can be performed on the blueprints and sandboxes.

The Sandbox API consists of three components, which reside on the CloudShell Portal machine:

  • CloudShell Server Proxy - communicates with Quali Server, and communicates internally with CloudShell Sandbox API Gateway
  • CloudShell Sandbox API Gateway - communicates internally with CloudShell Sandbox API
  • CloudShell Sandbox API - communicates with API Client

Database Server

CloudShell is supported with SQL database. For more information, see Database Prerequisites.

PyPi Server

CloudShell manages driver and script dependencies using PyPi Server.

Elastic Search

The 64-bit version of Java is required when using a 64-bit version of Windows.

SisenseCloudShell Insight (BI Server).

QualiX

Used for remote desktop gateway (must be accessible from CloudShell Portal and the browsers)