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

.. _21.1|VOSS-669:


.. index:: tmux

.. note::

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

     * ``tmux`` - start a new session
     * ``tmux list-sessions`` - show sessions already available
     * ``tmux attach -t [session number]`` - reconnect to a disconnected session
        
     It is recommended that you use the ``tmux`` command to avoid failures if the
     connection is interrupted while running the command. If the connection is
     interrupted while running the command in ``tmux`` then the session can be
     retrieved by first listing the sessions PID currently running in ``tmux``: 
     ``tmux list-sessions``, and then reconnecting to the session using ``tmux attach -t [session number]``.



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

1. Download Automate install files and template 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 (2 unified nodes clustered)
   * Cluster (4 unified Nodes and 2 web proxies)
   * DR Cluster (6 unified nodes and 2 web proxies)
#. Define VMHost space on VM servers - see: :ref:`virtualization-platforms`.
#. Deploy the Automate files to VMs - see: :ref:`virtualization-platforms`.
#. Power on the VM.
#. Configure options in the installation wizard.
#. For the VMWare virtualization platform, install VMWare Tools from Automate CLI as platform user using the following command: ``app install vmware``
#. See the sections below for your chosen deployment model.


Single node cluster deployment
...............................

1. Initialize the database and clear all data:  ``voss cleardown``

   This step may take some time. Monitor progress using either of the following commands: 
   
   Run ``log follow upgrade_db.log`` or ``log follow voss-deviceapi/app.log``
#. (Optional) Set Automate network domain:  ``cluster run all network domain <yourdomain>``
#. Check application status:  ``cluster status``

   * If any services are down, use the following command on the affected node to restart all services on that
     node:  ``cluster run <node_ip> app start``

#. Run the following command: ``voss cleardown``
#. SFTP the install templates to the Automate server **media** directory.
#. Install Automate templates via VM console CLI. It is recommended that you run this step in a 
   terminal opened with the ``tmux`` command, or on the VM console:

   a. Run ``tmux``
   #. Run ``app template media/<VOSS Automate_Template_Name>``

   * At the prompt, choose your deployment type during the template install execution, either "Enterprise" or 
     "Provider".

     Depending on the selected deployment type, at the prompt, fill out and verify passwords: 

     * A top-level administrator password - fill out the password for "sysadmin"
     * One administrator password - depending on the deployment:

       * For Enterprise, fill out a password for "entadmin"
       * For Provider, fill out 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 VM console CLI. The designation of primary unified node
is arbitrary. The deploying administrator can pick any unified node they prefer. 

1. On each node that is not the designated primary unified node, prepare
   the servers for cluster command via the SSH CLI:  ``cluster prepnode``
 
#. Add all of the other nodes to the cluster:  ``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: ``cluster list``
#. (Optional) Set Automate network domain: ``cluster run all network domain <yourdomain>``
#. Set each unified node's database weight:  ``database weight <un-node_ip-address> <priority_weight>``

   * Run this command for all unified nodes primary and secondary.
   * For *two* unified node, priority weights of 40, 30 are recommended.
   * For *four* unified nodes, priority weights of 40, 30, 20, and 10 are recommended.
   * For *six* unified nodes, priority weights of 60, 50, 40, 30, 20, and 10 are recommended.
#. Provision the Automate cluster database. It is recommended that you run this step in a terminal 
   opened with the ``tmux`` command, or on the VM console.

   a. Run ``tmux``
   #. Run ``cluster provision``

#. Check cluster application status:  ``cluster status``

   * If any services are down, use the following command to restart all services on the affected node: 
     ``cluster run <node_ip> app start``

#. Run ``voss cleardown``
#. SFTP the install templates to the Automate server **media** directory of
   the primary unified node.
#. Install Automate templates via VM console CLI of primary unified
   node. It is recommended that you run this step in a terminal opened with the ``tmux`` command, or 
   on the VM console.

   a. Run ``tmux``
   #. Run ``app template media/<VOSS Automate_Template_Name>``

#. During the template install execution, choose the deployment type, either "Enterprise" or "Provider".

   At the prompt, depending on your selected deployment type, enter and verify passwords: 

   * A top-level administrator password - fill out the 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.




Post deployment
...............


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

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

#. Run the following security command: ``cluster check``

   Then inspect entries under **security**.

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

