Administrator Guide

[Pages:108]Administrator Guide

Special notice

Before using this information and the product it supports, read the information in Notices on page 105.

Chapter 1. Administrator Guide

This guide describes how to install HCL OneTestTM Server software. After you install the software, you can perform administration tasks such as license configuration, user management, security, memory and disk usage management, back up and restore user data, and other tasks that a server administrator can perform. This guide is intended for administrators.

Installation of the server software

To get started with HCL OneTestTM Server, you must first install the server software. You can install HCL OneTestTM Server on the following platforms:

? Red Hat OpenShift ? Ubuntu Server (using k3s) ? Azure Kubernetes Service (AKS)

Installation task flows

Red Hat OpenShift Container platform You must perform the following tasks to install HCL OneTestTM Server:

1. Set up a Red Hat OpenShift Container Platform. 2. Install the Jaeger operator to trace test logs and Jaeger-based reports when you run tests. 3. Install the OpenShift Container Platform command-line interface (CLI) and the Helm software. 4. Install HCL OneTestTM Server.

Ubuntu server You must perform the following tasks to install HCL OneTestTM Server:

1. Set up an Ubuntu Server. 2. Install the OpenSSH server and the Helm software. 3. Set up the Kubernetes environment (k3s) by using the provided script. 4. Install HCL OneTestTM Server.

Azure Kuberenetes Service You must perform the following tasks to install HCL OneTestTM Server:

3

Administrator Guide

1. Create an Azure subscription and set up the AKS cluster. 2. Install the Helm software. 3. Install the kubectl and Azure command-line interface (CLI) software. 4. Install NGINX Ingress Controller. 5. Install HCL OneTestTM Server.

Installation of the server software on Ubuntu

You can find information about the tasks that you can perform to install HCL OneTestTM Server software on the Ubuntu platform.

Prerequisites for installing the server software on Ubuntu

You must complete certain tasks before you install HCL OneTestTM Server on the Ubuntu platform. The following sections describe each prerequisite in detail:

? Internet access on page4 ? Harbor repository credentials on page4 ? Ubuntu Server on page5 ? Backup of user data on page5 ? Mandatory software on page5 ? k3s environment on page5 ? Service virtualization through Istio on page6

Internet access

You must have access to the internet to install HCL OneTestTM Server.

Harbor repository credentials

? New customers: You must create a support ticket to get the credentials that are required to access the product binaries from the Harbor repository. For more information, refer to How to create an HCL Support case.

? Existing customers: You must use your existing Harbor repository credentials to access the product binaries.

4

Chapter 1. Administrator Guide

Ubuntu Server

You must install an Ubuntu Server and have a working Domain Name Server (DNS) that resolves the host name into a machine-readable IP address. For more information about hardware and software requirements, see System Requirements on page

.

Note: Depending on your testing workload, HCL OneTestTM Server might require more resources. You must use the entire disk space and set up Logical Volume Manager (LVM) by using the ext4 file system. If your organization requires application data to be stored in a separate partition, then you can create a mount point at /var/lib/rancher/k3s/storage/ with at least 128 GB capacity.

Backup of user data

If you want to upgrade the product from a previous version, then you must perform one of the following tasks based on the existing version of the server software:

? Back up the data from V10.0.2, Fix Pack 1 or earlier. See Backing up the user data from a previous release.

? Back up the data from V10.1.0 or later. See Backing up the server data on Ubuntu on page 46.

Note: You must select the existing version of HCL OneTestTM Server from the drop-down list to view the procedure for backing up and restoring the user data for your version because the instructions differ for different versions.

Mandatory software

You must install the following mandatory software:

? Helm V3.5.2. For more information, refer to the Helm documentation.

Note: The Helm command must be in one of the directories in your PATH environment variable. ? OpenSSH Server. For more information, refer to the Installation section in the OpenSSH Server documentation.

Note: If you use ssh to log in to the computer, then you can skip this step because OpenSSH is already installed on your computer.

k3s environment

You must set up the Kubernetes environment (k3s) along with other configurations such as firewall, Jaeger, and Prometheus server. See Setting up a Kubernetes environment (k3s) on Ubuntu on page 6.

5

Administrator Guide

Service virtualization through Istio

