.. _installing-applications:

Installing Applications
-----------------------

.. _19.1.2|EKB-1809:
.. _20.1.1|EKB-4891:
.. _20.1.1|EKB-5610:
.. _21.1|EKB-8282:


In general, it is not necessary to install single applications on a running system.
Instead, the system is upgraded using **cluster upgrade** as described in the Upgrading Applications
section.

.. index:: app;app list

The system collects all visible application versions for display using **app list**.

A screen for the app list command from the command line interface::

   platform@cscluster1:~$ app list
   selfservice - selfservice install script
      latest version 1.5.0 (2015-11-23 17:28) is installed

   voss-deviceapi - voss-deviceapi install script
      latest version 1.5.0 (2015-11-23 17:26) is installed

   cluster - cluster management
      latest version 1.5.0 (2015-11-23 17:25) is installed

   template_runner - Template Runner
      not installed
      version available: 1.5.0 (2015-11-23 17:36)

   mongodb - no-sql database server
      latest version 1.5.0 (2015-11-23 17:24) is installed

   support - Diagnostic tools for tech support
      latest version 1.5.0 (2015-11-23 17:27) is installed

   snmp - snmp management client and server
      latest version 1.5.0 (2015-11-23 17:31) is installed

   nginx - lightweight web server
      latest version 1.5.0 (2015-11-23 17:24) is installed

   services - Platform core services
      latest version 1.5.0 (2015-11-23 17:26) is installed

   platform - Platform install/upgrade
      latest version 1.5.0 (2015-11-23 17:26) is installed

   nrs - NRS install script
      not installed
      version available: 1.2.0 (2015-11-23 17:36)

   security - Latest system security updates
      latest version 1.5.0 (2015-11-23 17:34) is installed

   vmware - VMware tools
      not installed
      version available: 1.5.0 (2015-11-23 17:24)


Each application will display a short description of the application, the version
installed, and whether other versions are available.

Additional applications can be downloaded using the instructions detailed under the System Control:Download section.

.. index:: app;app install

Single Application Installation
...............................

An application can be installed with **app install <application-name>[version:<version>] [delete-on-success <[yes|y]|[no|n]>]**

For example,

* **app install snmp**
* **app install platform version 0.8.1 2014-01-09 00:46**

For release 19.1.2 and later; when using the **app install** command to install
patch scripts that have been added to the ``media/`` directory,
the **delete-on-success** parameter and ``yes|no`` value can be added to remove or keep the
the patch file in the directory after successful installation.

Example: **app install media/patch.script delete-on-success yes**

By default, in other words without this parameter, the user is prompted whether to delete or keep the patch script:
::

  Do you want to remove patch after successful completion?

If the ``--force`` parameter is appended to the parameter, no prompt is shown. 

.. note::

   This script file removal using the ``delete-on-success`` parameter only applies to *patch installation*
   and not to the installation of delta bundles or other bundles.

The application will automatically start its processes on install.
In isolated rare cases, it may be necessary to manually provision the system afterward with **cluster provision** so that other applications are configured to work with the new application.  This is taken care of automatically during the upgrade process described below.

.. index:: app;app multi_install

Multiple Application Installation
.................................
   
More than one application can be installed by adding them as ``multi_install`` parameters:

A file ``media/<manifest_file>.manifest`` can be created to list the applications per line or space-separated,
in the install sequence.

The ``delete-on-success`` parameter is optional.

* If the applications are listed on the command line, the sequence of the application parameters
  in the command is the sequence  of the installation.
  
  **app multi_install [<manifest_file.manifest>|<app-name_1> <app-name_2> ... ] [delete-on-success <[yes|y]|[no|n]>]**
  
  .. note::
  
     * It is advisable to make a system backup prior to
       installation so that a backup restore can be carried out in the case of a failure. Contact VOSS
       support if needed.
     * If an application URI is specified as a parameter, it is downloaded.
     * If an application is already installed, it is skipped with a message.
     * If an application with more than one version is found in ``media/``, the latest version is installed.
     * If an application in the list fails to install, the installation is terminated. Refer to the install logs. 
     * If the ``delete-on-success`` parameter is ``yes``, the manifest file and application files
       are removed after successful installation.
   
* The applications and manifest file can also be bundled into a single archive with extension: ``.tar.gz``, ``.tar``.

  The command will then be of the format:

  **app multi_install <archive_file> [delete-on-success <[yes|y]|[no|n]>]**

  The archive is extracted to the ``media/<archive_basename>`` directory. 

  .. note::

     * If no manifest file is found, the installation exists with an error message
     * If a file in the manifest is not available, an error message for the entry is displayed.
     * The same considerations apply as noted with a multiple installation that lists the files on
       the command line.
     * If the ``delete-on-success`` parameter is ``yes``, the ``media/<archive_basename>`` directory
       is removed after successful installation.

  
.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM