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

Before you begin#

Before continuing, you should have followed the file installation according to the steps and preliminary requirements specified in: Platform install on a VM

Download Automate template media from:

https://voss.portalshape.com > Downloads > VOSS Automate > XXX > New Installation

Note

  • Template installation and upgrade takes approximately two hours. You can follow the progress on the GUI transaction list.

  • Before installing from release 24.2 onwards, ensure that an additional 70 GB 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.

It is recommended that you use the standard tmux command where indicated. See: Using the tmux command.

Install single-node cluster (cluster-of-one)#

For virtualization platform support, see: Supported virtualization and hypervisor platforms.

Note

VMWare only: 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

Step 1: Add nodes to the cluster#

Note

For Azure and AWS install installations only, first run: cluster provision

  • Initialize the database and clear all data: voss cleardown

    This step may take some time. Monitor progress using either of the following commands:

    Run either log follow upgrade_db.log or log follow voss-deviceapi/app.log

Step 2: Add network domain and check network#

  1. 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.

  2. 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.

  3. Create 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 Automate platform is deployed.

Step 3: Import templates#

  1. Copy the Automate template file to the node: scp <VOSS Automate_template_file> platform@<ip_address>:~/media

  2. Log in to the node and install the template.

    It is recommended that you run this step in a terminal opened with the tmux command.

    i. Run tmux 11. Run app template media/<VOSS Automate_template_file>

    View console message:

    Deploying the template-product for VOSS Automate <<RELEASE_VERSION>> ...

  3. At the prompt, select the product deployment type, either “Enterprise” or “Provider”.

    Note

    For information on the “Insights Netflow” deployment type when installing release 24.2, contact VOSS.

    Depending on the deployment type you selected, at the prompt, provide and verify passwords:

    • A top-level administrator password - provide a password for “sysadmin”

    • And one administrator password - depending on the deployment:

      • For Enterprise, enter a password for “entadmin”

      • For Provider, 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 product deployment type. View console message, based on the deployment type, either of the following:

      "Importing EnterpriseOverlay.json"

"Importing ProviderOverlay.json"

      Deployment-specific system artifacts are imported and a message displays:

      Deployment-specific Overlay artifacts successfully imported.

      • Python functions are deployed.

      • System artifacts are imported.

      • At the prompt, provide administrator passwords.

      The template install automatically restarts necessary applications. The installation propagates changes throughout the cluster.

  4. 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.

  5. Are there errors?

    • No. If there are no errors indicated, it is recommended 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 Automate platform is deployed.

    • Yes. If there are errors, the install script stops with a failure message listing the problem. Contact VOSS Support.

Step 4: (Optional) Install language templates#

This step is required only for installing language templates for languages other than English.

  1. Copy the language template file to the primary unified node: scp <language_template_file>  platform@<ip_address>:~/media

  2. Log in to the primary unified node and install the template: app template media/<language_template_file>

    For example, to install French: app template media/VOSS AutomateLanguagePack_fr-fr.template

Step 5: (Optional) Install Automate Phone-based Registration#

This step is optional and required only if the Automate Phone Based Registration Add-on is required. If required, follow the installation instructions in the Appendix of your Core Feature Guide: “Install the Phone Based Registration Web Service”

Step 6: device/cucm/HuntPilot#

  1. Run the following command: voss migrate_summary_attributes device/cucm/HuntPilot

Step 7: 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 through the GUI or CLI:

    • License through the GUI? Follow steps indicated in Product License Management in the Core Feature Guide.

    • License through the CLI? Follow steps indicated in Product Licensing in the Platform Guide.

Step 8: 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 following command on each unified node where the drive has been added:

drives add sde insights-voss-sync:database

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.