Single-node cluster (cluster-of-one) Installation#

Before You Begin#

Before continuing, you should have followed the OVA installation according to the steps and preliminary requirements specified in: Create a New VM Using the Platform-Install OVA

Note

Template installation and upgrade takes approximately two hours. You can follow the progress on the GUI transaction list.
Before installing release 24.1, ensure that an additional 70GB disk has been made available for the Insights database.
See: Adding Hard Disk Space and VOSS Automate Hardware Specifications.
This disk is needed to assign to the insights-voss-sync:database mount point. See the final installation step below.

The standard screen command should be used where indicated. See: Using the screen command.

Procedure#

Install VMware tools:
1. Log in on the node as the platform user and run app install vmware.
2. Verify that vmware is running: app list.
Prepare the node to be added as a single-node cluster (“cluster-of-one”).

Run cluster prepnode.

Add the node to the cluster: cluster add <ip_addr>.

Verify the node is listed in the cluster: cluster list. Example:

platform@VOSS:~$ cluster list
Cluster has 1 nodes:
        application :  192.168.100.3
        webproxy :  192.168.100.3
        database :  192.168.100.3

Initialize the database and clear all data with the voss cleardown command.

Note that this step may take some time. You can follow the process by running log follow upgrade_db.log or log follow voss-deviceapi/app.log.
Add the network domain (optional if a domain name is needed).
1. Configure the domain: cluster run all network domain <domain_name>.
2. Verify the configured network domain: cluster run all network domain. The node shows the domain that you configured.
Check the network:
1. Run cluster check to verify the status of the cluster, network connectivity, disk status and NTP.
2. Verify the DNS configuration: cluster run all network dns. The node responds with the DNS server address.
As part of the rollback procedure, ensure that a suitable restore point is obtained prior to the start of the activity, as per the guidelines for the infrastructure on which the VOSS Automate platform is deployed.
Import the templates.
1. Copy the VOSS Automate template file to the node with the command:
  
  scp <VOSS Automate_template_file> platform@<ip_address>:~/media
2. Log in to the node and install the template. It is recommended that this step is run in a terminal opened with the screen command.
  1. Run screen.
  2. Run app template media/<VOSS Automate_template_file>
  - The console will display a message:
    Deploying the template-product for VOSS Automate <<RELEASE_VERSION>> ...
3. When prompted to select the product deployment type, provide and confirm the deployment type, either “Enterprise” or “Provider”.
  
  In accordance with the selected deployment type, you are prompted to enter and verify:
  - a top-level administrator password:
    
    Please enter a password for "sysadmin"
  - and one administrator password - depending on the deployment:
    - Enterprise : Please enter a password for "entadmin"
    - Provider : Please enter a password for "hcsadmin"
  Upon installation, the password length should be at least 8 characters.
  
  Deployment-specific artifacts are installed according to the selected type of product deployment. A message displays according to the selected deployment type - one of:
```
"Importing EnterpriseOverlay.json"


"Importing ProviderOverlay.json ..."
```
  Deployment specific system artifacts are imported and a message is displayed:
```
Deployment-specific Overlay artifacts successfully imported.
```
  1. Python functions are deployed
  2. System artifacts are imported.
  3. You are prompted to provide administrator passwords.
  The template install automatically restarts necessary applications. The installation propagates changes throughout the cluster.
Review the output from the app template commands and confirm that the install message appears:
```
Deployment summary of UPDATED template solution (i.e. current values after installation):
-----------------------------------------------------------------------------------------

Product: [PRODUCT]
Version: [UPDATED PRODUCT RELEASE]
Iteration-version: [UPDATED ITERATION]
Platform-version: [UPDATED PLATFORM VERSION]
```
You can also monitor the template installation from the Admin Portal transaction list.
- If there are no errors indicated, we recommend that you make a restore point.
  
  As part of the rollback procedure, ensure that a suitable restore point is obtained prior to the start of the activity, as per the guidelines for the infrastructure on which the VOSS Automate platform is deployed.
- If there was an error, the install script stops with a failure message listing the problem. Contact VOSS Support.
Check for needed security updates by running the security check command. If at least one update is required for any node, run the security update command.

After the security update is successful, reboot: run system reboot.

Since all services will be stopped, this takes some time.

If the node does not properly reboot but the console shows that all processes have terminated, you can manually reboot without any system corruption.
(Optional) Install language templates for languages other than English.
1. Copy the language template file to the primary Unified node with the command:
  
  scp <language_template_file> platform@<ip_address>:~/media
2. Log in to the primary Unified node and install the template with the command:
  
  app template media/<language_template_file>
  
  For example, to install French:
  
  app template media/VOSS AutomateLanguagePack_fr-fr.template
(Optional) If the VOSS Automate Phone Based Registration Add-on is required, follow the installation instructions in the Appendix of your Core Feature Guide:

“Install the Phone Based Registration Web Service”
Run the following command:

voss migrate_summary_attributes device/cucm/HuntPilot
License the installation:

From release 21.4 onwards, the deployment needs to be licensed. After installation, a 7-day grace period is available to license the product.
1. Obtain the required license token from VOSS.
2. License:
  1. To license through the GUI, follow steps indicated in Product License Management in the Core Feature Guide.
  2. To license through the CLI, follow steps indicated in Product Licensing in the Platform Guide.

Mount the Insights database drive

On the primary unified node, assign the insights-voss-sync:database mount point to the drive added for the Insights database prior to installation.

For example, if drives list shows the added disk as:

Unused disks:
sde

then run the command

drives add sde insights-voss-sync:database

on each unified node where the drive has been added.

Sample output (the message below can be ignored on release 24.1:

WARNING: Failed to connect to lvmetad. Falling back to device scanning.)

$ drives add sde insights-voss-sync:database
Configuration setting "devices/scan_lvs" unknown.
Configuration setting "devices/allow_mixed_block_sizes" unknown.
WARNING: Failed to connect to lvmetad. Falling back to device scanning.
71ad98e0-7622-49ad-9fg9-db04055e82bc
Application insights-voss-sync processes stopped.
Migrating data to new drive - this can take several minutes
Data migration complete - reassigning drive
Checking that /dev/sde1 is mounted
Checking that /dev/dm-0 is mounted
/opt/platform/apps/mongodb/dbroot
Checking that /dev/sdc1 is mounted
/backups

Application services:firewall processes stopped.
Reconfiguring applications...
Application insights-voss-sync processes started.

Single-node cluster (cluster-of-one) Installation

On this page

Single-node cluster (cluster-of-one) Installation#

Before You Begin#

Procedure#