Disclaimer: This release contains access to the Istio virtualized services feature in HCL OneTestTM Server as a Tech Preview. The Tech Preview is intended for you to view the capabilities of virtualized services offered by HCL OneTestTM Server, and to provide your feedback to the product team. You are permitted to use the information only for evaluation purposes and not for use in a production environment. HCL provides the information without obligation of support and "as is" without warranty of any kind. To provide your feedback, you must perform the following tasks:

1. Sign up or Log in to the Ideas portal. 2. Click Add a new idea to provide your feedback on the Tech Preview features. 3. Select OneTest TechPreview Programs in the Choose a workspace for this idea field. 4. Provide all the necessary details, and then click Share Idea.

The default configuration does not enable service virtualization through Istio. To use the service virtualization feature, you must configure it appropriately. You can virtualize the bookinfo sample application. You must install this application in the Bookinfo namespace. For more information about the bookinfo application, refer to the Istio documentation. For more information about how to enable service virtualization through Istio, see Setting up a Kubernetes environment (k3s) on Ubuntu on page 6.

Setting up a Kubernetes environment (k3s) on Ubuntu

You must set up a Kubernetes environment (k3s) so that you can install the server software on an Ubuntu server. You can use the script that is provided with HCL OneTestTM Server to set up a Kubernetes environment (k3s).

You must have completed the following tasks:

? Installed the following software: OpenSSH server Helm

? Ensured that your computer has a Domain Name Server (DNS) resolvable host name to resolve the host name into a machine-readable IP address.

? Copied a Secret key from the Harbor repository.

As part of the Kubernetes environment (k3s) set up, you can install the following software:

6

Chapter 1. Administrator Guide

? Jaeger: By using this software, you can trace test logs and Jaeger-based reports when you run tests.

? Prometheus server: By using this software, you can monitor your system resources by using metrics data that are collected by a Prometheus server.

1. Log in to the Ubuntu server using an SSH session. 2. Add the software registry to Helm by running the following command:

helm repo add hclsoftware --username {okta-email-address} --password {harbor-cli-secret}

Note: 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. 3. Run the following command to get the latest updates from the repository:

helm repo update

4. Run the following commands to fetch the scripts that are used to install Kubernetes:

helm pull --untar hclsoftware/hcl-onetest-base --version 5.1020.0 chmod +x hcl-onetest-base/*.sh

5. Perform one of the steps described in the following table to install the k3s Kubernetes environment based on your requirement:

Step description

Step no

To install the Kubernetes environment (k3s)

Perform 5.a on page8

To install the Kubernetes environment (k3s) by overriding the default name

Perform 5.b on page8

To install the Kubernetes environment (k3s) and enable the service virtualiza Perform 5.c

tion through Istio, a Tech Preview feature

on page8

To install the Kubernetes environment (k3s) by overriding the default name and enable the service virtualization through Istio, a Tech Preview feature

Perform 5.d on page8

7

Administrator Guide

a. Run the following commands to install the Kubernetes with a default domain name that is either based on IP address or fully qualified hostname:

#Run the following commands if you are on Ubuntu 18.04 $ cd hcl-onetest-base $ sudo ./ubuntu-init.sh

#Run the following commands if you are on Ubuntu 20.04 $ cd hcl-onetest-base $ sudo HOME=$HOME ./ubuntu-init.sh

b. Run the following commands to install the Kubernetes environment (k3s) by overriding the default name:

$ cd hcl-onetest-base $ sudo INGRESS_DOMAIN={onetest.} HOME=$HOME ./ubuntu-init.sh

c. Run the following command to install the Kubernetes environment (k3s) and to enable the service virtualization through Istio, a Tech Preview feature:

#Run the following commands if you are on Ubuntu 18.04 $ cd hcl-onetest-base $ sudo ./ubuntu-init.sh --demo

#Run the following commands if you are on Ubuntu 20.04 $ cd hcl-onetest-base $ sudo HOME=$HOME ./ubuntu-init.sh --demo

d. Run the following command to install the Kubernetes environment (k3s) by overriding the default name and to enable the service virtualization through Istio, a Tech Preview feature:

$ cd hcl-onetest-base $ sudo INGRESS_DOMAIN={onetest.} HOME=$HOME ./ubuntu-init.sh --demo

where: ? {onetest.} is a sub-domain name that you specified for the server. For example, testenv. Note: The sub-domain must consist of lowercase alphanumeric characters, "-"(hyphen) or "."(period). Also, the value must start and end with an alphanumeric character. ? is the domain name of your organization. For example,

You can access the product through a web browser by using any of the following methods:

8

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download