Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
lizoron committed Mar 7, 2024
2 parents 267ca09 + 603849d commit 1d995ec
Show file tree
Hide file tree
Showing 41 changed files with 383 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/install-configure/qualix/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "QualiX",
"position": 4
}
8 changes: 8 additions & 0 deletions docs/install-configure/qualix/appendix/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Appendix",
"position": 8,
"link": {
"type": "generated-index",
"description": " "
}
}
7 changes: 7 additions & 0 deletions docs/install-configure/qualix/appendix/qualix-known-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# QualiX Known Issues

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 3
---

# (Optional) Removing Message at Startup

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 2
---

# Setting QualiX to UTC Time

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Working with QualiX VM",
"position": 4
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 1
---

# Copying Text to and from Machines using RDP

Use the following steps to pass strings from the client machine to the machines to which you are connected with RDP.

**To copy strings from the client machine:**

1. In a browser in an RDP session, press **Ctrl + Alt + Shift**. The clipboard section displays in a pane on the left side of the screen.
2. Copy any string from the client machine to the clipboard.
3. Press **Ctrl + Alt + Shift** to close the pane and then paste the string to the machine you are connected to.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Working with QualiX VM

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 2
---

# Transfer Files from the Client Machine

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 3
---

# Transfer Files to the Client Machine

WIP
7 changes: 7 additions & 0 deletions docs/install-configure/qualix/high-level-setup-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 2
---

# QualiX High-level Setup Process

WIP
16 changes: 16 additions & 0 deletions docs/install-configure/qualix/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# QualiX Installation and Configuration

This guide explains how to set up QualiX to allow sandbox end-users to remotely connect to the resources and Apps from within the sandbox.

## Related Topics

- [QualiX Overview](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Ovrv.htm?TocPath=Installation%20and%20Configuration|QualiX|QualiX%20Overview|_____0)
- [QualiX High-level Setup Process](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/QualiX-high-level-process.htm?TocPath=Installation%20and%20Configuration|QualiX|_____2)
- [Installation and Configuration](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Instl-Cnfg.htm?TocPath=Installation%20and%20Configuration|QualiX|Installation%20and%20Configuration|_____0)
- [Log into the QualiX Server VM](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Strt-Login-to-VM.htm?TocPath=Installation%20and%20Configuration|QualiX|_____4)
- [Post Installation Configuration](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Post-Instl-Cnfg.htm?TocPath=Installation%20and%20Configuration|QualiX|Post%20Installation%20Configuration|_____0)
- [Prepare and Reserve Blueprint](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Wrk-Rsc-Mng.htm?TocPath=Installation%20and%20Configuration|QualiX|_____6)
- [Training Portal (Over the Shoulder)](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Cnfg-over-the-shoulder.htm?TocPath=Installation%20and%20Configuration|QualiX|Training%20Portal%20(Over%20the%20Shoulder)|_____0)
- [Appendix](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Appendix.htm?TocPath=Installation%20and%20Configuration|QualiX|Appendix|_____0)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Installation and Configuration",
"position": 3,
"link": {
"type": "generated-index",
"description": "This chapter includes the following topics:"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_position: 1
---

# Create VM using the OVF Template (vSphere)

Use the following steps to use vSphere to deploy the QualiX template and create a VM.

**To create a VM by deploying the OVF template:**

1. In your local machine, login to vSphere with administrator credentials.
2. Click **File > Deploy OVF Template**.
3. In the **Deploy OVF Template** window, click **Browse**. Navigate to the directory where the installation files are located.
4. In the **Deploy from a file or URL** field, navigate to and then select the required OVF file.
5. Click **Next**. View the summary of the OVF template. If the displayed details are correct, click **Next**.

The **End User License Agreement** page is displayed with the details of license agreements that are associated with the software that is installed in the OVF template.

6. Accept the license agreements to deploy the OVF template. If no license agreements are associated with the installed software, this screen does not appear. Click **Next**.
7. Enter the name for the deployed OVF template. The length of the name can be up to 80 characters long and should be unique within the VM folder. Names are case sensitive.
8. Select the folder location within the inventory for the virtual appliance. Click **Next**.
9. Specify **Thin Provision**. Click **Next**.
10. When the deployment has completed, click **Power On**.
11. Right-click the VM and select **Open Console**.
12. In the VM console window, check the **Settings Screen** to make sure that it uploaded without errors.

13. After installing the QualiX VM, continue with [Post Installation Configuration](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Post-Instl-Cnfg.htm).
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 2
---

# Deploy QualiX 4.1 using Docker

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 3
---

# Deploy QualiX 5.0 and up Using Docker

WIP
18 changes: 18 additions & 0 deletions docs/install-configure/qualix/log-into-qualix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 4
---

# Log into the QualiX Server VM

This article only applies to QualiX over vSphere (not docker).

**To log into the new VM:**

1. Power on the new VM.
2. Login as the root user.

The default credentials are:

Username: **root**

Password: **qs1234**
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Post Installation Configuration",
"position": 5
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 4
---

# Enable QualiX Docker Deployment to Work With Trusted Java KeyStore Certificate

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# Configure Remote Access to Sandbox Components Using SSH, RDP, Telnet, VNC (QualiX)

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 2
---

# Configure VM Web Console Access to vCenter App VMs (QualiX)

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 5
---

# Customize Remote Access Terminals

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Enable HTTPS Connection Between QualiX and CloudShell Portal",
"position": 3
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# Configure SSL Certificate on QualiX 4.1 Docker Container

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Enable HTTPS Connection Between QualiX and CloudShell Portal

WIP
28 changes: 28 additions & 0 deletions docs/install-configure/qualix/post-installation-config/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Post Installation Configuration

This section describes the configuration steps that are required after the first login to QualiX VM.

In the configuration process, you set up the remote access terminals that tell CloudShell how to create the connections to the sandbox components. The terminals are defined in the Quali Server machine's `ServerUniversalSettings.xml` file.

For example:

```xml
<key name="RDP" pattern="http://<CloudShell Portal Host>:<CloudShell Portal Port>/Qx/connect?qualix=<VM IP>&amp;qualixType=https&amp;rdp{qid}&amp;qtoken={qtoken}&amp;hostname={Address}&amp;protocol=rdp&amp;port=3389&amp;username={User}&amp;password={Password}&amp;security=any&amp;ignore-cert=true" icon-key="RDP" />
```

QualiX provides two methods for remote access connectivity (each has its own remote access terminals):

- Apache Guacamole provides access via RDP, SSH, Telnet and VNC.
- QualiX’ **VCenter Console Proxy** service provides access to vCenter App VMs using vCenter's VM Web Console.

## In this chapter:

- [Configure Remote Access to Sandbox Components Using SSH, RDP, Telnet, VNC (QualiX)](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Cnfg-Quali-Srv.htm)
- [Configure VM Web Console Access to vCenter App VMs (QualiX)](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Cnfg-vCenter-Console.htm)
- [Enable HTTPS Connection Between QualiX and CloudShell Portal](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Cnfg-SSL-Suprt.htm)
- [Enable QualiX Docker Deployment to Work With Trusted Java KeyStore Certificate](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Cnfg-jks-cert.htm)
- [Customize Remote Access Terminals](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Cstmz-rmt-access-trmnl.htm)
- [Set a Static IP for the QualiX VM](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Set-Static-IP.htm)
- [Restrict QualiX Access to Specific CloudShell Portals](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Restrict-qualix-access-to-portals.htm)
- [Modify Number of CPUs and Allocated Memory](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Mdfy-no-CPUs-allctd-mem.htm)
- [QualiX Configuration for Version 5.0 and up](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Cnfg-Qualix-5.0.htm)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 8
---

# Modify Number of CPUs and Allocated Memory

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 9
---

# QualiX Configuration for Version 5.0 and up

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 7
---

# Restrict QualiX Access to Specific CloudShell Portals

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 6
---

# Set a Static IP for the QualiX VM

WIP
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 6
---

# Prepare and Reserve Blueprint

WIP
4 changes: 4 additions & 0 deletions docs/install-configure/qualix/qualix-overview/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "QualiX Overview",
"position": 1
}
23 changes: 23 additions & 0 deletions docs/install-configure/qualix/qualix-overview/download-qualix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_position: 4
---

# Downloading the QualiX Installation Files

**To download the QualiX installation files:**

1. Download the appropriate **QualiX Server extension**.

- The vCenter image is available in [QualiX Download Center](https://support.quali.com/hc/en-us/articles/360037650694).

:::note
Downloading the vCenter image requires registration to the Quali Support Portal. If you have not registered, click this link to register [New registration](https://support.quali.com/).
:::
- The script for installing the dockerized QualiX image is embedded in the installation instructions at [Deploy QualiX 4.1 using Docker](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Instl-Cnfg-Docker.htm) and [Deploy QualiX 5.0 and up Using Docker](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Instl-Cnfg-Docker-5.0.htm).
2. Download the files into a temporary location on your local machine.

The vCenter folder contains an .md5 file with a list of files in that folder and their md5 checksum.

3. Next, deploy the QualiX VM or docker containers, as explained in [Installation and Configuration](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Instl-Cnfg.htm).
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# How QualiX Works

WIP
16 changes: 16 additions & 0 deletions docs/install-configure/qualix/qualix-overview/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# QualiX Overview

This guide describes how to download the QualiX installation files, perform the installation and configuration to provide a virtual appliance (VA). QualiX can run on a vSphere VA, or on a Docker container. The QualiX VA allows you to integrate Remote Desktop capabilities directly into your browser.

As a CloudShell user, this enables you, directly from your browser, to remotely connect to and control machines that are present in a sandbox.

Advantages of working with QualiX:

- Makes working with Remote Desktop Protocol (RDP) a seamless, integrated experience without the need to use other tools to connect.
- Enables you to use other remote connections, such as SSH and Telnet sessions, to connect to and control machines in a sandbox.
- Provides support for copy/paste operations as well as file transfer to and from the QualiX machine.
- And more...

## Troubleshooting

You are invited to check out the [CloudShell Troubleshooting](https://help.quali.com/Online%20Help/0.0/Portal/Content/Troubleshooting/Troubleshooting.htm) guide which includes common error messages and step-by-step instructions to resolving them. You can search the guide by error message to find the article that relates to your issue. The guide also includes instructions on how to collect logs including CloudShell system logs, QualiX logs, Linux Execution Server logs, and Python-based logs.
Loading

0 comments on commit 1d995ec

Please sign in to comment.