-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
210 additions
and
0 deletions.
There are no files selected for viewing
8 changes: 8 additions & 0 deletions
8
docs/install-configure/linux-virtual-appliance/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "Linux Virtual Appliance", | ||
"position": 5, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "This guide explains the process for setting up a CloudShell Execution Server on a Linux vCenter VM." | ||
} | ||
} |
34 changes: 34 additions & 0 deletions
34
docs/install-configure/linux-virtual-appliance/cs-linux-va-known-limitations.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# CloudShell Linux VA Known limitations | ||
|
||
This section lists known limitations. | ||
|
||
- The time zone cannot be automatically detected when running CloudShell Authoring commands on execution servers over Linux. Therefore, when using TestShell API in a driver, add the `SetServerConnectionTimeZone` function to the driver (after the Logon function). Alternatively, to set the time zone for all drivers on a specific execution server, set the `ClientTimeZoneId` configuration key in the customer.config file of the Linux execution server’s installation directory. | ||
- When using file system library, the file location syntax in use must match that used by the Linux directory structure. | ||
- The Excel file extensions that are not supported are listed in the following table: | ||
|
||
| Method/Format | XLS | XLSX | XLSM | | ||
| --- | --- | --- | --- | | ||
| Read | | X | X | | ||
| Write | X | X | X | | ||
| GetSheetNames | | X | X | | ||
|
||
- Drivers cannot contain any of the following components: | ||
- Ranorex / GUI Automator | ||
- Command shell (PowerShell) | ||
- TestShell Spy | ||
- exe assets (that is, an exe called from an exe) | ||
- Web service asset | ||
- ActiveX asset | ||
- VISA tool | ||
- Cisco OS | ||
- The following are not supported: | ||
- Virtualization (solution packs) | ||
- Layer 2 VLAN (solution packs) | ||
- SNMP library | ||
- JSON Editor convert to XML method | ||
- XML Editor validate with XSD method | ||
- VMware vSphere libraries |
4 changes: 4 additions & 0 deletions
4
docs/install-configure/linux-virtual-appliance/installation-procedure/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Installation Procedure", | ||
"position": 2 | ||
} |
7 changes: 7 additions & 0 deletions
7
...-configure/linux-virtual-appliance/installation-procedure/create-es-from-ovf.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Create VM using the OVF Template (vSphere) | ||
|
||
WIP |
7 changes: 7 additions & 0 deletions
7
...onfigure/linux-virtual-appliance/installation-procedure/create-es-from-qcow2.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Create VM using the qcow2 Image File (KVM) | ||
|
||
WIP |
7 changes: 7 additions & 0 deletions
7
...nfigure/linux-virtual-appliance/installation-procedure/create-es-from-script.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Create the Linux Execution Server from a Script | ||
|
||
WIP |
13 changes: 13 additions & 0 deletions
13
docs/install-configure/linux-virtual-appliance/installation-procedure/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Installation Procedure | ||
|
||
This chapter explains how to install **CloudShell Execution Server Linux Virtual Appliance**. | ||
|
||
**To install and configure CloudShell Execution Server Linux Virtual Appliance:** | ||
|
||
1. Use the installation option that is suitable for your operating system: | ||
|
||
- For VMware vSphere users: [Create VM using the OVF Template (vSphere)](https://help.quali.com/Online%20Help/0.0/Portal/Content/Linux/Crt-VM-vSphere-Tmpl.htm) | ||
- For Linux KVM users: [Create VM using the qcow2 Image File (KVM)](https://help.quali.com/Online%20Help/0.0/Portal/Content/Linux/Crt-VM-qcow2-Img.htm) | ||
- If you already have an available VM: [Create the Linux Execution Server from a Script](https://help.quali.com/Online%20Help/0.0/Portal/Content/Linux/Crt-VM-ES-Script.htm) | ||
|
||
2. Perform the post installation procedures described here: [Post Installation](https://help.quali.com/Online%20Help/0.0/Portal/Content/Linux/Post-Instl.htm). |
4 changes: 4 additions & 0 deletions
4
docs/install-configure/linux-virtual-appliance/linux-es-va-overview/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Linux Execution Server Virtual Appliance Overview", | ||
"position": 1 | ||
} |
30 changes: 30 additions & 0 deletions
30
...-configure/linux-virtual-appliance/linux-es-va-overview/download-es-va-image.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Downloading the Linux Virtual Appliance Image | ||
|
||
The installation files for CloudShell Linux Virtual Appliance are available from [CloudShell Download Center](https://support.quali.com/hc/en-us/articles/231613247-Quali-s-Download-Center). | ||
|
||
**To locate the installation files:** | ||
|
||
1. Go to the Quali's Latest Release page in the **CloudShell Download Center**. | ||
|
||
:::note | ||
Registration to the QualiSystems portal is required. If you have not registered. To register, click [New registration](https://support.quali.com/entries/43187197). | ||
::: | ||
|
||
The installation files are available under **Linux Execution Server** in the **CloudShell Versions** section. | ||
|
||
2. Download the Execution Server script or image package that matches your CloudShell version to a temporary location: | ||
|
||
- **Execution Server on Linux for vSphere** to deploy the Linux Execution Server image on vSphere or KVM. | ||
|
||
- **Execution Server Installation Script for CentOS** to install the Linux Execution Server on an existing VM | ||
|
||
|
||
For example, the installation files for 2020.2 GA: | ||
|
||
![](/Images/Linux2/QualiDownloadCenter-InstallationScript.png) | ||
|
||
3. Next, create the Linux Execution Server, as explained in [Installation Procedure](https://help.quali.com/Online%20Help/0.0/Portal/Content/Linux/Instl-Prcdr.htm). |
9 changes: 9 additions & 0 deletions
9
docs/install-configure/linux-virtual-appliance/linux-es-va-overview/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Linux Execution Server Virtual Appliance Overview | ||
|
||
CloudShell supports Execution Server on Linux (CentOS 7). You can use the image provided in the **CloudShell Execution Server over Linux** to create a virtual machine (VM) that enables the execution of commands in a distributed fashion in a Linux environment, including Ansible configuration management operations on deployed Apps (suite execution is only available for the Windows version). The CloudShell Execution Server application is packaged in the VM that is created using the procedures described in this document. Alternatively, there's a script you can use if you want to configure an existing VM as a Linux Execution Server. | ||
|
||
This document describes how to download the solution pack and create VMs from the image that it provides. | ||
|
||
## 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. |
12 changes: 12 additions & 0 deletions
12
docs/install-configure/linux-virtual-appliance/linux-es-va-overview/limitations.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Limitations | ||
|
||
**CloudShell Execution Server over Linux Virtual Appliance** does not support: | ||
|
||
- The running of TestShell tests | ||
- Shells from versions earlier than CloudShell 6.3 | ||
- Drivers that use shells from versions earlier than CloudShell 6.3. These should be recompiled with updated shells | ||
- Authoring driver commands |
18 changes: 18 additions & 0 deletions
18
...stall-configure/linux-virtual-appliance/linux-es-va-overview/sw-requirements.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Software Requirements (Linux VA) | ||
|
||
The Execution Server Virtual Appliance is available in two flavors, VMware vSphere image format and KVM image format. | ||
|
||
- vSphere (For Windows and Linux environments) | ||
- KVM (For Linux environments) | ||
- (For Ansible configuration management) Python 3.9.x and Ansible 2.9.27 command line installation. See the formal [Ansible Installation help files](https://docs.ansible.com/ansible/latest/installation_guide/index.html). | ||
|
||
The Virtual Appliance comes with Python 2.7.18 and 3.9.9 installed and configured out of the box. | ||
|
||
|
||
## Related Topics | ||
|
||
- [Minimum Requirements for CloudShell Servers and Clients](https://help.quali.com/Online%20Help/0.0/Portal/Content/IG/Overview/srvrs.htm) |
8 changes: 8 additions & 0 deletions
8
docs/install-configure/linux-virtual-appliance/post-installation/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "Post Installation", | ||
"position": 3, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "After installing the VM, perform the post installation steps in the order described in this section." | ||
} | ||
} |
7 changes: 7 additions & 0 deletions
7
...ure/linux-virtual-appliance/post-installation/configure-linux-es-for-ansible.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Configure the Linux Execution Server for Ansible | ||
|
||
WIP |
4 changes: 4 additions & 0 deletions
4
docs/install-configure/linux-virtual-appliance/post-installation/configure/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Configure the Linux Execution Server", | ||
"position": 2 | ||
} |
7 changes: 7 additions & 0 deletions
7
.../linux-virtual-appliance/post-installation/configure/example-run-config-file.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Example: How to Run the Configuration File | ||
|
||
WIP |
3 changes: 3 additions & 0 deletions
3
.../install-configure/linux-virtual-appliance/post-installation/configure/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Configure the Linux Execution Server | ||
|
||
WIP |
7 changes: 7 additions & 0 deletions
7
.../install-configure/linux-virtual-appliance/post-installation/log-into-the-vm.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Log into the VM | ||
|
||
WIP |
21 changes: 21 additions & 0 deletions
21
docs/install-configure/linux-virtual-appliance/post-installation/start-the-es.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Start the Linux Execution Server | ||
|
||
**To start the Execution Server:** | ||
|
||
1. Navigate to the following folder: | ||
|
||
`/root/ExecutionServer` | ||
|
||
2. Run the following command: | ||
|
||
```javascript | ||
sudo systemctl restart es | ||
``` | ||
|
||
The execution server is displayed in the CloudShell portal, as depicted in the following image: | ||
|
||
![](/Images/Linux2/Starting-the-Execution-Server_513x157.jpg) |