Installing the server software on Ubuntu by using k3s

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:

Completed the tasks provided in the Prerequisites section. See Prerequisites for installing the server software on Ubuntu.
Set up the Kubernetes environment (k3s). See Setting up a Kubernetes environment (k3s) on Ubuntu.
Logged in to the server host system again after you completed the k3s environment setup.
Copied the INGRESS_DOMAIN value that is displayed on completion of the ubuntu-init.sh script.

About this task

HCL OneTest™ Server 10.2.2 provides you with the test authoring capability, which utilizes a containerized version of the HCL OneTest™ Studio desktop authoring tools.

Note: By design, the test authoring feature provides you with the capability to author tests that include writing code, executing code, and accessing the shell. The container in Kubernetes that is used by the test authoring or editing feature does not run as root and the container is not privileged. Hence, it results in providing some protection to the host and other workloads that run on the same node.

You must not install the test authoring feature in the following scenarios:

If you administer a network policy for your server installation.
If you do not intend to use the test authoring feature.

The default status of the test authoring feature is disabled when you install HCL OneTest™ Server on Ubuntu (by using k3s). If you want to use the test authoring feature in k3s, you must turn on the installing of the test authoring feature by adding the following helm parameter as part of step 2.d:

 --set global.hclOneTestAuthorEnabled=true

Procedure

Perform the following steps to install the server software:

Run the following command to get the latest updates from the repository:
```
helm repo update
```
Run the following command to retrieve the charts required to install the server software:
```
helm pull --untar hclsoftware/hcl-onetest-server --version 7.1022.0
```
Run the following command to provide the execution permission for the scripts that are available in the files directory:
```
chmod +x hcl-onetest-server/files/*.sh
```

Perform one of the steps described in the following table to install the server software based on your requirement:

Task description	Step number
To install the server software	Perform 2.d.i
To install the server software and enable the service virtualization through Istio, a Tech Preview feature	Perform 2.d.ii and 2.d.iv
To install the server software, enable the service virtualization through Istio, a Tech Preview feature, and to use another instance of the Jaeger UI	Perform 2.d.iii and 2.d.iv
To install the server software and to use another instance of the Jaeger UI Note: You must perform this step only if you want to use another instance of Jaeger than the one you installed during the setting up of the Kubernetes k3s environment.	Perform 2.d.v

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.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.hclOneTestPasswordAutoGenSeed={password-seed} \
-f hcl-onetest-server/values-k3s-demo.yaml

Run the following command to install the server software, to enable Istio service virtualization, a Tech Preview feature, and to use another instance of Jaeger than the one you installed during the setting up of the 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.hclOneTestPasswordAutoGenSeed={password-seed} \
-f hcl-onetest-server/values-k3s-demo.yaml \
--set global.jaegerDashboard.externalURL={my-jaeger-dashboard-url} \
--set global.jaegerAgent.internalHostName=localhost

Run the following command to enable service virtualization through Istio, a Tech Preview feature in the specific namespace:
```
kubectl create rolebinding istio-virtualization-enabled -n bookinfo --clusterrole={my-ots}-execution-istio-test-system --serviceaccount=test-system:{my-ots}-execution
```
Where, {my-ots} is the name of the release that is provided during the installation of the server software.
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 use another instance of Jaeger than the one you installed during the setting up of the 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.hclOneTestPasswordAutoGenSeed={password-seed} \
--set global.jaegerDashboard.externalURL={my-jaeger-dashboard-url} \
--set global.jaegerAgent.internalHostName=localhost

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 alphanumeric characters that are in lowercase or - (hyphen). The release name must also 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 is displayed on completion of the ubuntu-init.sh script.
Optional: {cloud-license-server-id} with the ID of the License Server for the initial team space, if you want to set the license for the first time.

Important: When you want to upgrade the product from the previous version, you must configure the value of License Server ID from the Team Space License Configuration page 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 the backed-up 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 (10.1.0, 10.1.1, or 10.1.2):
1. 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}
2. 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
3. Run the following command to stop the cluster and HCL OneTest™ Server:
  k3s-killall.sh
4. Run the following script from the hcl-onetest-base directory to restore the backed-up data:
  sudo backup.sh restore -v ~/migration-pvc-links --release <backup-release>:<target-release> <backup-file-name>
  Note: You must replace the following variables with the actual value:
  - <backup-release> with the Helm release name of the server where the backup data is stored.
  - <target-release> with the Helm release name of the server where you want to restore the data.
  - <backup-file-name> with the name of the backed-up file that you saved.
5. Run the following command to restart Kubernetes and to start HCL OneTest™ Server:
  sudo systemctl start k3s
6. 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}
7. 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}
Optional: Perform the following steps to restore the backed-up user data from previous version (10.1.3 or later) to the latest version:
1. Run the following script from the hcl-onetest-base directory to create a directory that contains metadata related to the Persistent Volume Claims and their Persistent Volumes:
  sudo backup.sh create-pvc-links
2. Stop the Kubernetes cluster by running the k3s-killall.sh command.
3. Restore the backed-up user data by running the following commands:
```
sudo ./backup.sh restore [options] <backup-file-name>
```
  Note: You must replace <backup-file-name> with the name of the backed-up file that you saved.
  
  You can use the following parameters along with the restore command:
  - --namespace or -n: Use this parameter to restore a specific namespace from the backup file. If you do not mention the namespace, then volumes from all the namespaces in the backup file are restored. You can map one namespace to another namespace by using colon (:). The syntax is:
    --namespace <name of the namespace> [:<target-namespace>]
  - --release or -r: Use this parameter if the Helm release name of the server to which the backup is being restored is different than the Helm release name of the server where the backup was taken. The syntax is:
    --release <backup-release>:<target-release>
  - --volumes or -v: Use this parameter to specify the directory path of the Volumes. The syntax is:
    --volumes <path-of-the-directory>
  - -k or --confirm: Use this parameter to skip the confirmation step.
4. Restart the Kubernetes cluster by running the systemctl start k3s command to start HCL OneTest™ Server.
5. Run the following script from the hcl-onetest-server/files directory to create all the missing databases:
  migrate.sh create-missing-dbs {my-ots}
  Note: You can expect that the output of the command to contain a number of errors pertaining to objects that already exist. They do not indicate a problem with the execution of the script.
Run the following script from the hcl-onetest-server/files directory to verify and test the installed server software:
```
$ helm test {my-ots} -n test-system
```
where {my-ots} is the name of the release that was 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:

Instructions to access Keycloak to manage and authenticate users.
The user name can be keycloak and the password can be retrieved by running the following command:
```
kubectl get secret -n namespace onetest-keycloak-postgresql -o jsonpath="{.data.password}" | base64 --decode; echo 
```
where:
- onetest is a sub-domain name that you selected for the server.
- namespace is the name of the namespace that you created.
The URL to access the HCL OneTest™ Server UI.

What to do next

You can perform the following tasks:

Configure licenses for team spaces. See Configuring licenses for team spaces.
Configure the server software. See Configuration of the server software.