Skip to content

Commit

Permalink
qualix wip batch
Browse files Browse the repository at this point in the history
  • Loading branch information
lizoron committed Mar 8, 2024
1 parent d36409d commit 8023f68
Show file tree
Hide file tree
Showing 14 changed files with 702 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ sidebar_position: 1

# QualiX Known Issues

WIP
| | |
|--|--|
| **Attribute of type Lookup cannot be used** | In CloudShell Resource Manager, when defining or modifying attributes to be used in the connection string for QualiX features like SSH, TELNET and RDP, an attribute of type Lookup cannot be used. |
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,31 @@ sidebar_position: 3

# (Optional) Removing Message at Startup

WIP
Perform these steps to remove a message stating that the VM is looking for a floppy drive at startup. These steps remove the floppy drive from the BIOS of the VM.
:::note
The functionality of the VM is not affected whether these steps are performed or not.
:::
**To modify the VM settings:**

1. In the desktop, open the VMware vSphere client.
2. Right-click the VM in the vSphere client and select **Edit Settings**.
3. Click the **Options** tab, select **Boot options**.
4. In the **Force BIOS Setup** area, select the option **The next time the virtual machine boots, force entry into the BIOS setup screen.**

![](/Images/QualiX/Optional-Removing-message.png)

5. Click **OK**.

6. Restart the VM.

On the restart of the VM, the **BIOS Setup Utility** is displayed.

![](/Images/QualiX/Optional-Removing-message_1.png)

7. In the **Main** tab, change the value of the default **Legacy Diskette A** to **Disabled**.
8. Select the **Boot** tab.

![](/Images/QualiX/Optional-Removing-message_2.png)

9. Modify the order that devices are set to boot. Move **Hard Drive** to the first position above **Removable Devices**.
10. Press **F10** to save and then exit the **Setup Utility**.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,39 @@
sidebar_position: 2
---

# Setting QualiX to UTC Time
# Setting QualiX to UTC Time

WIP
QualiX uses UTC timestamps to validate basic operations and therefore must be synchronized with the Quali Server.

We recommend to synchronize the QualiX machine with your organization's Network Time Protocol (NTP) server. However, if you do not have an NTP server, you can use the following procedure.

**To set QualiX to UTC time (manually, without NTP):**

