Installation Quick Reference
----------------------------

.. _21.1|VOSS-669:

.. index:: screen

.. note::

   * These steps are described in depth in the VOSS Automate Install Guide.
   * The standard **screen** command
     should be used where indicated, and the `reconnect` parameter is available
     if needed:

     * **screen** - start a new session
     * **screen -ls** - show sessions already available
     * **screen -r [screen PID]** - reconnect to a disconnected session
        
     VOSS recommends to use the **screen** command to avoid failures if the
     connection is interrupted whilst running the command. If the connection is
     interrupted whilst running the command in ``screen`` then the session can be
     retrieved by first listing the sessions PID currently running in screen: 
     **screen -ls**, and then reconnecting to the session using **screen -r [screen PID]**.



General Steps
.............

1. Download VOSS Automate install and patch media from:

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

   where XXX is the release number.

#. Review sizing requirements and define the deployment model:
   
   * Single node cluster/cluster-of-one (Lab Only)
   * MicroCluster (Two Unified nodes clustered)
   * Cluster (4 Unified Nodes and 2 Web Proxies)
   * DR Cluster (6 Unified Nodes and 2 Web Proxies)
#. Define VMHost space on VMWare servers
#. Deploy the VOSS Automate OVA to VMHost(s)
#. After the VM is created, select the CD ROM configuration and verify the 
   **Connect at Power On** check box is enabled.
#. Power on the VM.
#. Configure the options in the installation wizard.
#. Install VMWare Tools from VOSS Automate CLI as platform user:
  
   command: **app install vmware**
#. Continue below to chosen deployment model.


Single Node Cluster Deployment
...............................

1. Prepare the node for cluster command via the SSH CLI:
  
   command: **cluster prepnode**
 
#. Add the node to the cluster: 
   
   command: **cluster add <node_ip-address>**
   
#. Verify the node is a member of the cluster:
  
   command: **cluster list**
#. 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**.
#. (Optional) Set VOSS Automate Network Domain: 
   
   command: **cluster run all network domain <yourdomain>**
#. Check application status:  
   
   command: **cluster status**

   * Should any services be in a down state, restart all services on that
     affected node:  
     
     command: **cluster run <node_ip> app start**

#. Run the command: **voss cleardown**.
#. SFTP the install templates to the VOSS Automate server ``media`` directory
#. Install VOSS Automate Templates via VMWare Console CLI.
   VOSS recommends that this step is
   run in a terminal opened with the **screen** command, or on the VMWare console.

   a. Run **screen**.
   #. Run **app template media/<VOSS Automate_Template_Name>**.

   * A Deployment Type choice must be made during the template install execution.
     Choose one of:
     
     * Enterprise
     * Provider without HCM-F
     * Provider with HCM-F


     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.


Multi Node Deployment
.....................

All of the following commands will be run on the primary node via the SSH CLI
until specified to use ESX Console CLI. The designation of primary unified node
is arbitrary. The deploying administrator can pick any unified node that they
see fit.

1. On each node that is not the designated primary unified node. prepare
   the servers for cluster command via the SSH CLI:
  
   command: **cluster prepnode**
 
#. Add all of the other nodes to the cluster: 
   
   command: **cluster add <non-primary-node_ip-address>**
   
   Repeat this command for each other node - binding each individual node IP Address
   to the cluster. This command does not need to be run for the primary unified node.
#. Verify all nodes are members of the cluster:
  
   command: **cluster list**
#. (Optional) Set VOSS Automate Network Domain: 
   
   command: **cluster run all network domain <yourdomain>**
#. Set each unified node's database weight:
  
   command: **database weight <un-node_ip-address> <priority_weight>**

   * This command must be run for all unified nodes primary and secondary.
   * Priority weights of 40, 30 are recommended for *two* Unified nodes.
   * Priority weights of 40, 30, 20, and 10 are recommended for *four*
     Unified nodes
   * Priority weights of 60, 50, 40, 30, 20, and 10 are recommended for *six* Unified nodes.
#. Provision the VOSS Automate cluster database.
   VOSS recommends that this step is run in a terminal opened with the
   **screen** command, or on the VMWare console.

   a. Run **screen**.
   #. command: **cluster provision**

#. Check cluster application status:  
   
   command: **cluster status**

   * Should any services be in a down state, restart all services on that
     affected node:  
     
     command: **cluster run <node_ip> app start**

#. Run the command: **voss cleardown**.
#. SFTP the install templates to the VOSS Automate server ``media`` directory of
   the primary unified node.
#. Install VOSS Automate Templates via VMWare Console CLI of primary unified
   node. VOSS recommends that this
   step is run in a terminal opened with the **screen** command, or on the VMWare
   console.

   a. Run **screen**.
   #. Run **app template media/<VOSS Automate_Template_Name>**

#. A Deployment Type choice must be made during the template install execution.
   Choose one of:

   * Enterprise
   * Provider without HCM-F
   * Provider with HCM-F

   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.
     



Post Deployment
...............


1. Access the VOSS Automate web interface via any web browser:

   ``https://<ip_address_or_dns_name_of_VOSS Automate_PrimaryUN_or_WebProxy>``

#. Run the following security commands: 

   * **cluster check** - inspect entries under ``security``.
   * If needed, **security update**.
#. Run the following command:
   
   **voss migrate_summary_attributes device/cucm/HuntPilot**