Knowledge Base

To Enter a Fixed IP Address for the Server

1. Open the Command Prompt as administrator.
2. Enter ipconfig/all.
   Your output will contain something like this:

   Wireless LAN adapter WiFi:
   Connection-specific DNS Suffix  . : home
   Description . . . . . . . . . . . : Intel(R) Wi-Fi 6 AX201 160MHz
   Physical Address. . . . . . . . . : 3X-58-X2-XX-04-XX
   DHCP Enabled. . . . . . . . . . . : Yes
   Autoconfiguration Enabled . . . . : Yes
   IPv6 Address. . . . . . . . . . . : 2b02:d454:143b:1:25c3:5386:1c67:ce78(Preferred)
   Temporary IPv6 Address. . . . . . : 2b02:d454:143b:1:4591:d862:4f1a:8d35(Preferred)
   Link-local IPv6 Address . . . . . : fa80::25b3:5386:1e67:ce78%16(Preferred)
   IPv4 Address. . . . . . . . . . . : 192.168.2.12(Preferred)
   Subnet Mask . . . . . . . . . . . : 255.255.255.0
   Default Gateway . . . . . . . . . : fa80::7b96:82bb:ce25:f4cc%16
                                       192.168.2.254
   DHCP Server . . . . . . . . . . . : 192.168.2.254
   DHCPv6 IAID . . . . . . . . . . . : 138172610
   DHCPv6 Client DUID. . . . . . . . : 00-01-00-01-26-61-44-29-X0-5X-XX-36-XX-98
   DNS Servers . . . . . . . . . . . : fa80::7d96:82ec:ff25:f4ba%16
                                       192.168.2.254
   NetBIOS over Tcpip. . . . . . . . : Enabled

3. Write down the IPv4 Address, Default Gateway, and DNS server addresses and close the Command Prompt.
4. Open the Control Panel and choose Network and Sharing Center > Change adapter settings.
5. Right-click the Ethernet connection and choose Properties.
6. Click Internet Protocol Version 4 (TCP/IPv4) and choose Properties.
7. Select Use the following IP address and enter the IP address, Subnet Mask, and Default Gateway. The IP address should be in the same IP range as the Default Gateway.
8. Select Use the following DNS server address and enter the DNS server address you wrote down in step 3 in the Preferred and Alternate DNS server address fields. If there are more than three DNS server addresses, click Advanced, open the DNS tab and enter the addresses there.

Firewall Settings

The firewall should allow traffic through the ports described in the table below. These ports are opened in Windows Firewall during the installation of NoldusHub on the server. If you have another firewall, consult its documentation for the procedure to open the ports.

• Server PC: Inbound and outbound traffic through TCP (private; public; domain)
• Participant PC: Outbound traffic through TCP (private; public; domain) with NLinx Agent version up to 1.9.4; Inbound and outbound traffic through TCP (private; public; domain); Inbound traffic through TCP (private; public; domain)

Introduction

This page contains the issues encountered during NoldusHub (remote) installation and the possible solutions.

Mirantis Container Runtime (MCR) Offline Installation

If the Mirantis Container Runtime cannot be installed when the SetupNoldusHub.bat batch file is called, try to use the Install-Mirantis.ps1 PowerShell script with offline installation.

Two steps are required:

Download the Files for Offline Installation

If the download is possible on the server machine, try it from a browser:

• For Mirantis Container Runtime 23.0.14:
  • https://repos.mirantis.com/win/static/stable/x86_64/docker-23.0.14.zip as Docker.zip
  • https://repos.mirantis.com/win/static/stable/x86_64/containerd-1.6.33.zip as Containerd.zip
• Make sure the files are renamed as expected for the installation (Docker.zip and Containerd.zip).

If the download is not possible on the server machine, try it on another computer using the PowerShell script:

• Run .\Install-Mirantis.ps1 -DownloadOnly in PowerShell. This command downloads Docker.zip and Containerd.zip.

Offline Installation Using the Downloaded Files

1. Copy the Install-Mirantis.ps1, Docker.zip, and Containerd.zip files into the same directory on the server machine.
2. Run the .\Install-Mirantis.ps1 -Offline command in PowerShell with admin rights.
3. If the installation is successful, reboot the server machine.

Proxy Server

This section will be updated based on the proxy server support implementation.

If the server is behind a proxy server, the Docker Engine needs a configuration step.

Docker Engine Configuration

Create a new C:\ProgramData\docker\config\daemon.json file with the following content:

{
  "proxies": {
    "http-proxy": "http://proxy_server_address:port",
    "https-proxy": "http://proxy_server_address:port",
    "no-proxy": "localhost,127.0.0.1"
  }
}

• Change the proxy_server_address and port accordingly. In some cases, only the IP address works.
• If the proxy server needs additional authentication, use https://username:password@proxy_server_address:port format for http and https protocols accordingly.
• Save the file and reboot the server machine. After rebooting, the Docker Engine should use the proxy server.

For Docker Engine testing, the docker run hello-world command can be applied.

Verifying the proxy server details (no authentication):

Invoke-WebRequest https://google.com -ProxyUseDefaultCredentials -Proxy http://proxy_server_address:port

Verifying the proxy server details (with authentication):

$pass = ConvertTo-SecureString "password" -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential -ArgumentList "domain\username", $pass
Invoke-WebRequest https://google.com -Proxy http://proxy_server_address:port -ProxyCredential $cred

NoldusHub API Container Configuration

This section will be updated based on the proxy server support implementation.

The NoldusHub API container needs to access the QLM server to check the license (qlmlicenses.noldus.com). This might not be possible directly from the container.

At the noldus-hub-api definition in the docker-compose-noldus-hub.yml file, the HTTPS_PROXY environment variable needs to be defined to allow the container proxy access:

• Use https://proxy_server_address:port format if no authentication is required.
• Use https://username:password@proxy_server_address:port format if authentication is required.
• Use domain%5Cusername format for user definition (%5C is for the \ sign) in case of a domain user.

Docker Login Fails

The docker login command implicitly runs at the beginning of UpdateNoldusHub.bat. It automatically connects to the /v1 endpoint.

In some cases, it tries to use the /v2 endpoint for negotiating the image download and gives an authentication required error response. In this case, run these commands one by one, then try to call UpdateNoldusHub.bat:

docker login --username noldususers --password %DOCKER_NOLDUSUSERS_PASSWORD%
docker login --username noldususers --password %DOCKER_NOLDUSUSERS_PASSWORD% https://index.docker.io/v1/
docker login --username noldususers --password %DOCKER_NOLDUSUSERS_PASSWORD% https://index.docker.io/v2/

Port List

For NoldusHub operation, some ports must be open on the server machine. The list is provided for the customer IT department. Earlier versions of NoldusHub do not support secure communication with plugins, so the list of open ports has changed:

• NoldusHub 1.4: Port 5672 must be open.
• NoldusHub 1.6: Port 5671 must be open.
• NoldusHub 1.7: Port 5671 must be open.

Source: NoldusHub 1.7 Installation Documentation, Noldus Information Technology