qualisystems - quali | automation for cloud and devops ... · this returns a list of all testgroup...
TRANSCRIPT
QualiSystems
6.2.3 TeraVM Solution Pack
Release date: October 2015
Document version v1.1
QualiSystems Ltd. Confidential and proprietary.
All Rights Reserved. No part of this software or material may be copied, reproduced,
stored in or introduced into a retrieval system, distributed or displayed in any form or
manner for any purpose whatsoever and no derivative works may be made without
QualiSystems Ltd. advance written consent. All trademarks, brand names, product
names and logos are trademarks or registered trademarks of QualiSystems Ltd. or
applicable licensor [TestShell, CloudShell, the QualiSystems logo and the TestShell
logo. The absence of a trademark from this list does not constitute a waiver of
QualiSystems or applicable licensor's intellectual property rights concerning that
trademark].
The above copyright and trademark notices shall be included in all such software and/or
materials.
Copyright, 2015, QualiSystems Ltd. Software and materials are copyrighted and
trademarked by QualiSystems Ltd. and any incorporated third party software is
copyrighted by its respective licensor.
2
Contents
Overview .......................................................................................................... 3
Requirements ............................................................................................................. 3
Prerequisites .............................................................................................................. 3
Downloading the solution pack ................................................................................... 3
Solution pack contents ............................................................................................... 4
Commands ................................................................................................................. 4
TVM Controller resource....................................................................................... 4
Import, configure and modify the solution pack ................................................ 6
Importing the solution pack into CloudShell Portal ...................................................... 6
Data family and model configuration values .................................................... 7
Resources .................................................................................................................. 7
Families and Models ............................................................................................. 7
Attributes .............................................................................................................. 8
TeraVM service attributes........................................................................................... 9
Configuring remote access to the TVM-C ...................................................... 11
Configuring TVM-MA ..................................................................................... 12
Typical workflow and scenarios ..................................................................... 15
Typical workflow ....................................................................................................... 15
Use cases and scenarios ......................................................................................... 16
Scenario 1 .......................................................................................................... 16
Scenario 2 .......................................................................................................... 16
Scenario 3 .......................................................................................................... 16
Networks .................................................................................................................. 17
Appendix A - Run the sample environment .................................................... 18
Running the TVM sample environment ..................................................................... 18
Example to stop a specific Test Group ..................................................................... 21
Appendix B – Listing of imported attributes .................................................... 23
Displaying the attributes in Resource Manager ........................................................ 23
References ............................................................................................................... 24
3
Overview
The TeraVM Solution Pack provides a solution to orchestrate an environment based on
the Cobham TeraVM traffic generator, suitable for testing devices.
This guide describes how to download and configure the TeraVM Solution Pack and
how to use CloudShell to orchestrate the deployment and operation of TeraVM
controller, cards and ports.
An example environment is provided and step by step instructions on how to deploy the
resources, spin TeraVM up, configure the TeraVM controller and run traffic tests on
devices or networks between selected ports. After completing the traffic tests, spin
TeraVM down.
Requirements
CloudShell 6.2.3 with HF9 or later
L2 VLAN Solution Pack
vCenter Virtualization Solution Pack
QualiX Solution Pack (Optional – see Configuring remote access to the TVM-C)
PowerCLI 5.5 Release 1 installed on the CloudShell execution server
ESXi version 5.5 (vCenter 5.5) and above with virtual machine hardware version 9
and above
User supplied virtual Device Under Test (vDUT) or virtual Network Under Test
(vNUT)
Prerequisites
Deploy a VM with TVM-MA version 11.3.443. For information about how to
configure the TVM-MA VM in CloudShell Resource Manager, see Configuring TVM-
MA.
A vSwitch portgroup or Distributed switch portgroup with access to a DHCP server
and network access to the QualiSystems execution server and the end user
For information about how to configure the Management network attribute of the
TVM-MA resource, see Configuring TVM-MA.
A TVM license server must be installed and accessible to the TVM-C that will be
deployed.
Downloading the solution pack
The TeraVM Solution Pack is available from the QualiSystem Solution-Pack-Download-
Center. Download the TeraVM Solution Pack into a temporary location.
Note: Registration to the QualiSystems Support Portal is required. If you have not
registered, click this link to register New registration.
4
Solution pack contents
The contents of the TeraVM Solution Pack are described in the following table:
Item Description Environment TeraVM sample environment. This environment has the TVM
Deployment driver and the TVM-MA Sample resource.
Components Datamodel: resource families and models.
Sample Resources TVM MA (Management Administrator).
Drivers Service driver – TVM Deployment Driver Resource drivers: TeraVM Controller Driver TeraVM Resource Driver
Note: QualiSystems reserves the right to change the contents of the solution pack.
Commands
This section describes the commands provided with the sample environment and
resources when the solution pack is imported.
TVM Controller resource
5
The TVM Controller resource provides the commands described in the following table.
Command Description Remove
Click to remove (delete) the TeraVM setup controller and cards.
To specify a specific sub-resource to be removed: 1. In the Resource Commands pane, in the Remove
command row, click located to the right of the
tool.
2. Click to specify the sub-resource to be removed.
Load Configuration File Load the TeraVM controller configuration file. Specify the path and filename in the text box. The test starts automatically after the file has been loaded.
GetLoadedTestGroupsForUser Get the loaded test group for the current logged in user. This returns a list of all TestGroup tests that were loaded for the user who logged into the controller.
StartTest Start the specified test. The name is case sensitive.
DeleteTestGroup Delete the specified test group from the controller. The name is case sensitive.
StopTest Stop the specified test. The name is case sensitive.
6
Import, configure and modify the solution pack
This section describes procedures for importing, configuring and modifying the TeraVM
Solution Pack.
Important: Before importing the TeraVM Solution Pack into CloudShell Portal, you must
import the following solution packs into CloudShell Portal in the order shown below:
• Import the vCenter Virtualization Solution Pack
• Import the Layer 2 VLAN Solution Pack
Thereafter download and import the TeraVM Solution Pack.
Importing the solution pack into CloudShell Portal
Use the following procedure to import the downloaded TeraVM Solution Pack after
having first imported the vCenter Virtualization and the Layer 2 VLAN solution packs.
To import the solution pack into CloudShell:
1. Backup your database.
2. Log into CloudShell Portal as administrator of the domain in which you are
working.
3. Click the Admin domain and then choose Import Package.
4. Browse to the location where the solution pack was downloaded (see
Downloading the solution pack) and select the solution pack zip file. Click
Open. Alternatively, drag the solution pack zip file into the Web browser
where CloudShell Portal is open.
The TeraVM Solution Pack is imported.
5. Press F5 to refresh the browser.
7
Data family and model configuration values
Use the guidelines described in the following topics to ensure that the resources are
correctly configured in CloudShell Resource Manager.
Resources
The resources should be modeled in Resource Manager according to the hierarchy
Resource Family and then the Resource Model, as depicted in the diagram below. This
is automatically configured when importing the solution pack.
Important: vCenter Resources must be modeled in Resource Manager to match the
hierarchy and structure that is defined in your own vCenter.
Families and Models
Component Description
TeraVM MA Sample Family: Traffic Generator Provider Model: TeraVM MA Address must be specified (IP or host name)
TVM Controller Sample/TVM Card Sample
Family: Traffic Generator Card Model: TeraVM Controller Address: Same as the Card name.
TVM Controller Sample Family: Traffic Generator Model: TeraVM MA Address must be specified (IP or host name)
TVM Controller Sample/Network adapter 1
Family: Virtual Network Interface Model: Generic Virtual NIC Address: Irrelevant
TVM Controller Sample/TVM Card Sample/Network adapter 1
Family: Traffic Generator Port Model: TeraVM Port Address: Irrelevant
Device drivers TeraVM Controller Driver TeraVM Resource Driver TVM Orchestration Environment Driver
DUT Device to be tested. This device is not part of the solution pack and is provided by the user.
8
Attributes
The attribute names and their attribute types are listed in the following table.
Attribute name
Attribute type
Default value
Description
Base Name String QS The attribute name. If not specified, the default name is used.
License Server String The TVM license server that must be accessible to the TVM-C.
Management Network
String This network is used to access the TVM-MA.
Password Password User authentication for the TVM-MA.
Simulated Boolean False This feature has not been enabled.
Tag String String used as an identifier.
TVM Card Type Lookup TVM_2 TVM Card type selection determines which TVM type to deploy. TVM_1= 1 card, 1 CPU, up to 8
ports, ports are mapped to portgroups
TVM_2= 1 card, 2 CPU, up to 8 ports, ports are maps to portgroups
TVM Cards to Deploy String Specify the number of cards to be deployed.
TVM MA Address String Specify the IP address of the TVM MA
TVM Max Controllers per Host
Numeric 4 The maximum number of controllers allowed for each host.
TVM Port Per Card Limit
String Set the maximum number of ports allowed per card.
TVM Ports Per Card String Specify the number of ports per card.
TVMControllerPassword
Password Password used for authentication when logging onto the TeraVM Controller.
TVMControllerUserName
String Username used for identification purposes for the TeraVM Controller.
User String User name for identification purposes for the TVM-MA.
VDS Name String Specify the VDS name if the ‘Management Network’ is part of VDS.
9
TeraVM service attributes
When you add a TeraVM service to an environment you are prompted to modify the
attributes, as depicted in the image below. If you do not specify a value, the default
value is used.
For further information, hover the cursor over the icon next to the input field. Specify
the inputs, as required.
The service attributes are described in the following table.
Attribute Description
Alias Specify an alternate name that can be used to make a connection.
Comms Network Specify the VLAN alias name on the active reservation to connect the internal TVM Comms network to. Note:
1) If left empty, uses TVM logic to create it. (vSwitch on the ESXi)
2) If entered ‘*’, creates a dedicated VLAN service for the Comms network
Datastore The datastore in which the TeraVM is deployed. If left blank, vSphere selects the datastore.
10
ESXI Host The name of the ESXi or cluster on which to deploy. If left blank, the driver picks the cluster or host name.
Ports per Card Determines how many cards are deployed, for example: If attached to 2 VLAN services, and the attribute is set to
‘1’, the TVM service creates 2 cards, each with 1 port connected to a VLAN service
If connected to 4 VLAN services, with the attribute set to 5, it creates 1 card with 4 connected ports. (Use the TeraVM Simple)
Temp Portgroup The name of the Portgroup on the vCenter to use for any unused TVM ports Note:
1) If left blank, uses ‘QS_TVM_TMP_PORTROUP’ on deployed ESXi
2) If entered a VDS portgroup name, the attribute ‘VDS Name’ needs to be filled with the VDS name.
TVM Card Type Specify the card type, one of the following: TVM_1 TVM_2 (Default)
TVM Cards to Deploy Set the number of TVM cards to deploy
Needs to be paired with ‘TVM Ports per Card’ attribute
TVM MA Address IP address of the TVM MA as specified in the Resource Manager.
TVM Port Per Card Limit
Set the limit of the ports that can be created for each TVM card.
- If set to ‘8’, each card is deployed with 8 ports - If set to ‘1’ deploys the minimal number of ports to
satisfy the reservation needs
TVM Ports Per Card Set the Number of ports each TVM card is to be deployed with. Needs to be paired with “TVM Cards to Deploy” attribute.
VDS Name Specify the VDS name to use for ‘Temp Portgroup’ and ‘Comms Network’
11
Configuring remote access to the TVM-C
You can extend the communication capabilities of the TeraVM Solution Pack to have
direct SSH and Web remote access from the TVM-C resource in the CloudShell
environment by adding and then setting configuration keys, as described in this section.
To modify CloudShell and extend the communication capabilities:
1. In the machine where CloudShell is installed, navigate to the following
directory:
C:\ProgramData\QualiSystems\Settings\Global
2. Open the following file in a text editor:
ServerUniversalSettings.xml
3. Adding the following keys to the customer.config file:
<key name="SSH" pattern="https://<IP address of
QualiX>/remote/#/client/c/ssh{qid}?qtoken={qtoken}&hostname
={Address}&protocol=ssh&port=22&username={TVMContro
llerUsername}&password={TVMControllerPassword}" icon-
key="SSH" />
<key name="Web" pattern="http://{Address}/" icon-key="SSH" />
4. Save the ServerUniversalSettings.xml file.
5. Restart the service.
To access the new options:
1. In a reservation, hover the cursor over the TeraVM resource.
2. Click More Options.
The various communication options display.
12
Configuring TVM-MA
This section describes how to configure the TVM-MA VM in CloudShell Resource
Manager.
To configure TVM-MA:
1. Log in to CloudShell Resource Manager.
2. In Resource Explorer, double-click TVM-MA.
14
The attributes are described in the following table:
Name Description
Name Name of the TeraVM Management Administrator
Address IP address of the TeraVM-MA
Base Name Every deployed TVM uses this name as the prefix.
License Server The TVM license server that must be accessible to the TVM-C.
Management Network This network is used to access the TVM-C.
Password Password used for user authentication on the TVM-MA.
Simulated This feature has not been enabled
TVMControllerPassword String of characters used for authentication when logging onto the TeraVM Controller.
TVMControllerUserName Username used for identification purposes for the TeraVM Controller.
User Name used for identification purposes on the TVM-MA.
VDS Name Specify the VDS name if the Management Network is part of a VDS.
4. Configure the attributes, as required.
5. Click Save All .
15
Typical workflow and scenarios
The TeraVM Solution Pack works together with the Layer 2 VLAN Solution Pack and
the vCenter Virtualization Solution Pack. You can optionally also use the QualiX
Solution Pack to provide extended communication functionality.
Typical workflow
The following procedure describes a typical workflow to orchestrate a TeraVM traffic
generator environment that is suitable for testing DUT or NUT devices.
To setup an environment with TeraVMs and test a device:
1. Add an environment with the TVM service driver, specifying the ESXi
server or cluster as input, number of ports per card, card type, TVM MA IP
address and a desired Datastore to deploy it on as Global Inputs.
2. Add VLAN Services to the reservation and connect them to the desire
vDUT\vNUT.
3. Run the Create Setup command.
The Orchestration of the resources in the environment starts to run.
4. The service driver selects the host for deployment, one of the following:
ESXi host
ESXi cluster - iterate over hosts in the cluster, for each host, check if
there is room for additional deployment. No more than 4 (as specified
using the ‘max controller per host’ attribute). TVM deployments are
allowed per host. The service selects the first available host.
You can leave the field empty – the service selects the first ESXi
cluster (assuming there is only one) and then selects an available
host.
5. Calculate the number of VLAN services on the active reservation, for each
VLAN service it will create a single TVM port.
6. If there is an unused TVM controller and card that satisfies the
requirements, it is automatically added to the reservation.
7. Deploy – This step creates the TVM-C, creates cards and ports under the
newly deployed TVM-C.
8. Use the TeraVM Controller to test the vDUT or vNUT. To run TVM traffic
tests, run the LoadTestGroup command from the TVM-C.
9. For Cleanup, on the controller resource, run the Remove command.
The remove command deletes the TeraVM VMs and resources from the
Resource Manager.
16
Use cases and scenarios
The TeraVM Solution Pack is designed to provide an environment suitable for testing
devices according to use cases and scenarios, as described in this section.
Scenario 1
A user can log on to CloudShell portal, select an environment and then perform the
following actions:
Specify the TVM MA
Specify TVM types
Specify the number of TVM cards and ports
Specify the Datastore to deploy on
Provision the TVM-C and TVM
When running the setup command it will deploy the Tera VM based on the number of
inputs specified in the number of TVM cards and ports to deploy.
An environment is provisioned in the reservation and the user can freely connect the
ports to VLAN services after being deployed.
Thereafter traffic tests can be run, based on the traffic profile.
Scenario 2
Users can perform the following:
Spin a TVM controller with x ports, where x is the number VLAN services inside
the reservation
Connect TVM ports to virtual resources
Connect a TVM port through a virtual resource (using a virtual firewall) out to a
physical resource
Load a configuration profile onto the controller using an existing CloudShell
driver
Scenario 3
A user can create an environment with an abstract resource of a TVM controller, which
every time that the user reserves this environment, an unused controller is automatically
added.
If the user needs to add cards to the TVM-C (controller), he can add a TeraVM service
to an active reservation with a controller. The service deploys the TVM cards to the
existing controller.
17
Networks
A typical environment includes the networks described in the following table:
Network Description
Management network This network is used to access the TVM-C.
Communications network
This network is dedicated to TeraVM components and enables ease of use when scaling “Test Data as a Service”. This network may be hidden from the end user or pre-connected when creating the TVM since it will not be shared outside the TVM to TVM-C communications.
Target network This is required for the traffic that is generated. Each traffic generation module can have up to 8 virtual interfaces that are defined before instantiating.
18
Appendix A - Run the sample environment
In this appendix, the sample environment, drivers and services that are provided in the
solution pack are used to demonstrate how to deploy the resources, spin TeraVM up,
configure the TeraVM controller, connect to DUTs using VLANs with uplinks and
downlinks and prepare the environment to enable traffic tests to be run between
selected ports. After completing the traffic tests, spin TeraVM down and release the
resources so that they can be used by other environments.
Note: In CloudShell Resource Manager you must ensure that the Resource Family and
Models are setup to reflect the actual structure in your vCenter.
Running the TVM sample environment
The TeraVM environment is provided as an example to enable you to deploy the
resources, spin the TeraVM up, configure the TeraVM controller, connect to DUTs using
VLANs with uplinks and downlinks and run traffic tests between selected ports. After
completing the traffic tests, spin the TeraVM down.
To run the sample environment:
1. Login to CloudShell Portal.
2. In the TeraVM Sample Environment, click Reserve.
3. Remove the services that are not required for your reservation. In this
example, the TeraVM Advanced service is used.
19
4. Hover the cursor over the service and click Edit .
The attributes in the TeraVM Advanced service are described in the
following table. Specify the attributes, as required.
Attribute Description
TVM MA Address IP address of the TVM MA
ESXI Host IP address of the ESXi host or cluster on which to deploy. If left blank, the driver picks the cluster or host name.
TVM Card Type Specify the card type: TVM_1 TVM_2
Ports per Card The number of ports that can be connected with each card. Note: Each card is deployed with the maximum number of ports (8). However, the connection is limited to the number specified by this attribute.
Datastore The datastore on which the TeraVM is deployed. If left blank, the TeraVM selects a datastore.
Temp Portgroup Specify the portgroup to which to assign the unused TeraVM ports. If no portgroup name is specified, the default portgroup
is used (QS_TVM_TMP_PORTGROUP). If you specify an existing portgroup name, that
portgroup is used. If you specify the name of a portgroup that does not yet
exist, the default portgroup is used.
20
5. Click Save.
6. The Setup command orchestrates the environment. The TVM MA and the
TVM Controller are configured. VLAN switches are connected and uplinks
and downlinks are established.
7. Using the commands in the TVM Controller, you can perform various
commands, such as start a test and commence the traffic input to the
DUT. At the conclusion of the traffic test, you can stop the test.
21
8. You can use the Command Input feature to modify the reservation, for
example, by specifying which TestGroup to load or stop.
Example to stop a specific Test Group
To stop a specific Test Group:
1. Click the Command Input .
2. In the Command Inputs pane, specify which test must be stopped.
22
3. (Optional) You can click Change to display additional inputs that can be
selected to be stopped.
4. Click Run .
23
Appendix B – Listing of imported attributes
This appendix provides a procedure to display the attributes, using CloudShell
Resource Manager and lists the attributes of the resources that are imported when the
TeraVM Solution Pack is imported into CloudShell Portal – see Importing, configuring
and modifying the solution pack.
Displaying the attributes in Resource Manager
To display the list of attributes that are imported with the solution pack:
1. In CloudShell Resource Manager, in the Resource Explorer, select Root.
2. Click Admin and then click Attributes .
The following image shows a portion of the Attributes window in Resource
Manager.
24
References
Additional technical documentation is available in the QualiSystems' Download Center.
For QualiSystem discussion forums, you can access the QualiSystems Customer
Portal.