1. Download the **SetQualiXTimeZone** utility: Open [Quali's QualiX Download Page](https://support.quali.com/hc/en-us/articles/360037650694), search the page for "utilities", and click the **Utilities** link of the appropriate QualiX version:

![](/Images/QualiX/SetUTCTimeUtilityLocation.png)

2. Extract the files to your local directory.
3. Edit the `.\SetQualiXTimeZone.ps1` file and set the username and password to the QualiX machine:

![](/Images/QualiX/SetqualiXTimeZoneSetCreds.png)

4. Save the file and run the `.\SetQualiXTimeZone.ps1` file with Windows PowerShell.

If you get an error message that running scripts is disabled on your system, run the following command and try again:

```javascript
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
```

5. When prompted, enter the IP address of the QualiX machine.

The command returns the current time and date on the QualiX machine and Quali Server.

6. If the QualiX machine's time is different from the time on Quali Server, when prompted, enter the UTC time that is set on the Quali Server machine, in `HH:mm` format.
For example:
![](/Images/QualiX/Input-UTC-Time.png)
The QualiX machine's time is updated.
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Working with QualiX VM

WIP
This section describes how to use functions to copy text to and from machines by using RDP/SSH through your browser, and how to transfer files to and from client machines. There is also an example of how to create attributes, resources, and blueprints, and then how to reserve the new blueprints.
:::note
QualiX 3.2 on Docker provides clipboard integration, allowing you to copy/paste content and files to and from docker.
:::
In this section:

- [Copying Text to and from Machines using RDP](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Copy-txt-from-other-machines-RDP.htm)
- [Transfer Files from the Client Machine](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/File-trnsfr-from-client.htm)
- [Transfer Files to the Client Machine](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/File-transfer-to-the-client.htm)
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,18 @@ sidebar_position: 2

# Transfer Files from the Client Machine

WIP
Use the following steps to transfer files from the client machine to the machine to which you are connected with RDP or SSH.

**To transfer files to the RDP machine:**

1. In the client machine, drag the specified file to a browser that is in an RDP session and press **Ctrl + Alt + Shift**. The side pane displays. Close this pane.
2. In the machine to which you are connected with RDP through the browser, open **My Computer** and select the new **G on Guacamole RDP** hard disk. Open this hard drive.
3. Move the file to the desktop.

**To transfer files to the SSH machine:**

1. Make sure the SSH connection supports file transfers. For details, see [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).
2. While connected to a host via SSH using QualiX, use the shortcut to bring up the options menu (CTRL + SHIFT + ALT)
3. Click the **Devices** button
4. Navigate to the required file location by double-clicking a folder to open.
5. To upload a file to the selected location, click the **Upload Files** button and browse to the file(s) you wish to upload. You may select multiple files from the same folder to upload.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,16 @@ sidebar_position: 3

# Transfer Files to the Client Machine

WIP
Use the following steps to transfer files from the machine to which you are connected with RDP/SSH to the client machine.

**To transfer files from the RDP machine to the client machine:**

1. In the machine to which you are connected with RDP through the browser, move the required file to the **Downloads** folder in the new **G on Guacamole RDP** hard disk.
2. Press **Ctrl + Alt + Shift** to open the side pane. The file that was transferred is available and can be saved to the required location.

**To transfer files from the SSH machine to the client machine:**

1. In the machine to which you are connected with SSH through the browser, copy the files.
2. Press **Ctrl + Alt + Shift** to open the side pane.
3. Click the **Devices** button and navigate to the destination folder.
4. Click **Upload Files**.
27 changes: 26 additions & 1 deletion docs/install-configure/qualix/high-level-setup-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,29 @@ sidebar_position: 2

# QualiX High-level Setup Process

WIP
QualiX provides remote access connections to resource and App devices from your sandbox. This is the basic setup process:

1. Download the QualiX installation files.
2. Install QualiX Server on a vSphere VM or Docker container.
3. Log into the QualiX Server VM (for QualiX over vSphere).
4. Configure remote connection terminals in the Quali Server machine's `ServerUniversalSettings.xml` file.

For example:

```javascript
<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" />
```

These terminals define the connection protocol to be used (RDP in the above example), admin access credentials and other relevant details.


QualiX provides two methods for remote access connectivity:

- Apache Guacamole provides access via RDP, SSH, Telnet and VNC. Apache Guacamole uses two services, which are activated by default when installing QualiX Server - **qualix\-tomcat** and **qualix\-guacd**.
- QualiX’ **VCenter Console Proxy** service provides access to vCenter App VMs using the vCenter Console. The vCenter Console Proxy service is disabled by default and needs to be manually activated.

## Related Articles

- [Downloading the QualiX Installation Files](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Dwnld-QualiX-instl.htm)
- [Installation and Configuration](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Instl-Cnfg.htm)
- [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
Expand Up @@ -4,4 +4,74 @@ sidebar_position: 2

# Deploy QualiX 4.1 using Docker

WIP
This process deploys two docker containers, **quali\_hub/qualix\_guacamole** and **quali\_hub/qualix\_guacd**, and the network they will use to communicate with each other.

**Docker for Windows** is not supported.
:::note
Make sure to have docker together with iptables when running containers on a linux vm
:::
**To deploy QualiX using Docker:**

1. Install Docker Engine, as explained in this [docker docs article](https://docs.docker.com/install/).
2. Install Docker Compose, as explained in this [docker docs article](https://docs.docker.com/compose/install/).
3. Run the following from the `/opt/` directory:

```javascript
sudo wget https://quali-prod-binaries.s3.amazonaws.com/guacamole-quali-install-docker.sh
sudo chmod +x guacamole-quali-install-docker.sh
sudo ./guacamole-quali-install-docker.sh
```

4. Start the QualiX container stack by running the following from the `/opt/qualix` directory:

`sudo ./start.sh`

5. To verify that QualiX is up and running, run the following:

```javascript
sudo status
```

6. After deploying QualiX on docker, continue with [](https://help.quali.com/Online%20Help/0.0/work/QualiSystems/Documentation/CloudShell/9.3/CloudShell%20Help%20Center/Content/QualiX/Post-Instl-Cnfg.htm#_Post_installation_configuration)[Post Installation Configuration](https://help.quali.com/Online%20Help/0.0/Portal/Content/QualiX/Post-Instl-Cnfg.htm).

## Additional Options

**To stop QualiX (stops the container stack):**

```javascript
sudo stop
```

**To restart QualiX after boot (inactive docker):**

`sudo systemctl enable docker`

**To get the docker logs:**

See [Docker logs (QualiX 4.1 and below)](https://help.quali.com/Online%20Help/0.0/Portal/Content/Troubleshooting/Collecting-logs.htm#QualiX2).

**To attach the docker container to a shell:**

```javascript
sudo docker exec -it <container_id>/bin/sh -c "[ -e /bin/bash ] && /bin/bash || /bin/sh"
```

**To destroy running containers:**

```javascript
sudo docker stop guacamole guacd
```

```javascript
sudo docker rm guacamole guacd
```

**To start the containers:**

```javascript
cd /opt/qualix
```

```javascript
sudo ./start.sh
```
Loading

0 comments on commit 8023f68

Please sign in to comment.