You can install HCL OneTest™ Server on the Ubuntu server that has a Kubernetes environment to run functional, integration,
and performance tests. HCL OneTest™ Server combines test data, test environments, and test runs and reports into a single, web-based
browser for testers and non-testers.
Before you begin
You must have performed the following tasks:
Procedure
-
Use an SSH session to log in to the Ubuntu server.
-
Run the following command to get the latest updates from the repository:
-
Create a Secret to pull images that are used by HCL OneTest™ Server by running the following command:
kubectl create secret docker-registry hclcr.io \
-n test-system \
--docker-server=hclcr.io \
--docker-username={okta-email-address} \
--docker-password={harbor-cli-secret} \
--docker-email=example@abc.com
Notes:
-
You must replace
{okta-email-address}
with the user name of the
Harbor repository and replace {harbor-cli-secret}
with the secret key that you copied from the Harbor
repository.
If the user name contains any special characters, such as $, you must
enclose it within single quotes.
-
You can replace example@abc.com
with the administrator
email address, if required.
-
Perform the following steps to install the server software:
-
Run the following command to get the latest updates from the
repository:
-
Run the following command to retrieve the charts required to install
the server software:
helm pull --untar hclsoftware/hcl-onetest-server --version 4.1013.0
-
Perform one of the steps described in the following table to install
the server software based on your requirement:
Step description |
Step no |
To install the server software
|
Go to step 4.c.i |
To install the server software and enable Istio service
virtualization, a Tech Preview feature
|
Go to 4.c.ii |
To install the server software and enable the Jaeger
UI
Note: You must perform this step only if you have not
enabled the Jaeger UI to be exposed during the setting
up of Kubernetes k3s environment.
|
Go to step 4.c.iii |
To install the server software and enable performance
test runs on the statuc agents
|
Perform 4.c.iv |
-
Run the following command to install the server software:
helm install {my-ots} ./hcl-onetest-server -n test-system \
-f hcl-onetest-server/values-k3s.yaml \
--set global.hclOneTestIngressDomain={my-ingress-dns-name} \
--set global.hclFlexnetURL=https://hclsoftware.compliance.flexnetoperations.com \
--set global.hclFlexnetID={cloud-license-server-id} \
--set global.hclImagePullSecret=hclcr.io \
--set global.hclOneTestPasswordAutoGenSeed={password-seed}
-
Run the following command to install the server software and
to enable Istio service virtualization, a Tech Preview
feature:
helm install {my-ots} ./hcl-onetest-server -n test-system \
-f hcl-onetest-server/values-k3s.yaml \
--set global.hclOneTestIngressDomain={my-ingress-dns-name} \
--set global.hclFlexnetURL=https://hclsoftware.compliance.flexnetoperations.com \
--set global.hclFlexnetID={cloud-license-server-id} \
--set global.hclImagePullSecret=hclcr.io \
--set global.hclOneTestPasswordAutoGenSeed={password-seed} \
-f hcl-onetest-server/values-k3s-demo.yaml
Important: You must run the following command to
enable service virtualization in the specific namespace
after the server installation is
complete:
kubectl create rolebinding istio-virtualization-enabled -n bookinfo --clusterrole={my-ots}-execution-istio-test-system --serviceaccount=test-system:{my-ots}-execution
Note: When you uninstall the chart, the manually created role
bindings are not deleted from the namespace. You can run the
following command to delete the role
bindings:
kubectl delete rolebinding istio-virtualization-enabled -n bookinfo
-
Run the following command to install the server software and
to enable the Jaeger UI, if you have not enabled the Jaeger
UI to be exposed during the setting up of Kubernetes k3s
environment:
helm install {my-ots} ./hcl-onetest-server -n test-system \
-f hcl-onetest-server/values-k3s.yaml \
--set global.hclOneTestIngressDomain={my-ingress-dns-name} \
--set global.hclFlexnetURL=https://hclsoftware.compliance.flexnetoperations.com \
--set global.hclFlexnetID={cloud-license-server-id} \
--set global.hclImagePullSecret=hclcr.io \
--set global.hclOneTestPasswordAutoGenSeed={password-seed} \
--set global.jaegerDashboard.externalURL={my-jaeger-dashboard-url} \
--set global.jaegerAgent.internalHostName=localhost
-
Run the following command to install the server software and
to enable performance test runs on the static agents:
helm install {my-ots} ./hcl-onetest-server -n test-system \
-f hcl-onetest-server/values-k3s.yaml \
--set global.hclOneTestIngressDomain={my-ingress-dns-name} \
--set global.hclFlexnetURL=https://hclsoftware.compliance.flexnetoperations.com \
--set global.hclFlexnetID={cloud-license-server-id} \
--set global.hclImagePullSecret=hclcr.io \
--set global.hclOneTestPasswordAutoGenSeed={password-seed} \
--set networkPolicy.enabled=false
You must substitute the value of the following variables with the
actual value in the command:
-
{my-ots}
with the release name of your
choice.
Note: The release name must consist of lower case
alphanumeric characters or -
(hyphen), start with an
alphabetic character, and end with an alphanumeric character. For
example, my-org or
abc-123.
-
{my-ingress-dns-name}
with the INGRESS_DOMAIN value that
displayed on completion of the ubuntu-init.sh
script.
-
Optional: {cloud-license-server-id}
with the ID
of the license server, if you are setting the license value for the
first time.
Important: If you are upgrading the product from the previous
version, you must configure the OneTest License Server
ID value from the License
Configuration window when the installation of the server
is complete.
-
{password-seed}
with a value of your choice.
Important: This password seed is used to create several default
passwords for the server. You must store the password seed securely.
When you install the server software by using the backup of the user
data, you can reuse the password seed. You can use this seed to restore
backup files either on the current or later versions of the server
software.
-
{my-jaeger-dashboard-url}
with the URL
of the Jaeger server.
- Optional:
Run the following command to remove a job that is used to initialize the
PostgresQL database during the installation of the server software:
kubectl delete job {my-ots}-postgresql-init -n test-system
- Optional:
Perform the following steps to migrate data into HCL OneTest™ Server, if you upgraded the server software from the previous version:
-
Run the following script from the hcl-onetest-server/files directory to create a directory
that contains metadata related to the Persistent Volume Claims and their
Persistent Volumes:
migrate.sh create-pvcs -n test-system {my-ots}
-
Run the following script from the hcl-onetest-base directory to
back up the data:
sudo backup.sh create-pvc-links -v
~/migration-pvc-links
-
Run the following command to stop the cluster and HCL OneTest™ Server:
k3s-killall.sh
-
Run the following script from the hcl-onetest-base directory to
restore the backed-up data:
sudo backup.sh restore -v ~/migration-pvc-links
<backup-file-name> --release
Note: You must replace <backup-file-name>
with the name of the back up file that you saved.
-
Run the following command to restart Kubernetes and to start HCL OneTest™ Server:
sudo systemctl start k3s
-
Run the following script from the hcl-onetest-server/files directory to merge the data
into the server:
migrate.sh merge-dbs -n test-system {my-ots}
-
Run the following command to remove the resources that were created
during the migration process:
migrate.sh delete-temp-resources -n test-system {my-ots}
-
Run the following command to verify and test the installed server
software:
$ helm test {my-ots} -n test-system
where {my-ots}
is the release name that you provided
during the installation of the server software.
Results
On completion of the installation of server software, the output displays the
following information on the command-line interface:
What to do next
You can do the following tasks: