parasoft/soavirt-server-helm repository overview

⁠Quick reference

Maintained by: Parasoft⁠

Where to get help: Parasoft Documentation⁠, Parasoft Forums⁠, or Parasoft Support and Technical Services⁠

⁠What is Parasoft SOAtest & Virtualize Server?

Parasoft SOAtest & Virtualize Server is a lightweight server that hosts service virtualization assets created in the Parasoft Virtualize desktop and Parasoft Continuous Testing Platform (CTP), as well as execute tests created in the Parasoft SOAtest desktop or CTP. The server architecture is designed to provide a smaller memory footprint for higher performance of individual servers, as well as to let organizations take advantage of standardized application deployment infrastructures for availability, clustering, and scalability.

⁠Prerequisites

1. Helm version 3+ installed.
2. Namespace for the SOAtest & Virtualize Server to run in. For example:

kubectl create namespace parasoft-sv-namespace

Note: The namespace name "parasoft-sv-namespace" is used throughout this documentation in command and resource examples. If you use a different name for your namespace, be sure to change any instances of "parasoft-sv-namespace" in those examples to your namespace name.

Warning: Once the SOAVirt server has been licensed, deleting the namespace or changing the release-name will invalidate machine-locked licenses, even if you recreate the same namespace.

1. Persistent Volume and Persistent Volume claim: Create a Persistent Volume that can be shared by multiple nodes. It should be provisioned with 300GB of space and must have the ReadWriteMany access mode. This space will be used for the workspace of the SOAVirt server and will store configuration settings as well as Virtual Assets.

Warning: The volume must have permissions for the Parasoft user to be able to read and write to the volume. For example, execute the command chown 1000:0 <shared_path>.

⁠How to use this Helm Chart

⁠Download the Parasoft SOAtest & Virtualize Server Helm Chart

Download the SOAtest & Virtualize Server chart archive and (optionally) unpack it in a local directory with command:

$ helm pull oci://registry-1.docker.io/parasoft/soavirt-server-helm --version TAG --untar

• --version TAG - Tag for the version of the Helm Chart to download
• --untar - Optional flag that unpacks the chart archive (.tgz) in a local directory called soavirt-server-helm

⁠Setting up a persistent volume

After unpacking the chart archive, you can edit the values.yaml to set the value of persistence.name to a name of the persistent volume claim. You will also find the pv.yaml and pvc.yaml templates in the chart archive. These templates are configured to use hostPath persistent volume types using values defined in the persistence section of the values.yaml. These values are not enabled by default, so the templates are not used to create any resources when installing SOAtest & Virtualize Server as is. In order to use these templates, the values in the persistence section of the values.yaml need to be manually enabled by uncommenting lines. Keep in mind that these templates are meant to show how to define custom persistent volumes and persistent volume claims. As such, these templates may be removed or modified to fit individual deployment needs.

⁠Licensing the Deployment

A license may be set by updating the config.yaml found in the soavirt-server-helm/templates directory. The config.yaml contains the configuration properties for the SOAtest & Virtualize Server. At the minimum, you much accept the Parasoft End User License Agreement (EULA)⁠ by changing the parasoft.eula.accepted value from false to true:

parasoft.eula.accepted: false

Other values can be changed if necessary. For example, if you are using a network license, update the following fields:

# === PRODUCT LICENSING ===
# Enables virtualize functionality
#virtualize.license.enabled: true
 
# Enables soatest functionality
#soatest.license.enabled: true
 
 
# === NETWORK LICENSE ===
# Enables network licensing for virtualize
#virtualize.license.use_network: true
 
# Specifies the type of network license for virtualize ['performance_server_edition', 'runtime_server_edition', 'custom_edition']
#virtualize.license.network.edition: custom_edition
 
# Specifies features for virtualize 'custom_edition' license
#virtualize.license.custom_edition_features: Service Enabled, Performance, Extension Pack, Validate, Message Packs, Extension Framework, Developer Sandbox 1000 Hits/Day, 10000 Hits/Day, 25000 Hits/Day, 50000 Hits/Day, 100000 Hits/Day, 500000 Hits/Day, 1 Million Hits/Day, Unlimited Hits/Day, 30 HPS, 100 HPS
 
# Enables network licensing for soatest
#soatest.license.use_network: true
 
# Specifies the type of network license for soatest ['server_edition', 'custom_edition']
#soatest.license.network.edition: custom_edition
 
# Specifies features for soatest 'custom_edition' license
#soatest.license.custom_edition_features: RuleWizard, Command Line, SOA, Web, Server API Enabled, Message Packs, Advanced Test Generation Desktop, Advanced Test Generation 5 Users, Advanced Test Generation 25 Users, Advanced Test Generation 100 Users, Requirements Traceability, API Security Testing, Extension Framework
 
 
# === LICENSE SERVER ===
# Enables using a specific license server
# If true, the license network properties below will be used to retrieve a license
# If false, the DTP server properties will be used to retrieve a license
#license.network.use.specified.server: false
 
# Specifies license server URL, e.g., https://host[:port][/context-path]
#license.network.url: https\://[License Server Host]\:8443
 
# Enables http authentication for the license server
#license.network.auth.enabled: false
 
# Specifies username for license server authentication
#license.network.user: [License Server Username]
 
# Specifies password for license server authentication
#license.network.password: [License Server Password]

⁠Install Parasoft SOAtest & Virtualize Server

Install SOAtest & Virtualize Server with command:

$ helm install RELEASE_NAME [ PACKAGED_CHART_PATH | UNPACKAGED_CHART_PATH ] --namespace NAMESPACE --create-namespace

• RELEASE_NAME - Name for the new release being installed
• PACKAGED_CHART_PATH - Path of the downloaded chart archive
• UNPACKAGED_CHART_PATH - Path of the soavirt-server-helm local directory unpacked from the downloaded chart archive
• --namespace NAMESPACE - Namespace for the new release being installed
• --create-namespace - Creates the namespace for the new release being installed if it does not exist already

⁠Uninstall Parasoft SOAtest & Virtualize Server

Uninstall SOAtest & Virtualize Server with command:

$ helm uninstall RELEASE_NAME

• RELEASE_NAME - Name for the release being uninstalled

⁠Advanced settings

⁠Using a Local License

To use a node-lock license, you will need to retrieve the machine ID from the deployed server in order to procure your license from Parasoft and update the config.yaml.

1. Open a shell to the running container:

kubectl exec --stdin --tty my-release-soavirt-server-0 -n parasoft-sv-namespace -- /bin/bash

1. Make a curl call to the SOAVirt REST API to retrieve the machine ID:

curl http://localhost:9080/soavirt/api/v6/status?fields=machineId

1. Note the machine ID in the response and provide it to your Parasoft representative, who will send you a license password.
2. Once you have received your license password, update the config.yaml found in the soavirt-server-helm/templates directory extracted earlier to accept a machine-locked license:

# === NODE-LOCK LICENSE ===
# Specifies password for virtualize local license
#virtualize.license.local.password: [Virtualize License Password]
# Specifies password for soatest local license
#soatest.license.local.password: [Soatest License Password]
# === NETWORK LICENSE ===
# Enables network licensing for virtualize
#virtualize.license.use_network: true
# Enables network licensing for soatest
#soatest.license.use_network: true

1. Reinstall the Helm chart for the changes to take effect.

helm uninstall my-release
helm install my-release soavirt-server-helm