doc.overops.com

Install Analysis Server using Deb Installer

Installation with Deb

OverOps provides a Deb installer for the Analysis Server, Collector and Java Micro-Agent.

Root Permissions Required

Installing with Deb requires root permissions (sudo) - without these user permissions, you won't be able to use the Deb installer.

Step 1: Verify the Required Resources

Before running the installation with the Deb installer, verify that your system has the required resources in place.

Supported Operating System

The Deb Installer works with Debian and Ubuntu Linux operating systems. For RedHat and Centos systems, see Install Analysis Server Using the RPM Installer.

Step 2: Create a Provisioning File

  1. When installing the server with Deb, you'll first need to create a provisioning file that contains the available variables.
    If this file doesn't exist, you'll receive a warning notification, and the installation will be performed using the default values instead.
  2. Depending on the operating system you're using, the path of the file will be: Ubuntu, Debian - /etc/default/takipi-server
  3. You can also change this path using the TAKIPI_INSTALL_CONFIG_FILE environment variable. This variable lets you change the location where OverOps should look for the provisioning file.

Here's an example of a provisioning file that contains all the available variables (note that all the variables of the file can be found in the --help file, which is documented in Command Line Arguments for On-Premises Servers.

scripts/onprem/jaqen/src/assets/fpm/provisioning-file.example 

#############################
# EXAMPLE PROVISIONING FILE #
#############################
# Should point to the takipi server address or a load balancer address.
#
export TAKIPI_HOST_URL=http://john:8080
# Or leave empty to use an embedded H2 database
# If no host URL is provided the default will be 127.0.0.1
#
export TAKIPI_DB_TYPE=
export TAKIPI_DB_URL=
export TAKIPI_DB_USERNAME=
export TAKIPI_DB_PASSWORD=
# Or leave empty to use the /opt/takipi-server owner instead
#
export TAKIPI_USER_NAME=
export TAKIPI_USER_GROUP=
# Or leave empty to use the default directories under /opt/takipi-server
#
export TAKIPI_STORAGE_FOLDER=
export TAKIPI_LOG_FOLDER=
export TAKIPI_TEMP_FOLDER=
# Or leave empty to use the default port = 8080
#
export TAKIPI_SERVER_PORT=
# Tell the init system (systemd e.g.) to wait until a successful initialization
#
#	Note that this may slow the startup time, therefore use only when appropriate - the default is false
#
export TAKIPI_VALIDATE_SUCCESS=
# For cluster installation, put redis configuration here
#
#  Redis cluster type (SINGLE, CLUSTER, ELASTICACHE or MASTER_SLAVE)
#		Default to SINGLE
#
#  Redis nodes may be separated by semicolon (;)
#	export TAKIPI_REDIS_NODES=node1:port;node2:port
#
export TAKIPI_REDIS_NODES=
export TAKIPI_REDIS_TYPE=

User and Group Parameters

The following parameters let you install run the server installation as a user/group.

Parameter
Description
Comments

TAKIPI_USER_NAME

Lets you install and run the server with a user.

When installing with a user with root permissions (sudo) but the actual owner could be another user - this parameter doesn't limit the install and server running to the user who does the installation.

TAKIPI_USER_GROUP

Run the server as group.

This is the same as for the user, but usually the parameters will be a combination of user + group (often the same name) - see example below.

Using the user/group parameters affects the permissions of files under /opt/takipi-server, since the
Systemd Linux Service Manager daemon runs the process with this user/group.

Installing the Server with Deb

  1. Verify that you have a provisioning file like the one above. The default location for this file is: /etc/default/takipi-server.
  2. Get the download link from OverOps, and then download the rpm file using the following command:
    wget <filename>
  3. Run sudo dpkg -i takipi-server.deb to install.
  4. Run sudo systemctl status takipi-server to verify that the daemon is running.

Important

When Deb is uninstalled, the system doesn't remove files that were created after the installation phase by default. This includes files such as configuration files, logging files, storage files, temp files, etc.

Installation configuration and work data are kept and can be used for re-installation/upgrade if needed, or manually deleted after the removal of the package.

Debian Software Package (Ubuntu/Debian)

To install OverOps Collector on Ubuntu/Debian:

  1. Add OverOps to your deb repository:
    sudo sh -c "echo 'deb [arch=amd64] http://takipi-deb-repo.s3.amazonaws.com stable main' >> /etc/apt/sources.list.d/takipi.list"
  2. Add the OverOps gpg public key:
    wget -O - http://takipi-deb-repo.s3.amazonaws.com/[email protected] | sudo apt-key add -
  3. Update apt-get:
    sudo apt-get update
  4. Install OverOps:
    sudo apt-get install takipi
  5. Enter your installation key as the <MyKey> argument:
    sudo /opt/takipi/etc/takipi-setup-package <MyKey>
  6. Optional: set up a proxy connection:
    /opt/takipi/etc/takipi-setup-proxy <MyProxyAddress> (e.g. http://user:[email protected]:8080/)
  7. Add the
    -agentlib:TakipiAgent
    Add the JVM argument to the Java processes to monitor and restart it.

Related Articles

Installing the Collector and Java Micro-Agent Using the Deb Software Package
Systemd Linux Service Manager

Updated 5 months ago

Install Analysis Server using Deb Installer


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.