EasyUC
4.9.49

Installation, updates & backup

Commissioning the appliance

Import the OVA, set network and time on the console, initialise K3s and open the Manager.

EasyUC · Version 4.9.49

In EasyUC: VM console → Administration → Manage K3s → Initialize K3s (first node)

What it is for

EasyUC is delivered as a virtual appliance (OVA). The VM runs Linux with a text menu. In this menu you set network and time and run Initialize K3s once. This creates the Kubernetes cluster (K3s) with storage, the management of the database, search and messaging services, and the EasyUC Manager.

Initialisation runs without internet access. The container images are already inside the appliance. You install the EasyUC application itself afterwards in the Manager, see the chapter "Installing EasyUC and selecting modules".

The current OVA EasyUC-Appliance-Manager-2.0.11-ESXi.ova contains EasyUC Manager 2.0.11 but no EasyUC application yet. Download the OVA in the customer portal under Downloads (see "Customer portal: access and downloads") and, after this chapter, install EasyUC 4.9.49 in the Manager via EasyUC-Update → Erstinstallation.

Prerequisites

  • VMware ESXi. The OVA is imported with "Create a VM from an OVF or OVA file"; you choose the port group during import.
  • The OVA creates the VM with 8 vCPU, 16 GB RAM and a 160 GB disk, preferably on SSD. Do not reduce these values. For clusters and larger installations, agree the sizing with EasyUC.
  • A fixed IP address, netmask, gateway and at least one DNS server.
  • An internal NTP time source that the VM reaches on UDP 123. Periodic time synchronisation of VMware Tools must be switched off.
  • Access to the VM console of the hypervisor. You log in with the console user of the appliance; you receive the credentials with the delivery.
  • The OVA file from the customer portal, checked by SHA-256 checksum after downloading (see "Customer portal: access and downloads").

Step by step: import the OVA and set the network

  1. Import the OVA in ESXi with "Create a VM from an OVF or OVA file", choose the port group and start the VM.
  2. Open the VM console and sign in with the console user. On first start, First boot setup appears with Configure interfaces, NTP Server and Later / continue. You find the same entries at any time in the Main menu under Administration.
  3. Choose Configure interfaces (in First boot setup or under Administration). Hostname, domain and DNS are in the same form.
  4. Select the network interface and then IP Configuration.
  5. Under Select IP configuration type, select Manual.
  6. Enter IP Address, Netmask, Default Gateway, DNS 1 and, if needed, DNS 2.
  7. Confirm the prompt "Do you confirm the IP configuration?".
  8. Check the result with Show IP Configuration and Ping test.

Step by step: set the time source

  1. In the Administration menu, select NTP Server.
  2. Read the status display (active sources, synchronisation state, VMware time synchronisation, state of K3s/etcd) and confirm.
  3. Enter your internal time source. Separate several sources with spaces or commas. Up to eight IPv4/IPv6 addresses or host names are allowed.
  4. Select Check sources. The menu queries each source read-only and does not set the clock while doing so.
  5. Activate the configuration when the menu reports "All activation gates passed."
  6. If the clock of an appliance that has not been initialised yet is off by more than 250 ms, the menu offers Authorize once. This exception exists only before K3s is initialised.

Step by step: initialise K3s and open the Manager

  1. Choose Administration → Manage K3s → Initialize K3s (first node). In First boot setup the entry is called Initialize K3s (first node of a new cluster).
  2. In the Install K3s dialog, check Node IP, Interface and Node Name and confirm.
  3. Wait for the message "K3s initialization completed!". It shows nodes and pods and the Manager sign-in: user admin and an initial password generated randomly for each appliance. The password appears in the next window and is also stored in a file readable only by root.
  4. Note the initial password in a safe place.
  5. Open https://<your-appliance>/manager in the browser. The Anmelden (sign-in) page appears with the subtitle Easy-UC Cluster Manager.
  6. Sign in with Benutzername (username) admin and the initial password and choose Anmelden.
  7. The Manager immediately asks for your own password ("Initialpasswort muss geändert werden."). Enter Aktuelles Passwort, Neues Passwort and Neues Passwort wiederholen and choose Passwort ändern. The console then deletes the password file.
  8. If required, set up Zwei-Faktor-Anmeldung in the same menu.
  9. Now install EasyUC, see "Installing EasyUC and selecting modules".

Step by step: change the IP address later (single node only)

  1. Set the new address under Administration → Configure interfaces.
  2. Select Administration → Manage K3s → Change K3s IP.
  3. Confirm the prompt "Reconfigure K3s for new IP address?". The menu creates an etcd backup, stops K3s, starts it with the new address and restores the cluster data from the backup.
  4. Wait for "K3s IP change completed" and adjust DNS records and the targets in CUCM to the new address.

Fields and options

Fields and options
Field / actionMeaning and use
Show IP Configuration / Show Routing tableShows addresses and routes of the VM.
Configure interfacesActivate or deactivate the network interface and set it by DHCP (Automatic (DHCP)) or statically (Manual).
NTP ServerInternal time sources for systemd-timesyncd. Public fallback time servers are disabled. Activation is only allowed with one node or exactly three nodes in the cluster.
Change passwordsChange the password of a console user (at least 5 characters).
Internet AccessDirect connection or HTTP Proxy with Proxy IP, Proxy Port and optional authentication.
Ping testCheck whether a host is reachable.
Increase disk sizeExtend the file system after the VM disk has been enlarged.
Manage K3sBefore initialisation: Initialize K3s (first node), Prepare this node for joining (further node of a cluster, paired via Knoten hinzufügen in the Manager) and Pairing status. Afterwards: K3s Status, Change K3s IP (single node only), Set EasyUC owner password, Cluster SSH key and Uninstall K3s.
Set EasyUC owner passwordSets a random 24-character password for the owner account of the admin interface and shows it once. EasyUC has no default password.
Uninstall K3sRemoves K3s with all cluster data. The image store of the appliance is kept.
Reboot machineRestarts the VM. K3s and EasyUC start automatically afterwards.

Check the result and troubleshoot

  • K3s Status shows the node in state Ready. Pods that are not running can be deleted there to restart them.
  • The Manager page Übersicht shows the Knoten card with the new node and its load.
  • "No valid IP address detected. Please configure the network interface first before installing K3s.": set up the interface first.
  • "K3s installed but not ready after 10 minutes.": check time, disk and network; the following window shows the last K3s log lines. Then open K3s Status again.
  • "EasyUC cluster is already initialized. Use 'Change K3s IP' if you need to reconfigure.": the appliance is already initialised.
  • "ACTIVATION BLOCKED. No service was restarted." in the NTP menu: a check has failed. The entry can be saved as a pending configuration; it does not become active by itself, not even after a restart.
  • "Multiple nodes detected in the cluster": changing the IP address through the menu is blocked in clusters with several nodes.

Related chapters