Upgrading the server software on Azure Kubernetes Service

When you want to use the latest version of the server software on Azure Kubernetes Service (AKS), you must upgrade HCL OneTest™ Server from the previous version of the software.

Before you begin

You must have read and been familiar with additional Helm parameters. See Additional Helm parameters.
You must have completed the following tasks:
- Completed the tasks provided in the Prerequisites section. See Prerequisites for installing the server software on Azure Kubernetes Service.
- Uninstalled NGINX Ingress controller by using the following helm command:
```
helm uninstall ingress-nginx -n ingress-nginx
```
  For more information refer to the NGINX Ingress Controller documentation.
  Note: To install HCL OneTest™ Server 10.2.2 or earlier on AKS, you installed the NGINX as Ingress controller. From 10.2.3 the Ingress controller has been changed to Emissary-ingress. Therefore, you must uninstall the NGINX Ingress controller and install the Emissary-ingress, see Installing Emissary-ingress.
- Installed Emissary-ingress.
- Informed users that HCL OneTest™ Server is offline temporarily during the upgrade process.
- Completed all test executions that are running on the existing version of HCL OneTest™ Server.
- Stopped all stub executions that are running on the existing version of HCL OneTest™ Server.
- Canceled any scheduled test runs that have a future date or time.
- Logged in to the AKS cluster.
  
  Note: You can run the az login command to log in to AKS interactively.
- Subscribed to active Azure subscription.
  
  Note: You can run the az account set --subscription {subscription_name} command to set your active subscription.

Optional. You can back up the user data from the earlier version of the product. If the upgrade fails, then you can use that backup file to restore it to the latest version of the server software. See Backing up the server data on Azure Kubernetes Service.

Note: For more information about specific versions of software requirements, see System Requirements.

About this task

When you want to install the latest version of the server software in the same location that contained the 10.2.0 or later, then you can upgrade HCL OneTest™ Server by using the helm upgrade command.

The following table lists the variables that you must replace with the actual value in the command.

Variables	Description
{resource_group}	The name of the resource group that you created during the creation of the AKS cluster.
{azure_cluster}	The name of the Azure cluster that you created during the creation of the AKS cluster.
{azure_container_registry}	The name of the ACR that you created during the AKS setup.
{my-ingress-dns-name}	The Ingress name and DNS zone value that you provided during the setting up of the AKS cluster. For example, if the Ingress name and DNS zone value that you provided are `onetest`, `myorg.nonprod`, then `{my-ingress-dns-name}` value must be `onetest.myorg.nonprod`.
{my-ots}	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`.
{cloud-license-server-id}	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}	A value of your choice for the password. 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.
{ip_address}.nip.io	The IP address that is assigned to Emissary-ingress. You can run the following command to obtain the IP address of Emissary-ingress: `kubectl get ingress -A`

Remember: The test-system is the name of the namespace that you created during the installation of the server software. If you created a namespace by using a different value, then you must use that value in place of test-system in all the instances in this procedure.

Tip: You can run the following command to know the value of the variables that you used during the installation of the previous version of the server software:

helm get values {release_name} -n {namespace}

For example, if your name of the release is my-ots and the name of the namespace is testsystem, then you must run the command as follows:

helm get values my-ots -n testsystem

Procedure

Run the following commands to fetch the scripts that are used to install HCL OneTest™ Server:

PULL_ARGUMENTS="-g {resource_group}" \
bash hcl-onetest-server/files/move-images.sh {azure_container_registry}.azurecr.io/hcl-onetest hclcr.io/ot/hcl-onetest

You can query the registry by using the following command:

az acr repository list -n {azure_container_registry} -otsv
az acr manifest list-metadata -r {azure_container_registry} -n \
  $(az acr repository list -n {azure_container_registry} -otsv --query [0])

Run the following command to upgrade the server software:
Notes:
- If you enabled the autoscaler feature to use a new container only to run test assets and to open the test editor, then you must add -f hcl-onetest-server/values-dedicated-nodes.yaml in the following helm install command.
- To provide enhanced security to HCL OneTest™ Server, the Sign up link on the Login page of HCL OneTest™ Server is not visible when you install the server software.
  
  If you want to enable the Sign up link on the Login page, then you must add the --set keycloak.signup.enabled=true parameter in the following helm install command.
```
helm upgrade {my-ots} ./hcl-onetest-server -n test-system \
  --create-namespace \
  --set keycloak.signup.enabled=true \
  --set global.hclFlexnetURL=https://hclsoftware.compliance.flexnetoperations.com \
  --set global.hclFlexnetID={cloud-license-server-id} \
  --set global.hclOneTestPasswordAutoGenSeed={password-seed}
```
Run the following script from the hcl-onetest-server/files directory to verify and test the installed server software:
```
hcl-onetest-server/files/helm-test-diag.sh {my-ots} -n test-system
```

Results

On the successful upgrade of HCL OneTest™ Server, the output displays the following information:

Keycloak URL to manage and authenticate users.
A URL to access the HCL OneTest™ Server UI.

What to do next

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